-/******************************************************************************
-*
-* Copyright (c) 2019 Intel.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*******************************************************************************/
-
-/**
- * @brief Definitions and support functions to process XRAN packet
- * @file xran_pkt.h
- * @ingroup group_source_xran
- * @author Intel Corporation
- **/
-
-/* ORAN-WG4.CUS.0-v01.00 O-RAN Fronthaul Working Group
- Control, User and Synchronization Plane Specification
-*/
-
-/*
- * Layer common to data and control packets
- */
-
-#ifndef _XRAN_PKT_H_
-#define _XRAN_PKT_H_
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#include <rte_common.h>
-#include <rte_ether.h>
-#include <rte_byteorder.h>
-
-/**
- *****************************************************************************
- * @file xran_pkt.h
- *
- * @defgroup xran_common_pkt XRAN Packet definitions and functions
- * @ingroup xran
- *
- * @description
- * Definitions and support functions to process XRAN packet
- *****************************************************************************/
-
-#define ECPRI_MAX_PAYLOAD_SIZE 65535 /**< Max packet size taken in this implementation */
-
-/* XRAN spec: For this encapsulation, either the eCPRI Ethertype or the IEEE 1914.3 Ethertype shall be use */
-#define XRAN_ETHER_TYPE 0xAEFE /**< defined by eCPRI Specification V1.1 */
-
-#define XRAN_ECPRI_VER 0x0001 /**< eCPRI protocol revision 3.1.3.1.1 */
-#define XRAN_PAYLOAD_VER 0x0001 /**< Payload version 5.4.4.2 */
-
-#define VLAN_ID 0 /**< Default Tag protocol identifier (TPID)*/
-#define VLAN_PCP 7 /**< U-Plane and C-Plane only see Table 3 5 : Quality of service classes */
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * eCPRI message types
- * as per eCPRI spec 3.2.4. Message Types
- *****************************************************************************/
-enum ecpri_msg_type
-{
- ECPRI_IQ_DATA = 0x00, /**< U-plane: IQ data */
- ECPRI_BIT_SEQUENCE = 0x01, /* msg type is not supported */
- ECPRI_RT_CONTROL_DATA = 0x02, /**< C-plane: Control */
-
- /* Below msg types are not supported */
- ECPRI_GEN_DATA_TRANSFER = 0x03,
- ECPRI_REMOTE_MEM_ACCESS = 0x04,
- ECPRI_DELAY_MEASUREMENT = 0x05,
- ECPRI_REMOTE_RESET = 0x06,
- ECPRI_EVENT_INDICATION = 0x07,
- ECPRI_MSG_TYPE_MAX
-};
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * see 3.1.3.1.7 ecpriSeqid (message identifier)
- *****************************************************************************/
-struct ecpri_seq_id
-{
- uint8_t seq_id:8; /**< Sequence ID */
- uint8_t sub_seq_id:7; /**< Subsequence ID */
- uint8_t e_bit:1; /**< E bit */
-} __rte_packed;
-
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * Structure holds common eCPRI header as per
- * Table 3 1 : eCPRI Transport Header Field Definitions
- *****************************************************************************/
-struct xran_ecpri_cmn_hdr
-{
- uint8_t ecpri_concat:1; /**< 3.1.3.1.3 eCPRI concatenation indicator */
- uint8_t ecpri_resv:3; /**< 3.1.3.1.2 eCPRI reserved */
- uint8_t ecpri_ver:4; /**< 3.1.3.1.1 eCPRI protocol revision, defined in XRAN_ECPRI_VER */
- uint8_t ecpri_mesg_type; /**< 3.1.3.1.4 eCPRI message type, defined in ecpri_msg_type */
- uint16_t ecpri_payl_size; /**< 3.1.3.1.5 eCPRI payload size, without common header and any padding bytes */
-} __rte_packed;
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * Structure holds eCPRI transport header as per
- * Table 3 1 : eCPRI Transport Header Field Definitions
- *****************************************************************************/
-struct xran_ecpri_hdr
-{
- struct xran_ecpri_cmn_hdr cmnhdr;
- rte_be16_t ecpri_xtc_id; /**< 3.1.3.1.6 real time control data / IQ data transfer message series identifier */
- struct ecpri_seq_id ecpri_seq_id; /**< 3.1.3.1.7 message identifier */
-} __rte_packed;
-
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * Enum used to set xRAN packet data direction (gNB Tx/Rx 5.4.4.1)
- * uplink or downlink
- *****************************************************************************/
-enum xran_pkt_dir
-{
- XRAN_DIR_UL = 0, /**< UL direction */
- XRAN_DIR_DL = 1, /**< DL direction */
- XRAN_DIR_MAX
-};
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * Structure holds components of radio application header
- * 5.4.4 Coding of Information Elements - Application Layer, Common
- * for U-plane as per 6.3.2 DL/UL Data
- *****************************************************************************/
-struct radio_app_common_hdr
-{
- /* Octet 9 */
- uint8_t filter_id:4; /**< This parameter defines an index to the channel filter to be
- used between IQ data and air interface, both in DL and UL.
- For most physical channels filterIndex =0000b is used which
- indexes the standard channel filter, e.g. 100MHz channel filter
- for 100MHz nominal carrier bandwidth. (see 5.4.4.3 for more) */
- uint8_t payl_ver:3; /**< This parameter defines the payload protocol version valid
- for the following IEs in the application layer. In this version of
- the specification payloadVersion=001b shall be used. */
- uint8_t data_direction:1; /**< This parameter indicates the gNB data direction. */
-
- /* Octet 10 */
- uint8_t frame_id:8; /**< This parameter is a counter for 10 ms frames (wrapping period 2.56 seconds) */
-
- /* Octet 11 */
- /* Octet 12 */
- union {
- uint16_t value;
- struct {
- uint16_t symb_id:6; /**< This parameter identifies the first symbol number within slot,
- to which the information of this message is applies. */
- uint16_t slot_id:6; /**< This parameter is the slot number within a 1ms sub-frame. All slots in
- one sub-frame are counted by this parameter, slotId running from 0 to Nslot-1.
- In this version of the specification the maximum Nslot=16, All
- other values of the 6 bits are reserved for future use. */
- uint16_t subframe_id:4; /**< This parameter is a counter for 1 ms sub-frames within 10ms frame. */
- };
- }sf_slot_sym;
-
-} __rte_packed;
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * This parameter defines the compression method and IQ bit width for the
- * user data in the data section. This field is absent from U-Plane messages
- * when the static IQ format and compression method is configured via the M-Plane.
- * In this way a single compression method and IQ bit width is provided
- * (per UL and DL, per LTE and NR) without adding more overhead to U-Plane messages.
- *****************************************************************************/
-struct compression_hdr
-{
- uint8_t ud_iq_width:4; /**< Bit width of each I and each Q
- 16 for udIqWidth=0, otherwise equals udIqWidth e.g. udIqWidth = 0000b means I and Q are each 16 bits wide;
- e.g. udIQWidth = 0001b means I and Q are each 1 bit wide;
- e.g. udIqWidth = 1111b means I and Q are each 15 bits wide
- */
- uint8_t ud_comp_meth:4;
- /**< udCompMeth| compression method |udIqWidth meaning
- ---------------+-----------------------------+--------------------------------------------
- 0000b | no compression |bitwidth of each uncompressed I and Q value
- 0001b | block floating point |bitwidth of each I and Q mantissa value
- 0010b | block scaling |bitwidth of each I and Q scaled value
- 0011b | mu-law |bitwidth of each compressed I and Q value
- 0100b | modulation compression |bitwidth of each compressed I and Q value
- 0100b - 1111b | reserved for future methods |depends on the specific compression method
- */
-} __rte_packed;
-
-/**
- ******************************************************************************
- * @ingroup xran_common_pkt
- *
- * @description
- * Structure holds common xran packet header
- * 3.1.1 Ethernet Encapsulation
- *****************************************************************************/
-struct xran_pkt_comm_hdr
-{
- struct ether_hdr eth_hdr; /**< Ethernet Header */
- struct xran_ecpri_hdr ecpri_hdr; /**< eCPRI Transport Header */
-} __rte_packed;
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
+/******************************************************************************\r
+*\r
+* Copyright (c) 2019 Intel.\r
+*\r
+* Licensed under the Apache License, Version 2.0 (the "License");\r
+* you may not use this file except in compliance with the License.\r
+* You may obtain a copy of the License at\r
+*\r
+* http://www.apache.org/licenses/LICENSE-2.0\r
+*\r
+* Unless required by applicable law or agreed to in writing, software\r
+* distributed under the License is distributed on an "AS IS" BASIS,\r
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+* See the License for the specific language governing permissions and\r
+* limitations under the License.\r
+*\r
+*******************************************************************************/\r
+\r
+/**\r
+ * @brief Definitions and support functions to process XRAN packet\r
+ * @file xran_pkt.h\r
+ * @ingroup group_source_xran\r
+ * @author Intel Corporation\r
+ **/\r
+\r
+/* ORAN-WG4.CUS.0-v01.00 O-RAN Fronthaul Working Group\r
+ Control, User and Synchronization Plane Specification\r
+*/\r
+\r
+/*\r
+ * Layer common to data and control packets\r
+ */\r
+\r
+#ifndef _XRAN_PKT_H_\r
+#define _XRAN_PKT_H_\r
+\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+#include <rte_common.h>\r
+#include <rte_ether.h>\r
+#include <rte_byteorder.h>\r
+\r
+/**\r
+ *****************************************************************************\r
+ * @file xran_pkt.h\r
+ *\r
+ * @defgroup xran_common_pkt XRAN Packet definitions and functions\r
+ * @ingroup xran\r
+ *\r
+ * @description\r
+ * Definitions and support functions to process XRAN packet\r
+ *****************************************************************************/\r
+\r
+#define ECPRI_MAX_PAYLOAD_SIZE 65535 /**< Max packet size taken in this implementation */\r
+\r
+/* XRAN spec: For this encapsulation, either the eCPRI Ethertype or the IEEE 1914.3 Ethertype shall be use */\r
+#define XRAN_ETHER_TYPE 0xAEFE /**< defined by eCPRI Specification V1.1 */\r
+\r
+#define XRAN_ECPRI_VER 0x0001 /**< eCPRI protocol revision 3.1.3.1.1 */\r
+#define XRAN_PAYLOAD_VER 0x0001 /**< Payload version 5.4.4.2 */\r
+\r
+#define VLAN_ID 0 /**< Default Tag protocol identifier (TPID)*/\r
+#define VLAN_PCP 7 /**< U-Plane and C-Plane only see Table 3 5 : Quality of service classes */\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * eCPRI message types\r
+ * as per eCPRI spec 3.2.4. Message Types\r
+ *****************************************************************************/\r
+enum ecpri_msg_type\r
+{\r
+ ECPRI_IQ_DATA = 0x00, /**< U-plane: IQ data */\r
+ ECPRI_BIT_SEQUENCE = 0x01, /* msg type is not supported */\r
+ ECPRI_RT_CONTROL_DATA = 0x02, /**< C-plane: Control */\r
+\r
+ /* Below msg types are not supported */\r
+ ECPRI_GEN_DATA_TRANSFER = 0x03,\r
+ ECPRI_REMOTE_MEM_ACCESS = 0x04,\r
+ ECPRI_DELAY_MEASUREMENT = 0x05,\r
+ ECPRI_REMOTE_RESET = 0x06,\r
+ ECPRI_EVENT_INDICATION = 0x07,\r
+ ECPRI_MSG_TYPE_MAX\r
+};\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * see 3.1.3.1.7 ecpriSeqid (message identifier)\r
+ *****************************************************************************/\r
+struct ecpri_seq_id\r
+{\r
+ uint8_t seq_id:8; /**< Sequence ID */\r
+ uint8_t sub_seq_id:7; /**< Subsequence ID */\r
+ uint8_t e_bit:1; /**< E bit */\r
+} __rte_packed;\r
+\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * Structure holds common eCPRI header as per\r
+ * Table 3 1 : eCPRI Transport Header Field Definitions\r
+ *****************************************************************************/\r
+struct xran_ecpri_cmn_hdr\r
+{\r
+ uint8_t ecpri_concat:1; /**< 3.1.3.1.3 eCPRI concatenation indicator */\r
+ uint8_t ecpri_resv:3; /**< 3.1.3.1.2 eCPRI reserved */\r
+ uint8_t ecpri_ver:4; /**< 3.1.3.1.1 eCPRI protocol revision, defined in XRAN_ECPRI_VER */\r
+ uint8_t ecpri_mesg_type; /**< 3.1.3.1.4 eCPRI message type, defined in ecpri_msg_type */\r
+ uint16_t ecpri_payl_size; /**< 3.1.3.1.5 eCPRI payload size, without common header and any padding bytes */\r
+} __rte_packed;\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * Structure holds eCPRI transport header as per\r
+ * Table 3 1 : eCPRI Transport Header Field Definitions\r
+ *****************************************************************************/\r
+struct xran_ecpri_hdr\r
+{\r
+ struct xran_ecpri_cmn_hdr cmnhdr;\r
+ rte_be16_t ecpri_xtc_id; /**< 3.1.3.1.6 real time control data / IQ data transfer message series identifier */\r
+ struct ecpri_seq_id ecpri_seq_id; /**< 3.1.3.1.7 message identifier */\r
+} __rte_packed;\r
+\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * Enum used to set xRAN packet data direction (gNB Tx/Rx 5.4.4.1)\r
+ * uplink or downlink\r
+ *****************************************************************************/\r
+enum xran_pkt_dir\r
+{\r
+ XRAN_DIR_UL = 0, /**< UL direction */\r
+ XRAN_DIR_DL = 1, /**< DL direction */\r
+ XRAN_DIR_MAX\r
+};\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * Structure holds components of radio application header\r
+ * 5.4.4 Coding of Information Elements - Application Layer, Common\r
+ * for U-plane as per 6.3.2 DL/UL Data\r
+ *****************************************************************************/\r
+struct radio_app_common_hdr\r
+{\r
+ /* Octet 9 */\r
+ uint8_t filter_id:4; /**< This parameter defines an index to the channel filter to be\r
+ used between IQ data and air interface, both in DL and UL.\r
+ For most physical channels filterIndex =0000b is used which\r
+ indexes the standard channel filter, e.g. 100MHz channel filter\r
+ for 100MHz nominal carrier bandwidth. (see 5.4.4.3 for more) */\r
+ uint8_t payl_ver:3; /**< This parameter defines the payload protocol version valid\r
+ for the following IEs in the application layer. In this version of\r
+ the specification payloadVersion=001b shall be used. */\r
+ uint8_t data_direction:1; /**< This parameter indicates the gNB data direction. */\r
+\r
+ /* Octet 10 */\r
+ uint8_t frame_id:8; /**< This parameter is a counter for 10 ms frames (wrapping period 2.56 seconds) */\r
+\r
+ /* Octet 11 */\r
+ /* Octet 12 */\r
+ union {\r
+ uint16_t value;\r
+ struct {\r
+ uint16_t symb_id:6; /**< This parameter identifies the first symbol number within slot,\r
+ to which the information of this message is applies. */\r
+ uint16_t slot_id:6; /**< This parameter is the slot number within a 1ms sub-frame. All slots in\r
+ one sub-frame are counted by this parameter, slotId running from 0 to Nslot-1.\r
+ In this version of the specification the maximum Nslot=16, All\r
+ other values of the 6 bits are reserved for future use. */\r
+ uint16_t subframe_id:4; /**< This parameter is a counter for 1 ms sub-frames within 10ms frame. */\r
+ };\r
+ }sf_slot_sym;\r
+\r
+} __rte_packed;\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * This parameter defines the compression method and IQ bit width for the\r
+ * user data in the data section. This field is absent from U-Plane messages\r
+ * when the static IQ format and compression method is configured via the M-Plane.\r
+ * In this way a single compression method and IQ bit width is provided\r
+ * (per UL and DL, per LTE and NR) without adding more overhead to U-Plane messages.\r
+ *****************************************************************************/\r
+struct compression_hdr\r
+{\r
+ uint8_t ud_iq_width:4; /**< Bit width of each I and each Q\r
+ 16 for udIqWidth=0, otherwise equals udIqWidth e.g. udIqWidth = 0000b means I and Q are each 16 bits wide;\r
+ e.g. udIQWidth = 0001b means I and Q are each 1 bit wide;\r
+ e.g. udIqWidth = 1111b means I and Q are each 15 bits wide\r
+ */\r
+ uint8_t ud_comp_meth:4;\r
+ /**< udCompMeth| compression method |udIqWidth meaning\r
+ ---------------+-----------------------------+--------------------------------------------\r
+ 0000b | no compression |bitwidth of each uncompressed I and Q value\r
+ 0001b | block floating point |bitwidth of each I and Q mantissa value\r
+ 0010b | block scaling |bitwidth of each I and Q scaled value\r
+ 0011b | mu-law |bitwidth of each compressed I and Q value\r
+ 0100b | modulation compression |bitwidth of each compressed I and Q value\r
+ 0100b - 1111b | reserved for future methods |depends on the specific compression method\r
+ */\r
+} __rte_packed;\r
+\r
+/**\r
+ ******************************************************************************\r
+ * @ingroup xran_common_pkt\r
+ *\r
+ * @description\r
+ * Structure holds common xran packet header\r
+ * 3.1.1 Ethernet Encapsulation\r
+ *****************************************************************************/\r
+struct xran_pkt_comm_hdr\r
+{\r
+ struct ether_hdr eth_hdr; /**< Ethernet Header */\r
+ struct xran_ecpri_hdr ecpri_hdr; /**< eCPRI Transport Header */\r
+} __rte_packed;\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+#endif\r
Code Review / o-du / phy.git / blobdiff