1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright 2020 Mellanox Technologies, Ltd 3 */ 4 5 #ifndef _RTE_ECPRI_H_ 6 #define _RTE_ECPRI_H_ 7 8 /** 9 * @file 10 * 11 * eCPRI headers definition. 12 * 13 * eCPRI (Common Public Radio Interface) is used in internal interfaces 14 * of radio base station in a 5G infrastructure. 15 */ 16 17 #include <stdint.h> 18 #include <rte_byteorder.h> 19 20 #ifdef __cplusplus 21 extern "C" { 22 #endif 23 24 /* 25 * eCPRI Protocol Revision 1.0, 1.1, 1.2, 2.0: 0001b 26 * Other values are reserved for future 27 */ 28 #define RTE_ECPRI_REV_UP_TO_20 1 29 30 /* 31 * eCPRI message types in specifications 32 * IWF* types will only be supported from rev.2 33 * 12-63: Reserved for future revision 34 * 64-255: Vendor Specific 35 */ 36 #define RTE_ECPRI_MSG_TYPE_IQ_DATA 0 37 #define RTE_ECPRI_MSG_TYPE_BIT_SEQ 1 38 #define RTE_ECPRI_MSG_TYPE_RTC_CTRL 2 39 #define RTE_ECPRI_MSG_TYPE_GEN_DATA 3 40 #define RTE_ECPRI_MSG_TYPE_RM_ACC 4 41 #define RTE_ECPRI_MSG_TYPE_DLY_MSR 5 42 #define RTE_ECPRI_MSG_TYPE_RMT_RST 6 43 #define RTE_ECPRI_MSG_TYPE_EVT_IND 7 44 #define RTE_ECPRI_MSG_TYPE_IWF_UP 8 45 #define RTE_ECPRI_MSG_TYPE_IWF_OPT 9 46 #define RTE_ECPRI_MSG_TYPE_IWF_MAP 10 47 #define RTE_ECPRI_MSG_TYPE_IWF_DCTRL 11 48 49 /* 50 * Event Type of Message Type #7: Event Indication 51 * 0x00: Fault(s) Indication 52 * 0x01: Fault(s) Indication Acknowledge 53 * 0x02: Notification(s) Indication 54 * 0x03: Synchronization Request 55 * 0x04: Synchronization Acknowledge 56 * 0x05: Synchronization End Indication 57 * 0x06...0xFF: Reserved 58 */ 59 #define RTE_ECPRI_EVT_IND_FAULT_IND 0x00 60 #define RTE_ECPRI_EVT_IND_FAULT_ACK 0x01 61 #define RTE_ECPRI_EVT_IND_NTFY_IND 0x02 62 #define RTE_ECPRI_EVT_IND_SYNC_REQ 0x03 63 #define RTE_ECPRI_EVT_IND_SYNC_ACK 0x04 64 #define RTE_ECPRI_EVT_IND_SYNC_END 0x05 65 66 /** 67 * eCPRI Common Header 68 */ 69 struct rte_ecpri_common_hdr { 70 union { 71 rte_be32_t u32; /**< 4B common header in BE */ 72 struct { 73 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN 74 uint32_t size:16; /**< Payload Size */ 75 uint32_t type:8; /**< Message Type */ 76 uint32_t c:1; /**< Concatenation Indicator */ 77 uint32_t res:3; /**< Reserved */ 78 uint32_t revision:4; /**< Protocol Revision */ 79 #elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN 80 uint32_t revision:4; /**< Protocol Revision */ 81 uint32_t res:3; /**< Reserved */ 82 uint32_t c:1; /**< Concatenation Indicator */ 83 uint32_t type:8; /**< Message Type */ 84 uint32_t size:16; /**< Payload Size */ 85 #endif 86 }; 87 }; 88 }; 89 90 /** 91 * eCPRI Message Header of Type #0: IQ Data 92 */ 93 struct rte_ecpri_msg_iq_data { 94 rte_be16_t pc_id; /**< Physical channel ID */ 95 rte_be16_t seq_id; /**< Sequence ID */ 96 }; 97 98 /** 99 * eCPRI Message Header of Type #1: Bit Sequence 100 */ 101 struct rte_ecpri_msg_bit_seq { 102 rte_be16_t pc_id; /**< Physical channel ID */ 103 rte_be16_t seq_id; /**< Sequence ID */ 104 }; 105 106 /** 107 * eCPRI Message Header of Type #2: Real-Time Control Data 108 */ 109 struct rte_ecpri_msg_rtc_ctrl { 110 rte_be16_t rtc_id; /**< Real-Time Control Data ID */ 111 rte_be16_t seq_id; /**< Sequence ID */ 112 }; 113 114 /** 115 * eCPRI Message Header of Type #3: Generic Data Transfer 116 */ 117 struct rte_ecpri_msg_gen_data { 118 rte_be32_t pc_id; /**< Physical channel ID */ 119 rte_be32_t seq_id; /**< Sequence ID */ 120 }; 121 122 /** 123 * eCPRI Message Header of Type #4: Remote Memory Access 124 */ 125 struct rte_ecpri_msg_rm_access { 126 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN 127 uint32_t ele_id:16; /**< Element ID */ 128 uint32_t rr:4; /**< Req/Resp */ 129 uint32_t rw:4; /**< Read/Write */ 130 uint32_t rma_id:8; /**< Remote Memory Access ID */ 131 #elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN 132 uint32_t rma_id:8; /**< Remote Memory Access ID */ 133 uint32_t rw:4; /**< Read/Write */ 134 uint32_t rr:4; /**< Req/Resp */ 135 uint32_t ele_id:16; /**< Element ID */ 136 #endif 137 uint8_t addr[6]; /**< 48-bits address */ 138 rte_be16_t length; /**< number of bytes */ 139 }; 140 141 /** 142 * eCPRI Message Header of Type #5: One-Way Delay Measurement 143 */ 144 struct rte_ecpri_msg_delay_measure { 145 uint8_t msr_id; /**< Measurement ID */ 146 uint8_t act_type; /**< Action Type */ 147 }; 148 149 /** 150 * eCPRI Message Header of Type #6: Remote Reset 151 */ 152 struct rte_ecpri_msg_remote_reset { 153 rte_be16_t rst_id; /**< Reset ID */ 154 uint8_t rst_op; /**< Reset Code Op */ 155 }; 156 157 /** 158 * eCPRI Message Header of Type #7: Event Indication 159 */ 160 struct rte_ecpri_msg_event_ind { 161 uint8_t evt_id; /**< Event ID */ 162 uint8_t evt_type; /**< Event Type */ 163 uint8_t seq; /**< Sequence Number */ 164 uint8_t number; /**< Number of Faults/Notif */ 165 }; 166 167 /** 168 * eCPRI Combined Message Header Format: Common Header + Message Types 169 */ 170 struct rte_ecpri_combined_msg_hdr { 171 struct rte_ecpri_common_hdr common; 172 union { 173 struct rte_ecpri_msg_iq_data type0; 174 struct rte_ecpri_msg_bit_seq type1; 175 struct rte_ecpri_msg_rtc_ctrl type2; 176 struct rte_ecpri_msg_gen_data type3; 177 struct rte_ecpri_msg_rm_access type4; 178 struct rte_ecpri_msg_delay_measure type5; 179 struct rte_ecpri_msg_remote_reset type6; 180 struct rte_ecpri_msg_event_ind type7; 181 rte_be32_t dummy[3]; 182 }; 183 }; 184 185 #ifdef __cplusplus 186 } 187 #endif 188 189 #endif /* _RTE_ECPRI_H_ */ 190