docs/MCU_based_host/directory_structure.md

   1 ### Directory structure for MCU based host
   2
   3 ```
   4 ├── host                          (host directory is common for MCU and MPU)
   5 │   ├── LICENSES
   6 │   │   ├── Apache-2.0
   7 │   │   └── GPL-2.0
   8 │   ├── components                (common utilities like queue etc)
   9 │   ├── control_lib               (Hosted control path library)
  10 │   ├── stm32
  11 │   │   ├── app                   (Contain Initialization sequence of STM32 firmware, control
  12 │   │   │   │                         and data path modules)
  13 │   │   │   ├── control           (Contain files for control path, used for Wi-Fi connectivity)
  14 │   │   │   └── data              (Contain files for demo APP, ARP server. The application
  15 │   │   │                             would need to be hooked here.)
  16 │   │   ├── common                (Contain common constructs used across app, driver)
  17 │   │   ├── driver                (Contain modules of networking, serial interface and SPI transport)
  18 │   │   │   ├── netif             (API for network device operation (netdev))
  19 │   │   │   ├── network           (Contain netdev API implementation and network stub. Network stub
  20 │   │   │   │                         should be replace by actual network stub like lwip by user)
  21 │   │   │   ├── serial            (Contain Virtual Serial Interface implemented over SPI transport)
  22 │   │   │   └── spi               (Contain driver for SPI transport)
  23 │   │   ├── proj                  (Contain windows 'batch'(.bat) file and sh scripts for project setup. Also contain
  24 │   │   │                             `.ioc` file which is HAL layer for STM32, used in project installation in STM32CubeIDE)
  25 │   │   └── port                  (Porting files for OS abstraction, contains wrappers
  26 │   │                                 for thread creation, semaphore operations, memory functions,
  27 │   │                                 serial driver operations etc)
  28 │   └── virtual_serial_if         (Virtual serial interface, platform agnostic layer,
  29 │                                     which provides abstraction to setup control path
  30 │                                     over serial driver)
  31 ```