Fix for x86_64 build fail
[platform/upstream/connectedhomeip.git] / src / platform / qpg6100 / README.md
1 # Overview of CHIP QPG6100 Adaption
2
3 The following is an overview of the Qorvo adaptation of CHIP. Most of this code
4 will have parallels in any new adaptation.
5
6 (All file names are relative to `connectedhomeip/src/platform/qpg6100...`).
7
8 `PlatformManagerImpl.h`<br>`PlatformManagerImpl.cpp`
9
10 -   Concrete implementation of PlatformManager interface
11 -   Provides initialization of the CHIP stack and core event loop for the chip
12     task
13 -   Relies on GenericPlatformManagerImpl_FreeRTOS<> class to provide most of the
14     implementation
15
16 `ConfigurationManagerImpl.h`<br>`ConfigurationManagerImpl.cpp`
17
18 -   Concrete implementation of ConfigurationManager interface
19 -   Manages storage and retrieval of persistent configuration data
20 -   Relies on GenericConfigurationManagerImpl<> classes to implement most API
21     functionality
22 -   Delegates low-level reading and writing of persistent values to NRF5Config
23     class
24
25 `ConnectivityManagerImpl.h`<br>`ConnectivityManagerImpl.cpp`
26
27 -   Concrete implementation of ConnectivityManager interface
28 -   Provides high-level APIs for managing device connectivity
29 -   Relies on GenericConnectivityManagerImpl_Thread<> class to provide most of
30     the implementation
31
32 `ThreadStackManagerImpl.h`<br>`ThreadStackManagerImpl.cpp`
33
34 -   Concrete implementation of ThreadStackManager interface
35 -   Supports Thread stack initialization and core event loop processing
36 -   Relies on GenericThreadStackManagerImpl_OpenThread/FreeRTOS/LwIP<> classes
37     to implement most API functionaltiy
38
39 `BLEManagerImpl.h`<br>`BLEManagerImpl.cpp`
40
41 -   Concrete implementation of the BLEManager interface
42 -   Maps CHIP's BLE interface abstractions (BleLayer, BlePlatformDelegate,
43     BleApplicationDelegate) onto the platform's native BLE services
44 -   Implements CHIP-compatible BLE advertising and GATT service using the
45     Softdevice BLE stack
46
47 `Entropy.cpp`
48
49 -   Implements interface to platform entropy source
50
51 `Logging.cpp`
52
53 -   Adaption of chip debug logging to platform logging facility