common_lib.h 16.1 KB
Newer Older
1 2 3 4 5
/*
 * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The OpenAirInterface Software Alliance licenses this file to You under
6
 * the OAI Public License, Version 1.1  (the "License"); you may not use this file
7 8 9 10 11 12 13 14 15 16 17 18 19 20
 * except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.openairinterface.org/?page_id=698
 *
 * 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.
 *-------------------------------------------------------------------------------
 * For more information about the OpenAirInterface (OAI) Software Alliance:
 *      contact@openairinterface.org
 */
21

22 23
/*! \file common_lib.h
 * \brief common APIs for different RF frontend device
24 25 26 27 28 29 30 31
 * \author HongliangXU, Navid Nikaein
 * \date 2015
 * \version 0.2
 * \company Eurecom
 * \maintainer:  navid.nikaein@eurecom.fr
 * \note
 * \warning
 */
32

Raymond Knopp's avatar
 
Raymond Knopp committed
33 34 35
#ifndef COMMON_LIB_H
#define COMMON_LIB_H
#include <stdint.h>
36
#include <sys/types.h>
37
#include <openair1/PHY/TOOLS/tools_defs.h>
Raymond Knopp's avatar
 
Raymond Knopp committed
38

39
/* name of shared library implementing the radio front end */
40
#define OAI_RF_LIBNAME        "oai_device"
41
/* name of shared library implementing the transport */
42
#define OAI_TP_LIBNAME        "oai_transpro"
43
/* name of shared library implementing the basic/rf simulator */
44
#define OAI_RFSIM_LIBNAME     "rfsimulator"
45
/* name of shared library implementing the basic/rf simulator */
46
#define OAI_BASICSIM_LIBNAME  "tcp_bridge_oai"
47
/* flags for BBU to determine whether the attached radio head is local or remote */
48 49
#define RAU_LOCAL_RADIO_HEAD  0
#define RAU_REMOTE_RADIO_HEAD 1
50

51
#ifndef MAX_CARDS
52
  #define MAX_CARDS 8
53
#endif
54

Raymond Knopp's avatar
 
Raymond Knopp committed
55
typedef int64_t openair0_timestamp;
56
typedef volatile int64_t openair0_vtimestamp;
57

58

Rohit Gupta's avatar
Rohit Gupta committed
59
/*!\brief structrue holds the parameters to configure USRP devices*/
Raymond Knopp's avatar
 
Raymond Knopp committed
60
typedef struct openair0_device_t openair0_device;
61

62
//#define USRP_GAIN_OFFSET (56.0)  // 86 calibrated for USRP B210 @ 2.6 GHz to get equivalent RS EPRE in OAI to SMBV100 output
Raymond Knopp's avatar
 
Raymond Knopp committed
63

Raymond Knopp's avatar
 
Raymond Knopp committed
64 65 66 67
typedef enum {
  max_gain=0,med_gain,byp_gain
} rx_gain_t;

laurent's avatar
laurent committed
68 69 70
#if OCP_FRAMEWORK
#include <enums.h>
#else
71 72 73
typedef enum {
  duplex_mode_TDD=1,duplex_mode_FDD=0
} duplex_mode_t;
laurent's avatar
laurent committed
74
#endif
75

76

77
/** @addtogroup _GENERIC_PHY_RF_INTERFACE_
78 79
 * @{
 */
80 81 82 83 84 85 86 87 88 89 90 91
/*!\brief RF device types
 */
