X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fxran__transport_8c_source.html;fp=docs%2FAPI%2Fxran__transport_8c_source.html;h=0000000000000000000000000000000000000000;hb=bdbd414e8038630c154ee3c6b8bc9b3aeb954be6;hp=3a341bf3d185be594b4bfdef7f6d75fbb75a6a68;hpb=e9403c457453dba780e64af7de9462fad7217aa3;p=o-du%2Fphy.git diff --git a/docs/API/xran__transport_8c_source.html b/docs/API/xran__transport_8c_source.html deleted file mode 100644 index 3a341bf..0000000 --- a/docs/API/xran__transport_8c_source.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - -o-du/phy: xran_transport.c Source File - - - - - - - - - -
-
- - - - - - -
-
o-du/phy -
-
Intel O-RAN/X-RAN Generated Doxygen Documentation
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
xran_transport.c
-
-
-Go to the documentation of this file.
1 /******************************************************************************
2 *
3 * Copyright (c) 2019 Intel.
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 
28 #include <stdint.h>
29 #include <endian.h>
30 #include <rte_common.h>
31 #include <rte_config.h>
32 
33 #include "xran_fh_o_du.h"
34 #include "xran_common.h"
35 #include "xran_transport.h"
36 #include "xran_pkt_cp.h"
37 #include "xran_cp_api.h"
38 #include "xran_up_api.h"
39 #include "xran_printf.h"
40 
41 
49 int xran_get_ecpri_hdr_size(void)
50 {
51  return(sizeof(struct xran_ecpri_hdr) - sizeof(struct xran_ecpri_cmn_hdr));
52 }
53 
65 uint16_t xran_compose_cid(uint8_t CU_Port_ID, uint8_t BandSector_ID, uint8_t CC_ID, uint8_t Ant_ID)
66 {
67  uint16_t cid;
68  struct xran_eaxcid_config *conf;
69 
70  conf = xran_get_conf_eAxC(NULL);
71 
72  cid = ((CU_Port_ID << conf->bit_cuPortId) & conf->mask_cuPortId)
73  | ((BandSector_ID << conf->bit_bandSectorId) & conf->mask_bandSectorId)
74  | ((CC_ID << conf->bit_ccId) & conf->mask_ccId)
75  | ((Ant_ID << conf->bit_ruPortId) & conf->mask_ruPortId);
76 
77  return (rte_cpu_to_be_16(cid));
78 }
79 
89 void xran_decompose_cid(uint16_t cid, struct xran_eaxc_info *result)
90 {
91  struct xran_eaxcid_config *conf;
92 
93  conf = xran_get_conf_eAxC(NULL);
94  cid = rte_be_to_cpu_16(cid);
95 
96  result->cuPortId = (cid&conf->mask_cuPortId) >> conf->bit_cuPortId;
97  result->bandSectorId = (cid&conf->mask_bandSectorId) >> conf->bit_bandSectorId;
98  result->ccId = (cid&conf->mask_ccId) >> conf->bit_ccId;
99  result->ruPortId = (cid&conf->mask_ruPortId) >> conf->bit_ruPortId;
100 
101  return;
102 }
103 
113 inline void xran_update_ecpri_payload_size(struct rte_mbuf *mbuf, int size)
114 {
115  struct xran_ecpri_hdr *ecpri_hdr;
116 
117  ecpri_hdr = rte_pktmbuf_mtod(mbuf, struct xran_ecpri_hdr *);
118 
119  ecpri_hdr->cmnhdr.ecpri_payl_size = rte_cpu_to_be_16(size);
120 }
121 
122 
142 int xran_build_ecpri_hdr(struct rte_mbuf *mbuf,
143  uint8_t CC_ID, uint8_t Ant_ID,
144  uint8_t seq_id,
145  struct xran_ecpri_hdr **ecpri_hdr)
146 {
147  uint32_t payloadlen;
148  struct xran_ecpri_hdr *tmp;
149 
150 
151  tmp = (struct xran_ecpri_hdr *)rte_pktmbuf_append(mbuf, sizeof(struct xran_ecpri_hdr));
152  if(unlikely(tmp == NULL)) {
153  print_err("Fail to allocate the space for eCPRI hedaer!");
154  return (XRAN_STATUS_RESOURCE);
155  }
156 
157  /* Fill common header */
158  tmp->cmnhdr.ecpri_ver = XRAN_ECPRI_VER;
159  tmp->cmnhdr.ecpri_resv = 0; // should be zero
160  tmp->cmnhdr.ecpri_concat = 0;
161  tmp->cmnhdr.ecpri_mesg_type = ECPRI_RT_CONTROL_DATA;
162  tmp->ecpri_xtc_id = xran_compose_cid(0, 0, CC_ID, Ant_ID);
163 
164  /* TODO: Transport layer fragmentation is not supported */
165  tmp->ecpri_seq_id.seq_id = seq_id;
166  tmp->ecpri_seq_id.sub_seq_id = 0;
167  tmp->ecpri_seq_id.e_bit = 1;
168 
169  /* Starts with eCPRI header size */
170  payloadlen = xran_get_ecpri_hdr_size();
171 
172  *ecpri_hdr = tmp;
173 
174  return (payloadlen);
175 }
176 
192 int xran_parse_ecpri_hdr(struct rte_mbuf *mbuf,
193  struct xran_ecpri_hdr **ecpri_hdr,
194  struct xran_recv_packet_info *pkt_info)
195 {
196  int ret;
197 
198 
199  *ecpri_hdr = rte_pktmbuf_mtod(mbuf, void *);
200  if(*ecpri_hdr == NULL) {
201  print_err("Invalid packet - eCPRI hedaer!");
202  return (XRAN_STATUS_INVALID_PACKET);
203  }
204 
205  /* Process eCPRI header */
206  ret = XRAN_STATUS_SUCCESS;
207  if((*ecpri_hdr)->cmnhdr.ecpri_ver != XRAN_ECPRI_VER) {
208  print_err("Invalid eCPRI version - %d", (*ecpri_hdr)->cmnhdr.ecpri_ver);
209  ret = XRAN_STATUS_INVALID_PACKET;
210  }
211  if((*ecpri_hdr)->cmnhdr.ecpri_resv != 0) {
212  print_err("Invalid reserved field - %d", (*ecpri_hdr)->cmnhdr.ecpri_resv);
213  ret = XRAN_STATUS_INVALID_PACKET;
214  }
215 
216  if(pkt_info != NULL) {
217  /* store the information from header */
218  pkt_info->ecpri_version = (*ecpri_hdr)->cmnhdr.ecpri_ver;
219  pkt_info->msg_type = (enum ecpri_msg_type)(*ecpri_hdr)->cmnhdr.ecpri_mesg_type;
220  pkt_info->payload_len = rte_be_to_cpu_16((*ecpri_hdr)->cmnhdr.ecpri_payl_size);
221 
222  pkt_info->seq_id = (*ecpri_hdr)->ecpri_seq_id.seq_id;
223  pkt_info->subseq_id = (*ecpri_hdr)->ecpri_seq_id.sub_seq_id;
224  pkt_info->ebit = (*ecpri_hdr)->ecpri_seq_id.e_bit;
225  xran_decompose_cid((*ecpri_hdr)->ecpri_xtc_id, &(pkt_info->eaxc));
226  }
227 
228  return (ret);
229 }
230 
xran_ecpri_cmn_hdr::ecpri_concat
uint8_t ecpri_concat
Definition: xran_pkt.h:115
-
xran_pkt_cp.h
This file provides the definition of Control Plane Messages for XRAN Front Haul layer as defined in X...
-
xran_recv_packet_info::msg_type
enum ecpri_msg_type msg_type
Definition: xran_transport.h:49
-
XRAN_STATUS_SUCCESS
#define XRAN_STATUS_SUCCESS
Definition: xran_fh_o_du.h:54
-
XRAN_ECPRI_VER
#define XRAN_ECPRI_VER
Definition: xran_pkt.h:61
-
xran_build_ecpri_hdr
int xran_build_ecpri_hdr(struct rte_mbuf *mbuf, uint8_t CC_ID, uint8_t Ant_ID, uint8_t seq_id, struct xran_ecpri_hdr **ecpri_hdr)
Build ECPRI header and returns added length.
Definition: xran_transport.c:142
-
xran_eaxcid_config::mask_bandSectorId
uint16_t mask_bandSectorId
Definition: xran_fh_o_du.h:310
-
ECPRI_RT_CONTROL_DATA
Definition: xran_pkt.h:79
-
ecpri_seq_id::seq_id
uint8_t seq_id
Definition: xran_pkt.h:99
-
xran_eaxc_info::bandSectorId
uint8_t bandSectorId
Definition: xran_transport.h:42
-
xran_eaxc_info::ruPortId
uint8_t ruPortId
Definition: xran_transport.h:44
-
xran_eaxcid_config::bit_ruPortId
uint8_t bit_ruPortId
Definition: xran_fh_o_du.h:317
-
xran_eaxcid_config
Definition: xran_fh_o_du.h:308
-
xran_compose_cid
uint16_t xran_compose_cid(uint8_t CU_Port_ID, uint8_t BandSector_ID, uint8_t CC_ID, uint8_t Ant_ID)
Compose ecpriRtcid/ecpriPcid.
Definition: xran_transport.c:65
-
xran_decompose_cid
void xran_decompose_cid(uint16_t cid, struct xran_eaxc_info *result)
Decompose ecpriRtcid/ecpriPcid.
Definition: xran_transport.c:89
-
xran_get_conf_eAxC
struct xran_eaxcid_config * xran_get_conf_eAxC(void *pHandle)
Get the configuration of eAxC ID.
Definition: xran_main.c:2955
-
xran_eaxcid_config::bit_ccId
uint8_t bit_ccId
Definition: xran_fh_o_du.h:316
-
xran_recv_packet_info::ebit
int ebit
Definition: xran_transport.h:54
-
xran_recv_packet_info
Definition: xran_transport.h:47
-
xran_parse_ecpri_hdr
int xran_parse_ecpri_hdr(struct rte_mbuf *mbuf, struct xran_ecpri_hdr **ecpri_hdr, struct xran_recv_packet_info *pkt_info)
Parse ECPRI header.
Definition: xran_transport.c:192
-
xran_ecpri_cmn_hdr::ecpri_ver
uint8_t ecpri_ver
Definition: xran_pkt.h:117
-
xran_recv_packet_info::seq_id
int seq_id
Definition: xran_transport.h:52
-
xran_eaxcid_config::bit_cuPortId
uint8_t bit_cuPortId
Definition: xran_fh_o_du.h:314
-
xran_eaxcid_config::bit_bandSectorId
uint8_t bit_bandSectorId
Definition: xran_fh_o_du.h:315
-
xran_ecpri_hdr
Definition: xran_pkt.h:130
-
xran_eaxc_info::cuPortId
uint8_t cuPortId
Definition: xran_transport.h:41
-
print_err
#define print_err(fmt, args...)
Definition: xran_printf.h:62
-
xran_ecpri_cmn_hdr::ecpri_resv
uint8_t ecpri_resv
Definition: xran_pkt.h:116
-
xran_update_ecpri_payload_size
void xran_update_ecpri_payload_size(struct rte_mbuf *mbuf, int size)
modify the payload size of eCPRI header in xRAN packet
Definition: xran_transport.c:113
-
xran_ecpri_cmn_hdr
Definition: xran_pkt.h:113
-
xran_recv_packet_info::ecpri_version
int ecpri_version
Definition: xran_transport.h:48
-
xran_eaxc_info
Definition: xran_transport.h:40
-
ecpri_seq_id::e_bit
uint8_t e_bit
Definition: xran_pkt.h:101
-
ecpri_seq_id::sub_seq_id
uint8_t sub_seq_id
Definition: xran_pkt.h:100
-
xran_printf.h
Modules provide debug prints and utility functions.
-
xran_ecpri_hdr::cmnhdr
struct xran_ecpri_cmn_hdr cmnhdr
Definition: xran_pkt.h:132
-
xran_up_api.h
This file provides the definitions for User Plane Messages APIs.
-
xran_common.h
XRAN layer common functionality for both lls-CU and RU as well as C-plane and U-plane.
-
xran_recv_packet_info::subseq_id
int subseq_id
Definition: xran_transport.h:53
-
xran_ecpri_hdr::ecpri_xtc_id
rte_be16_t ecpri_xtc_id
Definition: xran_pkt.h:133
-
xran_fh_o_du.h
This file provides public interface to xRAN Front Haul layer implementation as defined in the ORAN-WG...
-
xran_recv_packet_info::payload_len
int payload_len
Definition: xran_transport.h:50
-
xran_eaxcid_config::mask_cuPortId
uint16_t mask_cuPortId
Definition: xran_fh_o_du.h:309
-
xran_ecpri_hdr::ecpri_seq_id
struct ecpri_seq_id ecpri_seq_id
Definition: xran_pkt.h:134
-
ecpri_msg_type
ecpri_msg_type
Definition: xran_pkt.h:75
-
xran_eaxc_info::ccId
uint8_t ccId
Definition: xran_transport.h:43
-
xran_ecpri_cmn_hdr::ecpri_mesg_type
uint8_t ecpri_mesg_type
Definition: xran_pkt.h:118
-
xran_eaxcid_config::mask_ruPortId
uint16_t mask_ruPortId
Definition: xran_fh_o_du.h:312
-
xran_get_ecpri_hdr_size
int xran_get_ecpri_hdr_size(void)
return eCPRI header size without eCPRI common header
Definition: xran_transport.c:49
-
XRAN_STATUS_RESOURCE
#define XRAN_STATUS_RESOURCE
Definition: xran_fh_o_du.h:68
-
xran_cp_api.h
This file provides the definitions for Control Plane Messages APIs.
-
XRAN_STATUS_INVALID_PACKET
#define XRAN_STATUS_INVALID_PACKET
Definition: xran_fh_o_du.h:92
-
xran_eaxcid_config::mask_ccId
uint16_t mask_ccId
Definition: xran_fh_o_du.h:311
-
xran_ecpri_cmn_hdr::ecpri_payl_size
uint16_t ecpri_payl_size
Definition: xran_pkt.h:119
-
xran_recv_packet_info::eaxc
struct xran_eaxc_info eaxc
Definition: xran_transport.h:51
-
xran_transport.h
This file provides the definitions for Transport layer (eCPRI) API.
-
- -
-Generated by   -doxygen - 1.8.13 -
- -