documentation: Update readme.txt
[processor-sdk/big-data-ipc-examples.git] / host_bios / simple_buffer_example / readme.txt
1 #
2 #  ======== readme.txt ========
3 #
5 BigdataIPC example
8 Program Logic:
9 --------------
11 Initially, the host sends first message with shared memory init information
12  followed by  2 more dummy messages to slave core ( all three messages sent in
13  sequence without waiting for reply).
14 Independantly, the slave processor receives messages and  sends back reply
15  back for each of the messages to the host.
16 Then the host receives one message from the slave and sends a message with
17  Big data buffer allocated from the Big data heap and filled with an
18  incrementing pattern. (This process is repeated with 10 Big data Buffer
19  messages). Each of these Messages are received by slave and the values
20  in the buffers are updated with a modified incrementing pattern
21  and sent back to the host.
23 Note the Slave and Host processors checks the expected incrementing
24  pattern for errors.
26 At this point only 7 Big data buffer messages would have been received.
27 Then the host sends two dummy messages plus one  shutdown message to the slave
28  core when receiving the remaining three Big data buffer messages.
29 The slave core on receiving the shutdown message, shuts itself down and
30  reinitializes itself for future runs.
32 Then the host receives back the remaining returned messages before shutting
33  down.
35 Build_procedure
36 ---------------
37 If you want to override the components or do a local build, then the product.mak
38 need to be modified to supply the path names of the different components.
39 or
40 The following commandline can be used to build the example
41 with the appropriate paths set:
43 PLATFORM=<platform_name> \
44 XDC_INSTALL_DIR="<xdc_install_dir>" \
45 BIOS_INSTALL_DIR="<bios_install_dir>" \
46 IPC_INSTALL_DIR="<ipc_install_dir>" \
47 PDK_INSTALL_DIR="<pdk_install_dir>" \
48 gnu.targets.arm.A15F="<A15_tools_dir>" \
49 ti.targets.elf.C66="<c66_tools_dir>"\
50 BOARD_NAME="<board_name>" \
51 make
53 The host binaries are expected to be at:
54 host/bin/<board_name>/release
55 DSP binaries are expected to be at:
56 dsp/bin/<platform_name>/release