meta-st-stm32mp/recipes-bsp/drivers/gcnano-driver-stm32mp
Romuald JEANNE 105bb0e41b README.HOW_TO.txt: add info in README.HOW_TO.txt
Update files to introduce starter package update instructions

Signed-off-by: Romuald JEANNE <romuald.jeanne@st.com>
Change-Id: I4a594dcd2e72fcf0e05e80599910071a71f8e7cc
2022-11-17 17:19:20 +01:00
..
README.HOW_TO.txt README.HOW_TO.txt: add info in README.HOW_TO.txt 2022-11-17 17:19:20 +01:00

README.HOW_TO.txt

Compilation of the gcnano kernel module:
1. Pre-requisite
2. Compile the gcnano kernel module
3. Update software on board
4. Update Starter Package with gcnano kernel module compilation outputs

----------------
1. Pre-requisite
----------------
 - OpenSTLinux SDK must be installed.
 - Linux Kernel source must be installed and built

----------------
2. Compile the gcnano kernel module
----------------
OpenSTLinux SDK must be installed.

* Compile and install the gcnano kernel module
    $> tar xf ##BP##-##PR##.tar.xz
    $> cd ##GCNANO_TARNAME##
    $> KERNEL_BUILDDIR="../../kernel/kernel-sources"
    * Build kernel module
    $> make ARCH=arm SOC_PLATFORM=st-st DEBUG=0 O="${KERNEL_BUILDDIR}" M="${PWD}" AQROOT="${PWD}" -C ${KERNEL_BUILDDIR}

---------------------------
3. Update software on board
---------------------------

3.1 Update via network
----------------------
    Copy kernel modules:
    $ scp galcore.ko root@<ip of board>:/lib/modules/<kernel version>/extra

    Generate a list of module dependencies (modules.dep) and a list of symbols
    provided by modules (modules.symbols):
    $ ssh root@<ip of board> /sbin/depmod -a
    Synchronize data on disk with memory
    $ ssh root@<ip of board> sync
    Reboot the board in order to take update into account
    $ ssh root@<ip of board> reboot

---------------------------
4. Update Starter Package with gcnano kernel module compilation outputs
---------------------------

<-- Section under construction -->

If not already done, extract the artifacts from Starter Package tarball, for example:
    # tar xf en.FLASH-stm32mp1-*.tar.xz

Move to Starter Package root folder,
    #> cd <your_starter_package_dir_path>
Cleanup Starter Package from original gcnano kernel module artifacts first
    #> echo "*** Section under construction ***"

<-- Section under construction -->