doc/directory_layout.md

   1 ## Directory Layout
   2
   3 ### General directory layout
   4 Each directory should be a self contained subsystem consisting
   5 of one or more modules.
   6
   7 * src/ - All source files for the subsystem.
   8 * include/ - All include files for the subsystem.
   9 * test/ - All unit tests for the subsystem.
  10
  11 ### Top level directory layout
  12 * audio_a2dp_hw - A2DP audio HAL implementation.
  13 * bta - *Bluetooth Application* - Strange collection of a-lot of things **Deprecate?**
  14 * btcore - *Bluetooth Core* - Bluetooth data type definitions and operations on those data types.
  15 * btif - *Bluetooth Interface* - JNI interface to Android.
  16 * conf - *Configuration* - Various configuration text files.
  17 * doc - *Documentation* - Stack documentation.
  18 * embdrv - **Deprecated** - Bluetooth SBC Codec.
  19 * hci - *Host Controller Interface* - Communication protocol with Bluetooth chip.
  20 * include - **Deprecated** - System global include files.
  21 * main - *Main stack entrypoint* - Provides HAL for stack access.
  22 * osi - *Operating System Interface* - General resource support for stack.
  23 * profiles - *Bluetooth Profiles* - **TBD** Collection of all profiles.
  24 * stack - **Deprecated** - The Stack - Push to proper spot in *./profiles*
  25 * test - *Test suite* - Stack level validiation and stress test suite.
  26 * tools - *Tools* - Various engineering support tools.
  27 * udrv -  **Deprecated**  *UIPC implementation*
  28 * utils - **Deprecated** *Bluetooth utilities* - Eliminate.
  29 * vnd - *Vendor* - Vendor specific APIs - *to be integrated into rest of stack ?*.