typedef enum {
  MIN_RF_DEV_TYPE = 0,
  /*!\brief device is ExpressMIMO */
  EXMIMO_DEV,
  /*!\brief device is USRP B200/B210*/
  USRP_B200_DEV,
  /*!\brief device is USRP X300/X310*/
  USRP_X300_DEV,
  /*!\brief device is BLADE RF*/
  BLADERF_DEV,
92 93
  /*!\brief device is LMSSDR (SoDeRa)*/
  LMSSDR_DEV,
94 95
  /*!\brief device is Iris */
  IRIS_DEV,
96 97
  /*!\brief device is NONE*/
  NONE_DEV,
root's avatar
root committed
98 99 100 101
  /*!\brief device is ADRV9371_ZC706 */
  ADRV9371_ZC706_DEV,
  /*!\brief device is UEDv2 */
  UEDv2_DEV,
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  MAX_RF_DEV_TYPE
} dev_type_t;

/*!\brief transport protocol types
 */
typedef enum {
  MIN_TRANSP_TYPE = 0,
  /*!\brief transport protocol ETHERNET */
  ETHERNET_TP,
  /*!\brief no transport protocol*/
  NONE_TP,
  MAX_TRANSP_TYPE
} transport_type_t;


/*!\brief  openair0 device host type */
typedef enum {
  MIN_HOST_TYPE = 0,
120
  /*!\brief device functions within a RAU */
121
  RAU_HOST,
122
  /*!\brief device functions within a RRU */
123
  RRU_HOST,
124
  MAX_HOST_TYPE
125
} host_type_t;
126

Rohit Gupta's avatar
Rohit Gupta committed
127

128
/*! \brief RF Gain clibration */
129 130 131 132 133 134
typedef struct {
  //! Frequency for which RX chain was calibrated
  double freq;
  //! Offset to be applied to RX gain
  double offset;
} rx_gain_calib_table_t;
Raymond Knopp's avatar
 
Raymond Knopp committed
135

136 137
/*! \brief Clock source types */
typedef enum {
138 139
  //! this means the paramter has not been set
  unset=-1,
140 141 142
  //! This tells the underlying hardware to use the internal reference
  internal=0,
  //! This tells the underlying hardware to use the external reference
143 144 145
  external=1,
  //! This tells the underlying hardware to use the gpsdo reference
  gpsdo=2
146 147
} clock_source_t;

Rohit Gupta's avatar
Rohit Gupta committed
148
/*! \brief RF frontend parameters set by application */
Raymond Knopp's avatar
 
