SHELDON INSTRUMENTS, INC.
Directory Structure for the SI development Kit.
May 2009.

The following tree describes the directory structure and associated code for the SI-DSP and SI-MOD cards; excludes QuX code for both the DSP and host levels. 
___________________________

sidev: All SI development code.
___________________________

  |-->binaries: All precompiled output files as compiled by development tools, incuding drivers, executables and DLLs, as well as DSP COFF files.
       |si_mpc: all binaries that run on the MPC8313 based SI-DSP cards.
            |-->local: All binaries that support the MPC8313 card running as a PCI agent inside a host PC.
                 |-->fpgaloader: utilities and all related support files for loading FPGA.
            |-->remote: All binaries that support the MPC8313 card running externally via the Ethernet/USB connections.
                 |-->flash_images: flash image files that are programmed onto the MPC8313's flash; consists of bootloader/bios (UBoot), OS (linux 2.6.27), DTB, and file system.
       |si_plx: all binaries that run on the PLX based SI-DSP cards.
            |-->drivers: kernel mode drivers for Windows.
            |-->fpgaloader: utilities and all related support files for loading FPGAs.
            |-->sihw_apps: All precompiled examples and related support files for accessing all SI-DSP cards.
                 |-->c33: All precompiled examples and related support files for accessing the SI-C33DSP card.
                 |-->c6711: All precompiled examples and related support files for accessing the SI-C671xDSP card.
                      |-->rev1: Latest revision of support files for the SI-C671xDSP card.

