X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fxran__up__api_8h_source.html;fp=docs%2FAPI%2Fxran__up__api_8h_source.html;h=0000000000000000000000000000000000000000;hb=bdbd414e8038630c154ee3c6b8bc9b3aeb954be6;hp=c3eb98fb06a6c8ab421ed861667a30dd4da5f5ac;hpb=e9403c457453dba780e64af7de9462fad7217aa3;p=o-du%2Fphy.git diff --git a/docs/API/xran__up__api_8h_source.html b/docs/API/xran__up__api_8h_source.html deleted file mode 100644 index c3eb98f..0000000 --- a/docs/API/xran__up__api_8h_source.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - -o-du/phy: xran_up_api.h Source File - - - - - - - - - -
-
- - - - - - -
-
o-du/phy -
-
Intel O-RAN/X-RAN Generated Doxygen Documentation
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
xran_up_api.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_UP_API_H_
29 #define _XRAN_UP_API_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 #include "xran_pkt_up.h"
40 
41 /*
42  * structure used for storing packet parameters needed for generating
43  * a data packet
44  */
45 struct xran_up_pkt_gen_params
46 {
47  struct radio_app_common_hdr app_params;
48  struct data_section_hdr sec_hdr;
49  struct data_section_compression_hdr compr_hdr_param;
50  union compression_params compr_param;
51 };
52 
53 /*
54  * structure used for storing packet parameters needed for generating
55  * a data packet without compression
56  * Next fields are omitted:
57  * udCompHdr (not always present)
58  * reserved (not always present)
59  * udCompParam (not always present)
60  */
61 struct xran_up_pkt_gen_no_compression_params
62 {
63  struct radio_app_common_hdr app_params;
64  struct data_section_hdr sec_hdr;
65 };
66 
75 int32_t xran_extract_iq_samples(struct rte_mbuf *mbuf,
76  void **iq_data_start,
77  uint8_t *CC_ID,
78  uint8_t *Ant_ID,
79  uint8_t *frame_id,
80  uint8_t *subframe_id,
81  uint8_t *slot_id,
82  uint8_t *symb_id,
83  struct ecpri_seq_id *seq_id,
84  uint16_t *num_prbu,
85  uint16_t *start_prbu,
86  uint16_t *sym_inc,
87  uint16_t *rb,
88  uint16_t *sect_id,
89  int8_t expect_comp,
90  uint8_t *compMeth,
91  uint8_t *iqWidth);
92 
93 int xran_prepare_iq_symbol_portion(
94  struct rte_mbuf *mbuf,
95  const void *iq_data_start,
96  const enum xran_input_byte_order iq_buf_byte_order,
97  const uint32_t iq_data_num_bytes,
98  struct xran_up_pkt_gen_params *params,
99  uint8_t CC_ID,
100  uint8_t Ant_ID,
101  uint8_t seq_id,
102  uint32_t do_copy);
103 
104 #ifdef __cplusplus
105 }
106 #endif
107 
108 #endif /* _XRAN_UP_API_H_ */
data_section_hdr::sym_inc
uint32_t sym_inc
Definition: xran_pkt_up.h:73
-
rb
uint32_t rb
Definition: xran_pkt_cp.h:243
-
xran_up_pkt_gen_params::app_params
struct radio_app_common_hdr app_params
Definition: xran_up_api.h:47
-
data_section_compression_hdr
Definition: xran_pkt_up.h:90
-
data_section_hdr
Definition: xran_pkt_up.h:67
-
xran_up_pkt_gen_params
Definition: xran_up_api.h:45
-
data_section_hdr::num_prbu
uint32_t num_prbu
Definition: xran_pkt_up.h:71
-
xran_up_pkt_gen_no_compression_params
Definition: xran_up_api.h:61
-
xran_input_byte_order
xran_input_byte_order
Definition: xran_fh_o_du.h:471
-
xran_up_pkt_gen_params::sec_hdr
struct data_section_hdr sec_hdr
Definition: xran_up_api.h:48
-
compression_params
Definition: xran_pkt_up.h:110
-
xran_up_pkt_gen_params::compr_param
union compression_params compr_param
Definition: xran_up_api.h:50
-
data_section_hdr::start_prbu
uint32_t start_prbu
Definition: xran_pkt_up.h:72
-
ecpri_seq_id
Definition: xran_pkt.h:97
-
xran_pkt.h
Definitions and support functions to process XRAN packet.
-
xran_pkt_up.h
Definitions and support functions to process XRAN packet.
-
data_section_hdr::sect_id
uint32_t sect_id
Definition: xran_pkt_up.h:75
-
xran_extract_iq_samples
int32_t xran_extract_iq_samples(struct rte_mbuf *mbuf, void **iq_data_start, uint8_t *CC_ID, uint8_t *Ant_ID, uint8_t *frame_id, uint8_t *subframe_id, uint8_t *slot_id, uint8_t *symb_id, struct ecpri_seq_id *seq_id, uint16_t *num_prbu, uint16_t *start_prbu, uint16_t *sym_inc, uint16_t *rb, uint16_t *sect_id, int8_t expect_comp, uint8_t *compMeth, uint8_t *iqWidth)
Function extracts IQ samples from received mbuf packet.
Definition: xran_up_api.c:327
-
radio_app_common_hdr
Definition: xran_pkt.h:162
-
xran_prepare_iq_symbol_portion
int xran_prepare_iq_symbol_portion(struct rte_mbuf *mbuf, const void *iq_data_start, const enum xran_input_byte_order iq_buf_byte_order, const uint32_t iq_data_num_bytes, struct xran_up_pkt_gen_params *params, uint8_t CC_ID, uint8_t Ant_ID, uint8_t seq_id, uint32_t do_copy)
Function for starting preparion of IQ samples portions to be sent in xRAN packet. ...
Definition: xran_up_api.c:455
-
xran_up_pkt_gen_params::compr_hdr_param
struct data_section_compression_hdr compr_hdr_param
Definition: xran_up_api.h:49
-
- -
-Generated by   -doxygen - 1.8.13 -
- -