Raymond Knopp committed
149
typedef struct {
150
  //! Module ID for this configuration
151
  int Mod_id;
Rohit Gupta's avatar
Rohit Gupta committed
152
  //! device log level
153
  int log_level;
154 155
  //! duplexing mode
  duplex_mode_t duplex_mode;
156 157
  //! number of downlink resource blocks
  int num_rb_dl;
158
  //! number of samples per frame
159
  unsigned int  samples_per_frame;
160
  //! the sample rate for both transmit and receive.
Raymond Knopp's avatar
 
Raymond Knopp committed
161
  double sample_rate;
162 163
  //! flag to indicate that the device is doing mmapped DMA transfers
  int mmapped_dma;
164 165
  //! offset in samples between TX and RX paths
  int tx_sample_advance;
166
  //! samples per packet on the fronthaul interface
167
  int samples_per_packet;
168
  //! number of RX channels (=RX antennas)
Raymond Knopp's avatar
 
Raymond Knopp committed
169
  int rx_num_channels;
170
  //! number of TX channels (=TX antennas)
Raymond Knopp's avatar
 
Raymond Knopp committed
171
  int tx_num_channels;
Raymond Knopp's avatar
Raymond Knopp committed
172
  //! \brief RX base addresses for mmapped_dma
173
  int32_t *rxbase[4];
Raymond Knopp's avatar
Raymond Knopp committed
174
  //! \brief TX base addresses for mmapped_dma
175
  int32_t *txbase[4];
176 177
  //! \brief Center frequency in Hz for RX.
  //! index: [0..rx_num_channels[
Raymond Knopp's avatar
 
Raymond Knopp committed
178
  double rx_freq[4];
179 180
  //! \brief Center frequency in Hz for TX.
  //! index: [0..rx_num_channels[ !!! see lte-ue.c:427 FIXME iterates over rx_num_channels
Raymond Knopp's avatar
 
Raymond Knopp committed
181
  double tx_freq[4];
182
  //! \brief memory
183 184
  //! \brief Pointer to Calibration table for RX gains
  rx_gain_calib_table_t *rx_gain_calib_table;
185
  //! mode for rxgain (ExpressMIMO2)
Raymond Knopp's avatar
 
Raymond Knopp committed
186
  rx_gain_t rxg_mode[4];
187
  //! \brief Gain for RX in dB.
188
  //! index: [0..rx_num_channels]
Raymond Knopp's avatar
 
Raymond Knopp committed
189
  double rx_gain[4];
190 191 192
  //! \brief Gain offset (for calibration) in dB
  //! index: [0..rx_num_channels]
  double rx_gain_offset[4];
193
  //! gain for TX in dB
Raymond Knopp's avatar
 
Raymond Knopp committed
194
  double tx_gain[4];
195
  //! RX bandwidth in Hz
Raymond Knopp's avatar
 
Raymond Knopp committed
196
  double rx_bw;
197
  //! TX bandwidth in Hz
Raymond Knopp's avatar
 
Raymond Knopp committed
198
  double tx_bw;
199
  //! clock source
200
  clock_source_t clock_source;
201
  //! timing_source
202
  clock_source_t time_source;
203
  //! Manual SDR IP address
204
  //#if defined(EXMIMO) || defined(OAI_USRP) || defined(OAI_BLADERF) || defined(OAI_LMSSDR)
205
  char *sdr_addrs;
206 207
  //! Auto calibration flag
  int autocal[4];
208
  //! rf devices work with x bits iqs when oai have its own iq format
209
  //! the two following parameters are used to convert iqs
210 211
  int iq_txshift;
  int iq_rxrescale;
212 213
  //! Configuration file for LMS7002M
  char *configFilename;
214 215 216 217 218 219 220 221
  //! remote IP/MAC addr for Ethernet interface
  char *remote_addr;
  //! remote port number for Ethernet interface
  unsigned int remote_port;
  //! local IP/MAC addr for Ethernet interface (eNB/BBU, UE)
  char *my_addr;
  //! local port number for Ethernet interface (eNB/BBU, UE)
  unsigned int my_port;
222 223 224 225 226 227 228 229
#if defined(USRP_REC_PLAY)
  unsigned short sf_mode;           // 1=record, 2=replay
  char           sf_filename[1024]; // subframes file path
  unsigned int   sf_max;            // max number of recorded subframes
  unsigned int   sf_loops;          // number of loops in replay mode
  unsigned int   sf_read_delay;     // read delay in replay mode
  unsigned int   sf_write_delay;    // write delay in replay mode
  unsigned int   eth_mtu;           // ethernet MTU
230
#endif
root's avatar
root committed
231 232 233 234 235 236
  //! number of samples per tti
  unsigned int  samples_per_tti;
  //! the sample rate for receive.
  double rx_sample_rate;
  //! the sample rate for transmit.
  double tx_sample_rate;
237 238
  //! check for threequarter sampling rate
  int8_t threequarter_fs;
Raymond Knopp's avatar
 
Raymond Knopp committed
239 240
} openair0_config_t;

241
/*! \brief RF mapping */
242
typedef struct {
Rohit Gupta's avatar
Rohit Gupta committed
243
  //! card id
244
  int card;
Rohit Gupta's avatar
Rohit Gupta committed
245
  //! rf chain id
246 247 248 249
  int chain;
} openair0_rf_map;