___________________________

  |-->siddk: host code; for use with Visual Studio Development tools.
       |-->common_ddk: Common code to all host level demo apps (sample), applicable to both generic and SI hardware. Applies to errors and board types.

       |-->common_sihw: Common code to all host level demo apps (sisample) for SI-DSP hardware only. Applies to COFF parsing and realted COFF options codes.

       |-->si_modules: Host level source code with APIs specific for all SI-MOD cards.
            |-->common: Host level code common to all SI-MOD expansion hardware.
            |-->mod64: Host level source code for SI-MOD64xx expansion modules only.
            |-->mod68: Host level source code for SI-MOD68xx expansion modules only.

       |-->siddk_mpc83: Source code and related projects for generating demo/apps for MPC8313 based boards.  Apps support SI-MPC-DSP operating internally as a PCI agent (MPC acts as a PCI bridge inside a host PC, with onchip PowerPC dormant), and externally via a high speed Ethernet/USB connection (MPC's onchip PowerPC runs embedded Linux).
            |-->apps: Local (inside a Host) and remote (external via Ethernet/USB) source code/projects for demos and apps for all MPC8313 based boards.
                 |-->fpgaload_mpc83: Source and related projects for generating the MPC_FPGALOAD utility, applies to both the card operating as a PCI agent inside a local host, and remotely with PowerPC.
                      |-->linux: Linux project files for generating the MPC_FPGALOAD utility, applies to both local host and remote PowerPC.
                      |-->win: Windows project files for generating the MPC_FPGALOAD.EXE utility, only applies to card operating as PCI agent inside a local host.
                 |-->sisample: Source and related projects for generating the MPC8313 based SISAMPLE utility.
                      |-->linux: Linux project files for generating the SISAMPLE utility, only applies to card operating as PCI agent inside a local host.
                      |-->win: Windows project files for generating the SISAMPLE.EXE utility, only applies to card operating as PCI agent inside a local host.
                 |-->sisamplib: Source and related projects for generating the MPC8313 based SISAMPLIB shared/dynamic link library.
                      |-->linux: Linux project files for generating the SISAMPLIB shared object, only applies to card operating as PCI agent inside a local host.
                      |-->win: Windows project files for generating the SISAMPLIB.DLL dynamic link library, only applies to card operating as PCI agent inside a local host.
                 |-->sisampnet: Source and related projects for generating binaries that run when the MPC8313 is operating externally via a high speed Ethernet/USB connection where the MPC8313's onchip PowerPC runs embedded Linux.
                      |-->siclient: Source and related projects for generating the SICLIENT utility that runs on the host PC that operates as a TCP/IP client to the remote MPC8313.
                           |-->linux: Linux project files for generating the SICLIENT utility that runs on the host PC operating as a client.
                           |-->win: Windows project files for generating the SICLIENT utility that runs on the host PC operating as a client.
                      |-->siclientlib: Source and related projects for generating the SICLIENTLIB shared/dynamic link library that runs on the host PC that operates as a TCP/IP client to the remote MPC8313.
                           |-->linux: Linux project files for generating the SICLIENTLIB shared object that runs on the host PC operating as a client.
                           |-->win: Windows project files for generating the SICLIENTLIB.DLL dynamic link library that runs on the host PC operating as a client.
                      |-->siserver: Source and related projects for generating the SISERVER utility that runs on the remote MPC8313's PowerPC.
                           |-->linux: Linux project files for generating the SICLIENTLIB shared object that runs on the host PC operating as a client.

            |-->common: Local/Remote level source code common for all MPC8313 based hardware.
            |-->docs: Documentation for SI-DDK-MPC on all OSes, limited to generic MPC83xx driver only.
            |-->drivers: All source code and related projects to MPC8313 based device drivers for all OSes, applicable to all MPC83xx based hardware.
                 |-->linux: Linux driver source code for the Local host as well as PowerPC running as an embedded device operating remotely.
                 |-->wdm: Win98/2000/XP driver source code
                 |-->wdf: WinXP/Vista driver source code
            |-->miscell: miscellaneous patches and source for Remote mode operation.


       |-->siddk_plx: Host level source code for generating demo/apps for all PLX based boards, generic and SI specific.

            |-->apps: Host level source code for demos and apps for all PLX based boards, generic to any PLX card and SI-DSP specific.
                 |-->plx: Host level source code for generating demo/apps for generic PLX based boards.
                      |-->sample: Compiler utility files for creating Windows generic SAMPLE.EXE command line executable.
                           |-->linux: compiler MAKEFILE files for creating Linux generic SAMPLE.EXE command line executable.
                      |-->samplib: Compiler utility files for creating Windows generic SAMPLIB.DLL shared/dynamic link library.
                           |-->linux: compiler MAKEFILE files for creating Linux  generic SAMPLIB.DLL shared/dynamic link library.
                      |-->testvis: LabVIEW library using SAMPLIB.DLL shared/dynamic link library.

                 |-->sihw_plx\rev1: Host level source code for generating demo/apps for SI hardware based on PLX device. Rev0 only available for legacy development, not intended for new applications.
                      |-->c33:
                           |-->common: Common source core used by all C33 demo/apps .
                           |-->miscell: Miscellaneous files, such as C33 PLX NVRAM contents and driver registry file.
                           |-->sisample: Windows project files for generating the C33 SISAMPLE.EXE command line executable.
                                |--> Linux compiler MAKEFILE files for generating the C33 SISAMPLE.EXE command line executable.
                           |-->sisamplib: Windows project and definition files for generating the C33 SISAMPLIB.DLL shared/dynamic link library.
                                |--> Linux compiler MAKEFILE files for generating the C33 SISAMPLIB.DLL shared/dynamic link library.
                           |-->sisampmod:
                                |-->sisampmod64: Windows project files for generating the C33+MOD64xx SISAMPMOD64.EXE command line executable.
                                     |-->linux: Linux compiler MAKEFILE files for generating the C33+MOD64xx SISAMPMOD64.EXE command line executable.
                                |-->sisampmod68: Windows project files for generating the C33+MOD68xx SISAMPMOD68.EXE command line executable.
                                     |-->linux: Linux compiler MAKEFILE files for generating the C33+MOD68xx SISAMPMOD68.EXE command line executable.
                           |-->testvis: LabVIEW library using SISAMPLIB shared library.
                      |-->c6711:
                           |-->common: Common source core used by all C671x demo/apps .
                           |-->miscell: Miscellaneous files, such as C671x PLX NVRAM contents and driver registry file.
                           |-->sisample: Windows project files for generating the C671x SISAMPLE.EXE command line executable.
                                |--> Linux compiler MAKEFILE files for generating the C671x SISAMPLE.EXE command line executable.
                           |-->sisamplib: Windows project and definition files for generating the C671x SISAMPLIB.DLL shared/dynamic link library.
                                |--> Linux compiler MAKEFILE files for generating the C671x SISAMPLIB.DLL shared/dynamic link library.
                           |-->sisampmod:
                                |-->sisampmod64: Windows project files for generating the C67+MOD64xx SISAMPMOD64.EXE command line executable.
                                     |-->linux: Linux compiler MAKEFILE files for generating the C67+MOD64xx SISAMPMOD64.EXE command line executable.
                                |-->sisampmod68: Windows project files for generating the C67+MOD68xx SISAMPMOD68.EXE command line executable.
                                     |-->linux: Linux compiler MAKEFILE files for generating the C67+MOD68xx SISAMPMOD68.EXE command line executable.
                           |-->testvis: LabVIEW library using SISAMPLIB shared library.

                      |-->common: Host level source code common to all SI-DSP hardware.
                      |-->fpgaload_plx: Host level source code for generating the PLX_FPGALOAD.EXE command line executable.
                           |-->linux: Linux compiler MAKEFILE files for generating the PLX_FPGALOAD.EXE command line executable.

            |-->common: Host level source code common for all PLX based hardware, generic and SI specific.
            |-->docs: Documentation for SI-DDK-PLX on all OSes, limited to generic PLX driver only.
            |-->drivers: All source code to PLX based device drivers for all OSes, applicable to all PLx based hardware.
                 |-->linux: Linux driver source code
                 |-->wdm: Win98/2000/XP driver source code
                 |-->wdf: WinXP/Vista driver source code
            |-->miscell: The PLX NVRAM contents with files in various formats, only applicable to generic PLX hardware.

___________________________

  |-->sidsp: DSP source code; for use with Code Composer Studio v3.x tools.
       |-->basiccom: Directories containing source code for basic DSP communications.
            |-->mpc83_c67x: DSP source code and project files for generating COFF files containing all communication modes for MPC8313 based C6713 SI-DSP cards.
                 |-->coff_x1: DSP source code and project files for generating a COFF file to be loaded in a single stage; host processor (Host PC or MPC8313) perform COFFLoads using the SP's HPI port.
            |-->plxc33: DSP source code and project files for generating COFF files containing all communication modes for PLX based C33 SI-DSP cards.
                 |-->c_proj: DSP source code presented as a C project for PLX based C33 SI-DSP cards.
                 |-->c_proj_jtag: DSP source code presented as a C project for PLX based C33 SI-DSP cards, including JTAG support.
            |-->plxc6711\rev1: Folders containing DSP source code and project files used for generating various COFF files containing all communication modes for PLX based C671x SI-DSP cards.
                 |-->coff_x1: DSP source code and project files for generating a COFF file to be loaded in a single stage; passive DSP communications are used to transfer an entire COFF image from host memory to DSP boot memory.
                 |-->coff_x2: DSP source code and project files for generating a COFF file to be loaded in two stages; passive DSP communications are used to transfer part of a COFF image from host memory to DSP boot memory, followed by active DSP communications to transfer the remaing COFF image residing in host memory to any location in DSP memory.
                 |-->coffjtag_x1: DSP source code and project files for generating a COFF file to be loaded in a single stage via the JTAG port.
                 |-->coffbios_x1: DSP source code and project files, using DSP Bios, for generating a COFF file to be loaded in a single stage; passive DSP communications are used to transfer an entire COFF image from host memory to DSP boot memory.
                 |-->coffbios_x2: DSP source code and project files, using DSP Bios, for generating a COFF file to be loaded in two stages; passive DSP communications are used to transfer part of a COFF image from host memory to DSP boot memory, followed by active DSP communications to transfer the remaing COFF image residing in host memory to any location in DSP memory.
                 |-->coffmod6x_x1: DSP source code and project files for generating a COFF file to be loaded in a single stage; passive DSP communications are used to transfer an entire COFF image from host memory to DSP boot memory. Also includes support for configuring the SI-MOD6x expansion module.

___________________________

