X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fxran__transport_8h_source.html;fp=docs%2FAPI%2Fxran__transport_8h_source.html;h=73e9d8e3b6f6ba236beda7c13e042b84274df41d;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git diff --git a/docs/API/xran__transport_8h_source.html b/docs/API/xran__transport_8h_source.html new file mode 100644 index 0000000..73e9d8e --- /dev/null +++ b/docs/API/xran__transport_8h_source.html @@ -0,0 +1,98 @@ + + + + + + + +o-du/phy: xran_transport.h Source File + + + + + + + + + +
+
+ + + + + + +
+
o-du/phy +
+
Intel O-RAN/X-RAN Generated Doxygen Documentation
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
xran_transport.h
+
+
+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 #ifndef _XRAN_TRANSPORT_H_
29 #define _XRAN_TRANSPORT_H_
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 #include <rte_common.h>
36 #include <rte_mbuf.h>
37 
38 #include "xran_pkt.h"
39 
40 struct xran_eaxc_info {
41  uint8_t cuPortId;
42  uint8_t bandSectorId;
43  uint8_t ccId;
44  uint8_t ruPortId;
45 };
46 
47 struct xran_recv_packet_info {
48  int ecpri_version;
49  enum ecpri_msg_type msg_type;
50  int payload_len;
51  struct xran_eaxc_info eaxc;
52  int seq_id;
53  int subseq_id;
54  int ebit;
55 };
56 
57 
58 int xran_get_ecpri_hdr_size(void);
59 void xran_update_ecpri_payload_size(struct rte_mbuf *mbuf, int size);
60 
61 uint16_t xran_compose_cid(uint8_t CU_Port_ID, uint8_t BandSector_ID, uint8_t CC_ID, uint8_t Ant_ID);
62 void xran_decompose_cid(uint16_t cid, struct xran_eaxc_info *result);
63 
64 int xran_build_ecpri_hdr(struct rte_mbuf *mbuf,
65  uint8_t CC_ID, uint8_t Ant_ID,
66  uint8_t seq_id,
67  struct xran_ecpri_hdr **ecpri_hdr);
68 
69 int xran_parse_ecpri_hdr(struct rte_mbuf *mbuf,
70  struct xran_ecpri_hdr **ecpri_hdr,
71  struct xran_recv_packet_info *pkt_info);
72 
73 #ifdef __cplusplus
74 }
75 #endif
76 
77 #endif
78 
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_eaxc_info::bandSectorId
uint8_t bandSectorId
Definition: xran_transport.h:42
+
xran_eaxc_info::ruPortId
uint8_t ruPortId
Definition: xran_transport.h:44
+
xran_decompose_cid
void xran_decompose_cid(uint16_t cid, struct xran_eaxc_info *result)
Decompose ecpriRtcid/ecpriPcid.
Definition: xran_transport.c:89
+
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_recv_packet_info::ebit
int ebit
Definition: xran_transport.h:54
+
xran_recv_packet_info
Definition: xran_transport.h:47
+
xran_recv_packet_info::seq_id
int seq_id
Definition: xran_transport.h:52
+
xran_ecpri_hdr
Definition: xran_pkt.h:130
+
xran_eaxc_info::cuPortId
uint8_t cuPortId
Definition: xran_transport.h:41
+
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_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_recv_packet_info::ecpri_version
int ecpri_version
Definition: xran_transport.h:48
+
xran_eaxc_info
Definition: xran_transport.h:40
+
xran_recv_packet_info::subseq_id
int subseq_id
Definition: xran_transport.h:53
+
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_pkt.h
Definitions and support functions to process XRAN packet.
+
xran_recv_packet_info::payload_len
int payload_len
Definition: xran_transport.h:50
+
ecpri_msg_type
ecpri_msg_type
Definition: xran_pkt.h:75
+
xran_eaxc_info::ccId
uint8_t ccId
Definition: xran_transport.h:43
+
+ +
+Generated by   +doxygen + 1.8.13 +
+ +