250 251
typedef struct {
  char *remote_addr;
252 253 254 255
  //! remote port number for Ethernet interface (control)
  uint16_t remote_portc;
  //! remote port number for Ethernet interface (user)
  uint16_t remote_portd;
256
  //! local IP/MAC addr for Ethernet interface (eNB/RAU, UE)
257
  char *my_addr;
258 259 260 261
  //! local port number (control) for Ethernet interface (eNB/RAU, UE)
  uint16_t  my_portc;
  //! local port number (user) for Ethernet interface (eNB/RAU, UE)
  uint16_t  my_portd;
262
  //! local Ethernet interface (eNB/RAU, UE)
263
  char *local_if_name;
264
  //! transport type preference  (RAW/UDP)
265
  uint8_t transp_preference;
266 267
  //! compression enable (0: No comp/ 1: A-LAW)
  uint8_t if_compress;
268
} eth_params_t;
269

270
typedef struct {
271 272
  //! Tx buffer for if device, keep one per subframe now to allow multithreading
  void *tx[10];
273 274
  //! Tx buffer (PRACH) for if device
  void *tx_prach;
275 276 277 278
  //! Rx buffer for if device
  void *rx;
} if_buffer_t;

279
/*!\brief structure holds the parameters to configure USRP devices */
Raymond Knopp's avatar
 
Raymond Knopp committed
280
struct openair0_device_t {
281
  /*!brief Module ID of this device */
282
  int Mod_id;
283 284 285

  /*!brief Component Carrier ID of this device */
  int CC_id;
286

287
  /*!brief Type of this device */
288 289
  dev_type_t type;

290 291 292
  /*!brief Transport protocol type that the device suppports (in case I/Q samples need to be transported) */
  transport_type_t transp_type;

293
  /*!brief Type of the device's host (RAU/RRU) */
294
  host_type_t host_type;
295

Aikaterini's avatar
Aikaterini committed
296
  /* !brief RF frontend parameters set by application */
297
  openair0_config_t *openair0_cfg;
298

299 300 301
  /* !brief ETH params set by application */
  eth_params_t *eth_params;

302 303 304 305
  /* !brief Indicates if device already initialized */
  int is_init;


306
  /*!brief Can be used by driver to hold internal structure*/
Raymond Knopp's avatar
 
Raymond Knopp committed
307 308 309 310
  void *priv;

  /* Functions API, which are called by the application*/

311 312 313
  /*! \brief Called to start the transceiver. Return 0 if OK, < 0 if error
      @param device pointer to the device structure specific to the RF hardware target
  */
Raymond Knopp's avatar
 
Raymond Knopp committed
314 315
  int (*trx_start_func)(openair0_device *device);

316 317 318 319 320 321 322
 /*! \brief Called to configure the device
      @param device pointer to the device structure specific to the RF hardware target  
  */


