X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2FAPI%2Fcommon_8h.html;fp=docs%2FAPI%2Fcommon_8h.html;h=40d72788ed09731fb3486d5377ac496ccb4ce749;hb=870e1b86b0c74169b215c166dee787c7c1a20d06;hp=0000000000000000000000000000000000000000;hpb=298022ce50fa8133cc880507170c4b7120d227b5;p=o-du%2Fphy.git
diff --git a/docs/API/common_8h.html b/docs/API/common_8h.html
new file mode 100644
index 0000000..40d7278
--- /dev/null
+++ b/docs/API/common_8h.html
@@ -0,0 +1,1507 @@
+
+
+
+
+
#include <stdio.h>
+
#include <unistd.h>
+
#include "xran_fh_o_du.h"
+
#include "xran_pkt_up.h"
+
#include <rte_common.h>
+
#include <rte_mbuf.h>
+
+
Go to the source code of this file.
+
+ |
+enum | app_state { APP_RUNNING,
+APP_STOPPED
+ } |
+ |
+enum | nRChBwOptions {
+ PHY_BW_5_0_MHZ = 5,
+PHY_BW_10_0_MHZ = 10,
+PHY_BW_15_0_MHZ = 15,
+PHY_BW_20_0_MHZ = 20,
+
+ PHY_BW_25_0_MHZ = 25,
+PHY_BW_30_0_MHZ = 30,
+PHY_BW_40_0_MHZ = 40,
+PHY_BW_50_0_MHZ = 50,
+
+ PHY_BW_60_0_MHZ = 60,
+PHY_BW_70_0_MHZ = 70,
+PHY_BW_80_0_MHZ = 80,
+PHY_BW_90_0_MHZ = 90,
+
+ PHY_BW_100_0_MHZ = 100,
+PHY_BW_200_0_MHZ = 200,
+PHY_BW_400_0_MHZ = 400
+
+ } |
+ |
+
+ |
+void | sys_save_buf_to_file_txt (char *filename, char *bufname, unsigned char *pBuffer, unsigned int size, unsigned int buffers_num) |
+ |
+void | sys_save_buf_to_file (char *filename, char *bufname, unsigned char *pBuffer, unsigned int size, unsigned int buffers_num) |
+ |
+int | sys_load_file_to_buff (char *filename, char *bufname, unsigned char *pBuffer, unsigned int size, unsigned int buffers_num) |
+ |
+uint32_t | app_xran_get_scs (uint8_t nMu) |
+ |
+uint16_t | app_xran_get_num_rbs (uint32_t nNumerology, uint32_t nBandwidth, uint32_t nAbsFrePointA) |
+ |
+uint32_t | app_xran_cal_nrarfcn (uint32_t nCenterFreq) |
+ |
+int32_t | app_xran_set_slot_type (uint32_t nPhyInstanceId, uint32_t nFrameDuplexType, uint32_t nTddPeriod, struct xran_slot_config *psSlotConfig) |
+ |
+uint32_t | app_xran_get_tti_interval (uint8_t nMu) |
+ |
+
+
+
+
◆ APP_O_DU
+
+
+
+
+
+ #define APP_O_DU 0 |
+
+
+
+
+
+
◆ APP_O_RU
+
+
+
+
+
+ #define APP_O_RU 1 |
+
+
+
+
+
+
◆ iAssert
+
+
+
+
+
+ #define iAssert |
+ ( |
+ |
+ p | ) |
+ |
+
+
+
+
+
+
◆ IQ_PLAYBACK_BUFFER_BYTES
+
+
+
+
◆ MAX_ANT_CARRIER_SUPPORTED
+
+
+
+
◆ MAX_ANT_CARRIER_SUPPORTED_CAT_B
+
+
+
+
◆ N_SC_PER_PRB
+
+
+
+
+
+ #define N_SC_PER_PRB 12 |
+
+
+
+
+
+
◆ N_SYM_PER_SLOT
+
+
+
+
+
+ #define N_SYM_PER_SLOT 14 |
+
+
+
+
+
+
◆ PRACH_PLAYBACK_BUFFER_BYTES
+
+
+
+
+
+ #define PRACH_PLAYBACK_BUFFER_BYTES (144*14*4L) |
+
+
+
+
+
+
◆ SUBFRAME_DURATION_US
+
+
+
+
+
+ #define SUBFRAME_DURATION_US 1000 |
+
+
+
+
+
+
◆ SUBFRAMES_PER_SYSTEMFRAME
+
+
+
+
+
+ #define SUBFRAMES_PER_SYSTEMFRAME 10 |
+
+
+
+
+
+
◆ VERSIONX
+
+
+
+
+
+ #define VERSIONX "#DIRTY#" |
+
+
+
+
+
+
+
◆ app_state
+
+
+
+
+Enumerator |
---|
APP_RUNNING | |
+APP_STOPPED | |
+
+
+
Definition at line 36 of file common.h.
+
+
+
+
+
◆ nRChBwOptions
+
+
+
+
+Enumerator |
---|
PHY_BW_5_0_MHZ | |
+PHY_BW_10_0_MHZ | |
+PHY_BW_15_0_MHZ | |
+PHY_BW_20_0_MHZ | |
+PHY_BW_25_0_MHZ | |
+PHY_BW_30_0_MHZ | |
+PHY_BW_40_0_MHZ | |
+PHY_BW_50_0_MHZ | |
+PHY_BW_60_0_MHZ | |
+PHY_BW_70_0_MHZ | |
+PHY_BW_80_0_MHZ | |
+PHY_BW_90_0_MHZ | |
+PHY_BW_100_0_MHZ | |
+PHY_BW_200_0_MHZ | |
+PHY_BW_400_0_MHZ | |
+
+
+
Definition at line 42 of file common.h.
+
+
+
+
+
+
◆ app_xran_cal_nrarfcn()
+
+
+
+
+
+ uint32_t app_xran_cal_nrarfcn |
+ ( |
+ uint32_t |
+ nCenterFreq | ) |
+ |
+
+
+
+
- Parameters
-
+
+
+
+
- Returns
- NR-ARFCN
+
This calculates NR-ARFCN value according to center frequency
+
+
Definition at line 338 of file common.c.
+
+
+
+
+
◆ app_xran_get_num_rbs()
+
+
+
+
+
+ uint16_t app_xran_get_num_rbs |
+ ( |
+ uint32_t |
+ nNumerology, |
+
+
+ |
+ |
+ uint32_t |
+ nBandwidth, |
+
+
+ |
+ |
+ uint32_t |
+ nAbsFrePointA |
+
+
+ |
+ ) |
+ | |
+
+
+
+
- Parameters
-
+
+ [in] | nNumerology | - Numerology determine sub carrier spacing, Value: 0->4 0: 15khz, 1: 30khz, 2: 60khz 3: 120khz, 4: 240khz |
+ [in] | nBandwidth | - Carrier bandwidth for in MHz. Value: 5->400 |
+ [in] | nAbsFrePointA | - Abs Freq Point A of the Carrier Center Frequency for in KHz Value: 450000->52600000 |
+
+
+
+
- Returns
- Number of RBs in cell
+
Returns number of RBs based on 38.101-1 and 38.101-2 for the cell
+
+
Definition at line 213 of file common.c.
+
+
+
+
+
◆ app_xran_get_scs()
+
+
+
+
+
+ uint32_t app_xran_get_scs |
+ ( |
+ uint8_t |
+ nMu | ) |
+ |
+
+
+
+
+
+
◆ app_xran_get_tti_interval()
+
+
+
+
+
+ uint32_t app_xran_get_tti_interval |
+ ( |
+ uint8_t |
+ nMu | ) |
+ |
+
+
+
+
+
+
◆ app_xran_set_slot_type()
+
+
+
+
+
+ int32_t app_xran_set_slot_type |
+ ( |
+ uint32_t |
+ nPhyInstanceId, |
+
+
+ |
+ |
+ uint32_t |
+ nFrameDuplexType, |
+
+
+ |
+ |
+ uint32_t |
+ nTddPeriod, |
+
+
+ |
+ |
+ struct xran_slot_config * |
+ psSlotConfig |
+
+
+ |
+ ) |
+ | |
+
+
+
+
+
+
◆ sys_load_file_to_buff()
+
+
+
+
+
+ int sys_load_file_to_buff |
+ ( |
+ char * |
+ filename, |
+
+
+ |
+ |
+ char * |
+ bufname, |
+
+
+ |
+ |
+ unsigned char * |
+ pBuffer, |
+
+
+ |
+ |
+ unsigned int |
+ size, |
+
+
+ |
+ |
+ unsigned int |
+ buffers_num |
+
+
+ |
+ ) |
+ | |
+
+
+
+
+
+
◆ sys_save_buf_to_file()
+
+
+
+
+
+ void sys_save_buf_to_file |
+ ( |
+ char * |
+ filename, |
+
+
+ |
+ |
+ char * |
+ bufname, |
+
+
+ |
+ |
+ unsigned char * |
+ pBuffer, |
+
+
+ |
+ |
+ unsigned int |
+ size, |
+
+
+ |
+ |
+ unsigned int |
+ buffers_num |
+
+
+ |
+ ) |
+ | |
+
+
+
+
+
+
◆ sys_save_buf_to_file_txt()
+
+
+
+
+
+ void sys_save_buf_to_file_txt |
+ ( |
+ char * |
+ filename, |
+
+
+ |
+ |
+ char * |
+ bufname, |
+
+
+ |
+ |
+ unsigned char * |
+ pBuffer, |
+
+
+ |
+ |
+ unsigned int |
+ size, |
+
+
+ |
+ |
+ unsigned int |
+ buffers_num |
+
+
+ |
+ ) |
+ | |
+
+
+
+
2 * 2 * 2
+
+
Definition at line 635 of file common.c.
+
+
+
+
+
+
+
+
◆ iq_bfw_buffer_size_dl
+
+
+
+
+
+ int iq_bfw_buffer_size_dl |
+
+
+
+
+
+
◆ iq_bfw_buffer_size_ul
+
+
+
+
+
+ int iq_bfw_buffer_size_ul |
+
+
+
+
+
+
◆ iq_playback_buffer_size_dl
+
+
+
+
+
+ int iq_playback_buffer_size_dl |
+
+
+
+
+
+
◆ iq_playback_buffer_size_ul
+
+
+
+
+
+ int iq_playback_buffer_size_ul |
+
+
+
+
+
+
◆ iq_srs_buffer_size_ul
+
+
+
+
+
+ int iq_srs_buffer_size_ul |
+
+
+
+
+
+
◆ num_eAxc
+
+
+
+
◆ numCCPorts
+
+
+
+
+
+ uint8_t numCCPorts |
+
+
+
+
+
+
◆ p_prach_log_buffer
+
+
+
+
◆ p_rx_buffer
+
+
+
+
◆ p_rx_dl_bfw_buffer
+
+
+
+
◆ p_rx_log_buffer
+
+
+
+
◆ p_rx_ul_bfw_buffer
+
+
+
+
◆ p_srs_log_buffer
+
+
+
+
◆ p_tx_buffer
+
+
+
+
◆ p_tx_dl_bfw_buffer
+
+
+
+
◆ p_tx_play_buffer
+
+
+
+
◆ p_tx_prach_play_buffer
+
+
+
+
◆ p_tx_srs_play_buffer
+
+
+
+
◆ p_tx_ul_bfw_buffer
+
+
+
+
◆ prach_log_buffer_position
+
+
+
+
◆ prach_log_buffer_size
+
+
+
+
◆ rx_buffer_size
+
+
+
+
◆ rx_dl_bfw_buffer_position
+
+
+
+
◆ rx_dl_bfw_buffer_size
+
+
+
+
◆ rx_log_buffer_position
+
+
+
+
◆ rx_log_buffer_size
+
+
+
+
◆ rx_ul_bfw_buffer_position
+
+
+
+
◆ rx_ul_bfw_buffer_size
+
+
+
+
◆ srs_log_buffer_position
+
+
+
+
◆ srs_log_buffer_size
+
+
+
+
◆ tx_buffer_size
+
+
+
+
◆ tx_dl_bfw_buffer_position
+
+
+
+
◆ tx_dl_bfw_buffer_size
+
+
+
+
◆ tx_play_buffer_position
+
+
+
+
◆ tx_play_buffer_size
+
+
+
+
◆ tx_prach_play_buffer_position
+
+
+
+
◆ tx_prach_play_buffer_size
+
+
+
+
◆ tx_srs_play_buffer_position
+
+
+
+
◆ tx_srs_play_buffer_size
+
+
+
+
◆ tx_ul_bfw_buffer_position
+
+
+
+
◆ tx_ul_bfw_buffer_size
+
+
+
+
+
+
+