src/cm/rgm.x

   1 /*******************************************************************************
   2 ################################################################################
   3 #   Copyright (c) [2017-2019] [Radisys]                                        #
   4 #                                                                              #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");            #
   6 #   you may not use this file except in compliance with the License.           #
   7 #   You may obtain a copy of the License at                                    #
   8 #                                                                              #
   9 #       http://www.apache.org/licenses/LICENSE-2.0                             #
  10 #                                                                              #
  11 #   Unless required by applicable law or agreed to in writing, software        #
  12 #   distributed under the License is distributed on an "AS IS" BASIS,          #
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
  14 #   See the License for the specific language governing permissions and        #
  15 #   limitations under the License.                                             #
  16 ################################################################################
  17 *******************************************************************************/
  18
  19 /**********************************************************************
  20      Name:    Upper Layer Interface
  21
  22      Type:    C header file
  23
  24      Desc:    Structures, variables and typedefs required by
  25               RGU interface
  26
  27      File:    rgu.x
  28
  29 *********************************************************************21*/
  30
  31 \f
  32 #ifndef __RGMX__
  33 #define __RGMX__
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /**
  39   @file rgu.x
  40   @brief Structure declarations and definitions for RGU interface.
  41  */
  42
  43 /***********************************************************************
  44                           typedefs and data structures
  45  ***********************************************************************/
  46
  47 #define RGM_PRB_REPORT_STOP     0
  48 #define RGM_PRB_REPORT_START    1
  49
  50 #define RGM_MAX_QCI_REPORTS     4
  51
  52 /* RRM_SP1_START */
  53 typedef struct rgmPrbRptPerQci
  54 {
  55    uint8_t       bQci;
  56    uint8_t       bAvgPrbUlUsage;
  57    uint8_t       bAvgPrbDlUsage;
  58 }RgmPrbRptPerQci;
  59
  60 typedef struct rgmPrbRprtInd
  61 {
  62    RgmPrbRptPerQci   stQciPrbRpts[RGM_MAX_QCI_REPORTS];
  63 /* RRM_SP1_END */
  64    uint8_t                bCellId;
  65    /* TDD: DL PRB Usage pres = 2 and
  66     *      UL PRB Usage pres = 1
  67     * FDD: DL and UL Usage Pres = 3
  68     */
  69    uint8_t                bPrbUsageMask;
  70 }RgmPrbRprtInd;
  71
  72 typedef enum
  73 {
  74    RGM_TXN_MODE1,
  75    RGM_TXN_MODE2,
  76    RGM_TXN_MODE3,
  77    RGM_TXN_MODE4,
  78    RGM_TXN_MODE5,
  79    RGM_TXN_MODE6,
  80    RGM_TXN_MODE7,
  81    RGM_TXN_MODE8
  82 } RgmTxnMode;
  83
  84 typedef struct rgmTransModeInd
  85 {
  86    RgmTxnMode       eMode;         /* Indicate TM Mode */
  87    uint16_t              usCrnti;       /* UE Crnti value     */
  88    uint8_t               bCellId;       /* Cell Id */
  89 }RgmTransModeInd;
  90 /***********************************************************************
  91           type definitions for upper layer interface - RLC primitives
  92  ***********************************************************************/
  93  /** @brief Data Indication from MAC to RLC to
  94   *  * forward the data received for common channels */
  95 typedef S16 (*RgmPrbRprtIndFptr) ARGS((
  96          Pst*                 pst,
  97          SuId                 suId,
  98          RgmPrbRprtInd  *    prbRprtInd));
  99 /** @brief Data Indication from MAC to RLC to
 100  * forward the data received for common channels */
 101 typedef S16 (*RgmTransModeIndFptr) ARGS((
 102    Pst*                 pst,
 103    SuId                 suId,
 104    RgmTransModeInd  *   transModeInd));
 105
 106 #ifdef RM_INTF
 107 /** @brief Data Indication from MAC to RRM to
 108  * change the transmission mode*/
 109 S16 RmLiRgmTransModeInd ARGS((
 110    Pst*                 pst,
 111    SuId                 suId,
 112    RgmTransModeInd*     transModeInd
 113 ));
 114 #endif
 115
 116 /** @brief Data Indication from MAC to RLC to
 117  *  * forward the data received for common channels*/
 118 S16 cmPkRgmPrbRprtInd ARGS((
 119          Pst*                 pst,
 120          SuId                 suId,
 121          RgmPrbRprtInd  *    prbRprtInd
 122          ));
 123
 124
 125 S16 cmUnpkPrbRprtInd ARGS((
 126          RgmPrbRprtInd  * prbRprtInd,
 127          Buffer *mBuf
 128          ));
 129
 130 S16 cmPkTransModeInd ARGS((
 131 RgmTransModeInd *transModeInd,
 132 Buffer *mBuf
 133 ));
 134
 135 S16 cmUnpkTransModeInd ARGS((
 136 RgmTransModeInd *transModeInd,
 137 Buffer *mBuf
 138 ));
 139 S16 cmPkRgmTransModeInd ARGS((
 140    Pst*                 pst,
 141    SuId                 suId,
 142    RgmTransModeInd *transModeInd
 143 ));
 144
 145
 146 S16 cmUnpkRgmTransModeInd ARGS((
 147          RgmTransModeIndFptr    func,
 148          Pst*                 pst,
 149          Buffer               *mBuf
 150          ));
 151
 152 /** @brief Data Indication from MAC to RLC to
 153  * forward the data received for common channels*/
 154 S16 cmUnpkRgmPrbRprtInd ARGS((
 155    RgmPrbRprtIndFptr    func,
 156    Pst*                 pst,
 157    Buffer               *mBuf
 158 ));
 159
 160 S16 cmPkRgmPrbQciRpt ARGS((
 161 RgmPrbRptPerQci *qciPrbRprt,
 162 Buffer *mBuf
 163 ));
 164
 165 S16 cmUnpkRgmPrbQciRpt ARGS((
 166 RgmPrbRptPerQci *qciPrbRprt,
 167 Buffer *mBuf
 168 ));
 169
 170 #ifdef __cplusplus
 171 }
 172 #endif
 173 #endif /* __RGUX__ */
 174
 175 /********************************************************************30**
 176
 177          End of file
 178 **********************************************************************/