  int (*trx_config_func)(openair0_device* device, openair0_config_t *openair0_cfg);

323
  /*! \brief Called to send a request message between RAU-RRU on control port
324
      @param device pointer to the device structure specific to the RF hardware target
325
      @param msg pointer to the message structure passed between RAU-RRU
326 327
      @param msg_len length of the message
  */
328
  int (*trx_ctlsend_func)(openair0_device *device, void *msg, ssize_t msg_len);
329

330
  /*! \brief Called to receive a reply  message between RAU-RRU on control port
331
      @param device pointer to the device structure specific to the RF hardware target
332
      @param msg pointer to the message structure passed between RAU-RRU
333 334
      @param msg_len length of the message
  */
335
  int (*trx_ctlrecv_func)(openair0_device *device, void *msg, ssize_t msg_len);
336

337 338
  /*! \brief Called to send samples to the RF target
      @param device pointer to the device structure specific to the RF hardware target
339
      @param timestamp The timestamp at whicch the first sample MUST be sent
340 341 342 343
      @param buff Buffer which holds the samples
      @param nsamps number of samples to be sent
      @param antenna_id index of the antenna if the device has multiple anteannas
      @param flags flags must be set to TRUE if timestamp parameter needs to be applied
344
  */
345
  int (*trx_write_func)(openair0_device *device, openair0_timestamp timestamp, void **buff, int nsamps,int antenna_id, int flags);
Raymond Knopp's avatar
 
Raymond Knopp committed
346

347 348
  /*! \brief Receive samples from hardware.
   * Read \ref nsamps samples from each channel to buffers. buff[0] is the array for
Raymond Knopp's avatar
 
Raymond Knopp committed
349 350
   * the first channel. *ptimestamp is the time at which the first sample
   * was received.
351 352
   * \param device the hardware to use
   * \param[out] ptimestamp the time at which the first sample was received.
Rohit Gupta's avatar
Rohit Gupta committed
353
   * \param[out] buff An array of pointers to buffers for received samples. The buffers must be large enough to hold the number of samples \ref nsamps.
354
   * \param nsamps Number of samples. One sample is 2 byte I + 2 byte Q => 4 byte.
Rohit Gupta's avatar
Rohit Gupta committed
355
   * \param antenna_id Index of antenna for which to receive samples
356 357
   * \returns the number of sample read
   */
358 359
  int (*trx_read_func)(openair0_device *device, openair0_timestamp *ptimestamp, void **buff, int nsamps,int antenna_id);

360
  /*! \brief print the device statistics
361 362 363 364 365
   * \param device the hardware to use
   * \returns  0 on success
   */
  int (*trx_get_stats_func)(openair0_device *device);

366
  /*! \brief Reset device statistics
367
   * \param device the hardware to use
368
   * \returns 0 in success
369 370
   */
  int (*trx_reset_stats_func)(openair0_device *device);
Raymond Knopp's avatar
 
Raymond Knopp committed
371

372
  /*! \brief Terminate operation of the transceiver -- free all associated resources
Rohit Gupta's avatar
Rohit Gupta committed
373 374
   * \param device the hardware to use
   */
Raymond Knopp's avatar
 
Raymond Knopp committed
375
  void (*trx_end_func)(openair0_device *device);
376

377
  /*! \brief Stop operation of the transceiver
Rohit Gupta's avatar
Rohit Gupta committed
378
   */
379
  int (*trx_stop_func)(openair0_device *device);
380 381 382

  /* Functions API related to UE*/

383
  /*! \brief Set RX feaquencies
Rohit Gupta's avatar
Rohit Gupta committed
384 385
   * \param device the hardware to use
   * \param openair0_cfg RF frontend parameters set by application
386 387
   * \param exmimo_dump_config  dump EXMIMO configuration
   * \returns 0 in success
388
   */
389 390
  int (*trx_set_freq_func)(openair0_device *device, openair0_config_t *openair0_cfg,int exmimo_dump_config);

391
  /*! \brief Set gains
Rohit Gupta's avatar
Rohit Gupta committed
392 393
   * \param device the hardware to use
   * \param openair0_cfg RF frontend parameters set by application
394
   * \returns 0 in success
395
   */
396
  int (*trx_set_gains_func)(openair0_device *device, openair0_config_t *openair0_cfg);
397

398 399 400 401
  /*! \brief RRU Configuration callback
   * \param idx RU index
   * \param arg pointer to capabilities or configuration
   */
402
  void (*configure_rru)(int idx, void *arg);
403 404 405 406

  /*! \brief set UHD thread priority
   */
  void (*uhd_set_thread_priority)(void);
Raymond Knopp's avatar
 
Raymond Knopp committed
407 408
};

409
/* type of device init function, implemented in shared lib */
410 411
typedef int(*oai_device_initfunc_t)(openair0_device *device, openair0_config_t *openair0_cfg);
/* type of transport init function, implemented in shared lib */
412
typedef int(*oai_transport_initfunc_t)(openair0_device *device, openair0_config_t *openair0_cfg, eth_params_t *eth_params);
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
#define UE_MAGICDL_FDD 0xA5A5A5A5A5A5A5A5  // UE DL FDD record
#define UE_MAGICUL_FDD 0x5A5A5A5A5A5A5A5A  // UE UL FDD record
#define UE_MAGICDL_TDD 0xA6A6A6A6A6A6A6A6  // UE DL TDD record
#define UE_MAGICUL_TDD 0x6A6A6A6A6A6A6A6A  // UE UL TDD record

