PentHertz
/
srsLTE
mirror of https://github.com/PentHertz/srsLTE.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
srsLTE/lib/include/srslte/phy/phch/ra_nbiot.h

287 lines
11 KiB
C
Raw Normal View History

adding NB-IoT DL channel estamiation and NPBCH code
2019-10-24 08:53:09 -07:00
/*
* Copyright 2013-2019 Software Radio Systems Limited
*
* This file is part of srsLTE.
*
* srsLTE is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version.
*
* srsLTE is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* A copy of the GNU Affero General Public License can be found in
* the LICENSE file in the top-level directory of this distribution
* and at http://www.gnu.org/licenses/.
*
*/
/**
* \brief Structures and utility functions for DL/UL resource allocation for NB-IoT.
*
* Reference: 3GPP TS 36.213 version 13.2.0 Release 13
*/
#ifndef SRSLTE_RA_NBIOT_H
#define SRSLTE_RA_NBIOT_H
#include <stdbool.h>
#include <stdint.h>
#include "srslte/config.h"
#include "srslte/phy/common/phy_common.h"
#include "srslte/phy/phch/npbch.h"
#include "srslte/phy/phch/ra.h"
#define SRSLTE_NPUSCH_MAX_SC 12
#define SRSLTE_NPUSCH_MAX_SLOTS (16 * SRSLTE_NPUSCH_N_RU_MAX)
#define SRSLTE_NPUSCH_MAX_SF (SRSLTE_NPUSCH_MAX_SLOTS / 2)
#define SRSLTE_NPUSCH_N_REP_MAX 128
#define SRSLTE_NPUSCH_N_RU_MAX 10
#define SRSLTE_NPUSCH_MAX_NOF_RU_SLOTS_PROD 24
#define SRSLTE_NPUSCH_FORMAT2_MAX_SLOTS 4
#define DUMMY_R_MAX 64
#define SIB1_NB_TTI 256
#define SIB1_NB_MAX_REP 16
/// All System Information types defined for NB-IoT
typedef enum SRSLTE_API {
SRSLTE_NBIOT_SI_TYPE_MIB = 0, ///< Essential information required to receive further sys information
SRSLTE_NBIOT_SI_TYPE_SIB1, ///< Cell access and selection, other SIB scheduling
SRSLTE_NBIOT_SI_TYPE_SIB2, ///< Radio resource configuration information
SRSLTE_NBIOT_SI_TYPE_SIB3, ///< Cell re-selection information for intra-frequency, inter-frequency
SRSLTE_NBIOT_SI_TYPE_SIB4, ///< Neighboring cell related information relevant for intra-frequency cell re-selection
SRSLTE_NBIOT_SI_TYPE_SIB5, ///< Neighboring cell related information relevant for inter-frequency cell re-selection
SRSLTE_NBIOT_SI_TYPE_SIB14, ///< Access Barring parameters
SRSLTE_NBIOT_SI_TYPE_SIB16, ///< Information related to GPS time and Coordinated Universal Time (UTC)
SRSLTE_NBIOT_SI_TYPE_NITEMS
} srslte_nbiot_si_type_t;
typedef struct SRSLTE_API {
bool has_sib1; ///< Whether this NPDSCH carries SystemInformationBlockType1-NB
bool is_ra; ///< Order is set to 1 for random access procedure
uint32_t nprach_start; ///< Starting number for NPRACH repetitions
uint32_t nprach_sc; ///< Subcarrier indication of NPRACH
uint32_t i_delay; ///< Scheduling delay
uint32_t i_sf; ///< Resource assignment, i.e. number of subframes
uint32_t i_rep; ///< Repetition number
uint32_t i_n_start; ///< The starting OFDM symbol signalled through RRC
uint32_t harq_ack; ///< HARQ-ACK resource
uint32_t dci_sf_rep_num; ///< DCI subframe repetition number
uint32_t sched_info_sib1; ///< broadcasted through MIB-NB for TBS calculation
} srslte_ra_nbiot_t;
/// This shall be replaced/moved by proper structures and packing/unpacking based on ASN1
typedef struct SRSLTE_API {
uint32_t n; ///< Index of entry in schedulingInfoList
uint32_t si_periodicity;
uint32_t si_radio_frame_offset;
uint32_t si_repetition_pattern;
uint32_t si_tb;
uint32_t si_window_length;
} srslte_nbiot_si_params_t;
typedef enum SRSLTE_API {
SRSLTE_NPUSCH_FORMAT1 = 0,
SRSLTE_NPUSCH_FORMAT2,
SRSLTE_NPUSCH_FORMAT_NITEMS
} srslte_npusch_format_t;
static const char srslte_npusch_format_text[SRSLTE_NPUSCH_FORMAT_NITEMS][20] = {"Format 1 (UL-SCH)", "Format 2 (UCI)"};
typedef enum SRSLTE_API {
SRSLTE_NPUSCH_SC_SPACING_15000 = 0,
SRSLTE_NPUSCH_SC_SPACING_3750 = 1,
SRSLTE_NPUSCH_SC_SPACING_NITEMS
} srslte_npusch_sc_spacing_t;
static const char srslte_npusch_sc_spacing_text[SRSLTE_NPUSCH_SC_SPACING_NITEMS][20] = {"15kHz", "3.75kHz"};
/**************************************************
* Structures used for Downlink Resource Allocation
**************************************************/
typedef struct SRSLTE_API {
uint32_t Qm;
srslte_ra_tb_t mcs[SRSLTE_MAX_TB];
uint32_t start_hfn;
uint32_t start_sfn;
uint32_t start_sfidx;
uint32_t k0;
uint32_t nof_sf;
uint32_t nof_rep;
uint32_t l_start;
uint32_t ack_nack_resource;
srslte_nbiot_mode_t mode; ///< needed to compute starting symbol for NPDSCH
bool has_sib1;
} srslte_ra_nbiot_dl_grant_t;
/// Unpacked DCI message for DL grant
typedef struct SRSLTE_API {
uint32_t format; ///< Flag for format N0/format N1 differentiation – 1 bit, 0 for format N0 and value 1 for format N1
srslte_ra_nbiot_t alloc;
uint32_t mcs_idx;
int rv_idx;
bool ndi;
// Format N2 specifics
bool dci_is_n2;
uint8_t dir_indication_info;
} srslte_ra_nbiot_dl_dci_t;
/// Structures used for Uplink Resource Allocation
/// Unpacked DCI message
typedef struct SRSLTE_API {
srslte_npusch_sc_spacing_t sc_spacing;
uint32_t format; ///< Flag for format N0/format N1 differentiation – 1 bit, 0 for format N0 and value 1 for format N1
uint32_t i_sc; ///< Subcarrier indication field
uint32_t i_delay; ///< Scheduling delay
uint32_t i_ru; ///< Resource assignment, i.e. number of resource units
uint32_t i_mcs; ///< MCS field
uint32_t i_rv; ///< Redundency version
uint32_t i_rep; ///< Repetition number
bool ndi; ///< New data indicator
uint32_t dci_sf_rep_num; ///< DCI subframe repetition number
} srslte_ra_nbiot_ul_dci_t;
typedef struct SRSLTE_API {
uint32_t Qm;
srslte_ra_tb_t mcs;
uint32_t k0; ///< FIXME: consider removing k0 and compute tx_tti directly
uint32_t nof_rep; ///< number of repetitions
uint32_t nof_ru; ///< Number of resource units
uint32_t nof_slots;
uint32_t nof_sc; ///< The total number of Subcarriers (N_sc_RU)
uint32_t sc_alloc_set[SRSLTE_NPUSCH_MAX_SC]; ///< The set of subcarriers
uint32_t rv_idx;
uint32_t tx_tti;
srslte_npusch_sc_spacing_t sc_spacing;
srslte_npusch_format_t format;
} srslte_ra_nbiot_ul_grant_t;
typedef union {
srslte_ra_nbiot_ul_grant_t ul;
srslte_ra_nbiot_dl_grant_t dl;
} srslte_nbiot_phy_grant_t;
#define SRSLTE_NBIOT_PHY_GRANT_LEN sizeof(srslte_nbiot_phy_grant_t)
/// Structure that gives the number of encoded bits and RE for a UL/DL grant
typedef struct {
uint32_t lstart;
uint32_t nof_symb;
uint32_t nof_bits;
uint32_t nof_re;
} srslte_ra_nbits_t;
/// According to Section 16.3.3 in TS 36.213 v13.3
typedef struct SRSLTE_API {
uint32_t sc_spacing; ///< SC spacing (1bit)
uint32_t i_sc; ///< Subcarrier indication field (6bits)
uint32_t i_delay; ///< Scheduling delay (2bits)
uint32_t n_rep; ///< Repetition number (3bits) (Is this i_rep or N_rep?)
uint32_t i_mcs; ///< MCS field (3bits), according to 16.3.3-1
} srslte_nbiot_dci_rar_grant_t;
/// Functions
SRSLTE_API int srslte_ra_nbiot_dl_dci_to_grant(srslte_ra_nbiot_dl_dci_t* dci,
uint16_t msg_rnti,
srslte_ra_nbiot_dl_grant_t* grant,
uint32_t sfn,
uint32_t sf_idx,
uint32_t r_max,
bool is_prescheduled,
srslte_nbiot_mode_t mode);
SRSLTE_API void srslte_ra_nbiot_dl_grant_to_nbits(srslte_ra_nbiot_dl_grant_t* grant,
srslte_nbiot_cell_t cell,
uint32_t sf_idx,
srslte_ra_nbits_t* nbits);
SRSLTE_API void
srslte_ra_nbiot_ul_get_uci_grant(srslte_ra_nbiot_ul_grant_t* grant, const uint8_t resource_field, const uint32_t tti);
SRSLTE_API int srslte_ra_nbiot_ul_dci_to_grant(srslte_ra_nbiot_ul_dci_t* dci,
srslte_ra_nbiot_ul_grant_t* grant,
uint32_t rx_tti,
srslte_npusch_sc_spacing_t spacing);
SRSLTE_API void srslte_ra_nbiot_ul_grant_to_nbits(srslte_ra_nbiot_ul_grant_t* grant, srslte_ra_nbits_t* nbits);
SRSLTE_API int
srslte_ra_nbiot_ul_rar_dci_to_grant(srslte_ra_nbiot_ul_dci_t* dci, srslte_ra_nbiot_ul_grant_t* grant, uint32_t rx_tti);
SRSLTE_API void srslte_ra_npdsch_fprint(FILE* f, srslte_ra_nbiot_dl_dci_t* ra, uint32_t nof_prb);
SRSLTE_API void srslte_ra_npusch_fprint(FILE* f, srslte_ra_nbiot_ul_dci_t* dci);
SRSLTE_API void srslte_nbiot_dl_dci_fprint(FILE* f, srslte_ra_nbiot_dl_dci_t* dci);
/*!
* Checks if TTI contains reference signal
* In safe mode only those subframes that are guaranteed to contain
* NRS are considered.
*
* \param tti the TTI in question
* \return true if TTI contains DL ref signal
*/
SRSLTE_API bool srslte_ra_nbiot_dl_has_ref_signal(uint32_t tti);
/*!
* Checks if TTI contains reference signal for standalone deployment
*
* \param tti the TTI in question
* \return true if TTI contains DL ref signal
*/
SRSLTE_API bool srslte_ra_nbiot_dl_has_ref_signal_standalone(uint32_t tti);
/*!
* Checks if TTI contains reference signal for inband deployments
*
* \param tti the TTI in question
* \return true if TTI contains DL ref signal
*/
SRSLTE_API bool srslte_ra_nbiot_dl_has_ref_signal_inband(uint32_t tti);
/*!
* Checks if TTI is a valid downlink TTI, i.e., can carry either a NPDCCH or NPDSCH
*
* \param tti the TTI in question
* \return true if TTI is valid DL TTI
*/
SRSLTE_API bool srslte_ra_nbiot_is_valid_dl_sf(uint32_t tti);
/*!
* Calculate the number of resource elements per subframe that carry data
*
* \param cell the cell structure
* \param l_start the starting OFDM symbols that carries data
* \return the number of resource elements
*/
SRSLTE_API uint32_t srslte_ra_nbiot_dl_grant_nof_re(srslte_nbiot_cell_t cell, uint32_t l_start);
SRSLTE_API void srslte_ra_nbiot_dl_grant_fprint(FILE* f, srslte_ra_nbiot_dl_grant_t* grant);
SRSLTE_API void srslte_ra_nbiot_ul_grant_fprint(FILE* f, srslte_ra_nbiot_ul_grant_t* grant);
SRSLTE_API int srslte_ra_n_rep_sib1_nb(srslte_mib_nb_t* mib);
SRSLTE_API int srslte_ra_nbiot_get_sib1_tbs(srslte_mib_nb_t* mib);
SRSLTE_API int srslte_ra_nbiot_get_npdsch_tbs(uint32_t i_tbs, uint32_t i_sf);
SRSLTE_API int srslte_ra_nbiot_get_npusch_tbs(uint32_t i_tbs, uint32_t i_ru);
SRSLTE_API int srslte_ra_nbiot_get_starting_sib1_frame(uint32_t cell_id, srslte_mib_nb_t* mib);
SRSLTE_API int srslte_ra_nbiot_sib1_start(uint32_t n_id_ncell, srslte_mib_nb_t* mib);
SRSLTE_API float srslte_ra_nbiot_get_delta_f(srslte_npusch_sc_spacing_t spacing);
#endif // SRSLTE_RA_NBIOT_H