X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=2340191133c6ebc2acbbf90d5cb189133d45665f;hb=refs%2Fchanges%2F25%2F10025%2F5;hp=6ef573812b336e64b67a5d33e1576a9148eae997;hpb=ce136a8facf53778e327bead92b0cfe91b566571;p=o-du%2Fl2.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 6ef573812..234019113 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -26,9 +26,9 @@ O-DU High uses C languages. The coding guidelines followed are: .. figure:: LicHeader.jpg :width: 600 - :alt: Figure 8 License Header and Footer + :alt: Figure 16 License Header and Footer - Figure 8 : License Header and Footer + Figure 16 : License Header and Footer O-DU High code --------------- @@ -280,9 +280,9 @@ Here, .. figure:: ModeofCommunication.jpg :width: 600 - :alt: Figure 9 Mode of communication between O-DU High entities + :alt: Figure 17 Mode of communication between O-DU High entities - Figure 9: Mode of communication between O-DU High entities + Figure 17: Mode of communication between O-DU High entities Steps of Communication ++++++++++++++++++++++ @@ -344,9 +344,9 @@ Below figure summarized the above steps of intra O-DU High communication .. figure:: StepsOfCommunication.jpg :width: 600 - :alt: Figure 10 Communication between entities + :alt: Figure 18 Communication between entities - Figure 10: Steps of Communication between O-DU High entities + Figure 18: Steps of Communication between O-DU High entities Communication with Intel O-DU Low @@ -357,7 +357,7 @@ the following APIs for communication. 1. **WLS_Open** - *void\* WLS_Open(const char \*ifacename, unsigned int mode, unsigned long long nWlsMemorySize)* + *void\* WLS_Open(const char \*ifacename, unsigned int mode, uint64_t \*nWlsMacMemorySize, uint64_t \*nWlsPhyMemorySize)* a. Description @@ -368,6 +368,8 @@ the following APIs for communication. - ifacename - pointer to string with device driver name (/dev/wls) - mode - mode of operation (Master or Slave). Here, O-DU High acts as MASTER. + - nWlsMacMemorySize - returns the value of WLS MAC memory Size as O-DU High acts as MASTER + - nWlsPhyMemorySize - returns the value of WLS PHY memory Size as O-DU High acts as MASTER c. Returns pointer handle to WLS interface for future use by WLS functions @@ -763,7 +765,9 @@ O1 uses GNU C++ language. ODU - O1 Communication ^^^^^^^^^^^^^^^^^^^^^^ -O-DU High and O1 module communicate on a TCP socket. +O1 module runs as a thread in O-DU High. + +Alarm communication between the threads happen on a Unix socket. O-DU High sends alarm messages in the following structure using Alarm Interface APIs.