#define ENB_MAGICDL_FDD 0xB5B5B5B5B5B5B5B5  // eNB DL FDD record
#define ENB_MAGICUL_FDD 0x5B5B5B5B5B5B5B5B  // eNB UL FDD record
#define ENB_MAGICDL_TDD 0xB6B6B6B6B6B6B6B6  // eNB DL TDD record
#define ENB_MAGICUL_TDD 0x6B6B6B6B6B6B6B6B  // eNB UL TDD record

#define OPTION_LZ4  0x00000001          // LZ4 compression (option_value is set to compressed size)


typedef struct {
  uint64_t magic;          // Magic value (see defines above)
  uint32_t size;           // Number of samples per antenna to follow this header
  uint32_t nbAnt;          // Total number of antennas following this header
  // Samples per antenna follow this header,
  // i.e. nbAnt = 2 => this header+samples_antenna_0+samples_antenna_1
  // data following this header in bytes is nbAnt*size*sizeof(sample_t)
  uint64_t timestamp;      // Timestamp value of first sample
  uint32_t option_value;   // Option value
  uint32_t option_flag;    // Option flag
} samplesBlockHeader_t;
Raymond Knopp's avatar
 
Raymond Knopp committed
437

438 439 440 441 442 443 444 445 446 447 448 449
#define UE_MAGICDL_FDD 0xA5A5A5A5A5A5A5A5  // UE DL FDD record
#define UE_MAGICUL_FDD 0x5A5A5A5A5A5A5A5A  // UE UL FDD record
#define UE_MAGICDL_TDD 0xA6A6A6A6A6A6A6A6  // UE DL TDD record
#define UE_MAGICUL_TDD 0x6A6A6A6A6A6A6A6A  // UE UL TDD record

#define ENB_MAGICDL_FDD 0xB5B5B5B5B5B5B5B5  // eNB DL FDD record
#define ENB_MAGICUL_FDD 0x5B5B5B5B5B5B5B5B  // eNB UL FDD record
#define ENB_MAGICDL_TDD 0xB6B6B6B6B6B6B6B6  // eNB DL TDD record
#define ENB_MAGICUL_TDD 0x6B6B6B6B6B6B6B6B  // eNB UL TDD record

#define OPTION_LZ4  0x00000001          // LZ4 compression (option_value is set to compressed size)

Raymond Knopp's avatar
 
Raymond Knopp committed
450 451 452
#ifdef __cplusplus
extern "C"
{
453 454
#endif

455 456 457 458
/*! \brief Initialize openair RF target. It returns 0 if OK */
int openair0_device_load(openair0_device *device, openair0_config_t *openair0_cfg);
/*! \brief Initialize transport protocol . It returns 0 if OK */
int openair0_transport_load(openair0_device *device, openair0_config_t *openair0_cfg, eth_params_t *eth_params);
459

460

461 462 463 464 465 466 467 468 469 470 471
/*! \brief Get current timestamp of USRP
 * \param device the hardware to use
 */
openair0_timestamp get_usrp_time(openair0_device *device);

/*! \brief Set RX frequencies
 * \param device the hardware to use
 * \param openair0_cfg RF frontend parameters set by application
 * \returns 0 in success
 */
int openair0_set_rx_frequencies(openair0_device *device, openair0_config_t *openair0_cfg);
Rohit Gupta's avatar
Rohit Gupta committed
472

laurent's avatar
laurent committed
473
#define gettid() syscall(__NR_gettid)
474
/*@}*/
475

476

477

478
#ifdef __cplusplus
Raymond Knopp's avatar
 
Raymond Knopp committed
479 480 481
}
#endif

Raymond Knopp's avatar
 
Raymond Knopp committed
482
#endif // COMMON_LIB_H
483