mirror of
https://gitlab.eurecom.fr/oai/openairinterface5g.git
synced 2026-07-13 04:30:28 +00:00
8107939f08
- all RAN code, CI code, configuration files, dockerfiles, in CSSL v1.0
- all deployment code (openshift, charts, ancillary files like shell
scripts), in MIT
- documentation in CC-BY-4.0
- exceptions might apply and are listed in NOTICE
- there is a new LICENSES folder with all licenses
- CONTRIBUTIONS.md has been updated accordingly
For automated changes based on OAI PL v1.1:
perl -i~ -0pe 's/\/\*.*Licensed to the OpenAirInterface.*openairinterface.org\n#?/\/*\n * SPDX-License-Identifier: LicenseRef-CSSL-1.0\n/s' **/*.{c,h,cpp}
perl -i~ -0pe 's/\/\*.*Licensed to the OpenAirInterface.*openairinterface.org\n#?/\/*\n * SPDX-License-Identifier: LicenseRef-CSSL-1.0\n/s' **/*.ts
perl -i~ -0pe 's/<!--.*Licensed to the OpenAirInterface.*openairinterface.org\n.*-->/<!-- SPDX-License-Identifier: LicenseRef-CSSL-1.0 -->/s' **/*.xml
The rest (cmake, files with missing license, cmake) manually.
235 lines
12 KiB
C
235 lines
12 KiB
C
/*
|
|
* SPDX-License-Identifier: LicenseRef-CSSL-1.0
|
|
*/
|
|
|
|
/***************************************************************************
|
|
mac_rlc_primitives.h - description
|
|
-------------------
|
|
***************************************************************************/
|
|
#ifndef __MAC_RLC_PRIMITIVES_H__
|
|
# define __MAC_RLC_PRIMITIVES_H__
|
|
|
|
/** @defgroup _mac_rlc_primitives_ MAC Layer Primitives for Communications with RLC
|
|
* @ingroup _openair_mac_layer_specs_
|
|
* @{
|
|
This subclause describes the primitives for communications between the RLC and MAC sub-layers.
|
|
|
|
|
|
This clause describes the primitives for communications between the RLC and MAC sub-layers. It is largely inspired by
|
|
3GPP TS 25.321 V4.2.0.
|
|
\image html mac_w3g4f_rlc_tx_sequence_diagram.png "MAC-RLC TX Sequence Diagram" width=15cm
|
|
\image latex mac_w3g4f_rlc_tx_sequence_diagram.png "MAC-RLC TX Sequence Diagram" width=15cm
|
|
|
|
MAC-STATUS-Ind (mac_status_ind} primitive indicates to RLC for each logical channel the rate at which it may transfer data to MAC. Parameters
|
|
are the number of PDUs that can be transferred in each transmission time interval and the PDU size; it is possible that MAC
|
|
would use this primitive to indicate that it expects the current buffer occupancy of the addressed logical channel in order
|
|
to provide for optimised TFC selection on transport channels with long transmission time interval. At the UE, MAC-STATUS-Ind
|
|
primitive is also used to indicate from MAC to RLC that MAC has requested data transmission by PHY (i.e. PHY-DATA-REQ has
|
|
been submitted, see Fig. 11.2.2.1), or that transmission of an RLC PDU on RACH or CPCH has failed due to exceeded preamble
|
|
ramping cycle counter.
|
|
|
|
MAC-STATUS-Resp (mac_status_resp) primitive enables RLC to acknowledge a MAC-STATUS-Ind. It is possible
|
|
that RLC would use this primitive to indicate that it has nothing to send or that it is
|
|
in a suspended state or to indicate the current buffer occupancy to MAC.
|
|
|
|
*/
|
|
# include "list.h"
|
|
# include "rrm_constants.h"
|
|
//# include "LAYER2/MAC/defs.h"
|
|
|
|
# define MAC_DCCH 0xCC
|
|
# define MAC_DTCH 0xDC
|
|
//----------------------------------------------------------
|
|
// primitives
|
|
//----------------------------------------------------------
|
|
# define MAC_DATA_REQ 0x01
|
|
# define MAC_DATA_IND 0x02
|
|
# define MAC_STATUS_IND 0x04
|
|
# define MAC_STATUS_RESP 0x08
|
|
//----------------------------------------------------------
|
|
// primitives definition
|
|
//----------------------------------------------------------
|
|
# define UE_ID_TYPE_U_RNTI 0xFF
|
|
// should not be used ?
|
|
# define UE_ID_TYPE_C_RNTI 0xCC
|
|
|
|
# define MAC_TX_STATUS_SUCCESSFUL 0x0F
|
|
# define MAC_TX_STATUS_UNSUCCESSFUL 0xF0
|
|
|
|
# define MAC_HEADER_MAX_SIZE 6
|
|
|
|
|
|
// Parameters:
|
|
// a) data:
|
|
// - it contains the RLC layer messages (RLC-PDU) to be transmitted, or the RLC layer messages
|
|
// that have been received by the MAC sub-layer.
|
|
//
|
|
// b) no_tb :
|
|
// - indicates the number of transport blocks transmitted by the peer entity within the
|
|
// transmission time interval, based on the TFI value.
|
|
//
|
|
// c) buffer_occupancy :
|
|
// - the parameter Buffer Occupancy (BO) indicates for each logical channel the amount of data
|
|
// in number of bytes that is available for transmission and retransmission in RLC layer.
|
|
// When MAC is connected to an AM RLC entity, control PDUs to be transmitted and RLC PDUs
|
|
// outside the RLC Tx window shall also be included in the BO. RLC PDUs that have been
|
|
// transmitted but not negatively acknowledged by the peer entity shall not be included in the BO.
|
|
//
|
|
// d) rx_timing_deviation, TDD only:
|
|
// - it contains the RX Timing Deviation as measured by the physical layer for the physical
|
|
// resources carrying the data of the Message Unit. This parameter is optional and only for
|
|
// Indication. It is needed for the transfer of the RX Timing Deviation measurement of RACH
|
|
// transmissions carrying CCCH data to RRC.
|
|
//
|
|
// e) no_pdu:
|
|
// - specifies the number of PDUs that the RLC is permitted to transfer to MAC within a
|
|
// transmission time interval.
|
|
//
|
|
// f) pdu_size:
|
|
// - specifies the size of PDU that can be transferred to MAC within a transmission time interval.
|
|
//
|
|
// g) UE-ID Type Indicator:
|
|
// - indicates the UE-ID type to be included in MAC for a DCCH when it is mapped onto a common
|
|
// transport channel (i.e. FACH, RACH, DSCH in FDD or CPCH). On the UE side UE-ID Type Indicator
|
|
// shall always be set to C-RNTI.
|
|
//
|
|
// h) tx_status:
|
|
// - when set to value "transmission unsuccessful" this parameter indicates to RLC that transmission
|
|
// of an RLC PDU failed in the previous Transmission Time Interval, when set to value
|
|
// "transmission successful" this parameter indicates to RLC that the requested RLC PDU(s)
|
|
// has been submitted for transmission by the physical layer.
|
|
//
|
|
// i) rlc_info
|
|
// - indicates to MAC the configuration parameters that are critical to TFC selection depending
|
|
// on its mode and the amount of data that could be transmitted at the next TTI. This primitive
|
|
// is meant to insure that MAC can perform TFC selection.
|
|
struct rlc_entity_info {
|
|
unsigned char rlc_protocol_state;
|
|
};
|
|
|
|
struct mac_tx_tb_management {
|
|
// BE CAREFULL TO KEEP THE SAME MAPPING FOR THE 6 FIELDS BELLOW AS FOR struct mac_tb_req
|
|
unsigned char *data_ptr;
|
|
unsigned char first_bit; // 0 if data starts on byte boundary(b7), 1 if b6, 2 if b5, etc.
|
|
// Previously designed for interlayers optimizations, (avoid aligning on byte boundary)
|
|
// but not used by L1 !, so extra cost for alignement in MAC.
|
|
tb_size_t tb_size_in_bits; // L1H does not care of the field first bit any more, so in order to byte
|
|
// align the tb we have to know its size
|
|
|
|
// for reporting tx status to upper layers
|
|
void *rlc;
|
|
void (*rlc_callback) (void *rlcP, unsigned short rlc_tb_type);
|
|
unsigned short rlc_tb_type;
|
|
|
|
unsigned short log_ch_interface_src; // index of the logical channel interface from which the tb was submitted
|
|
unsigned char mac_header[MAC_HEADER_MAX_SIZE]; // worst case : tctf(5bits)+UE-Id type(2bits)+UE-Id(16 or 32bits)+C/T(4bits)=43bits max
|
|
};
|
|
|
|
struct mac_rx_tb_management {
|
|
unsigned char *data_ptr;
|
|
tb_size_t tb_size; // in bits
|
|
bool valid_checksum;
|
|
unsigned char first_bit; // 0 if data starts on byte boundary(b7), 1 if b6, 2 if b5, etc
|
|
};
|
|
|
|
struct mac_tb_req {
|
|
// BE CAREFULL TO KEEP THE SAME MAPPING FOR THE 6 FIELDS BELLOW AS FOR struct mac_tx_tb_management
|
|
unsigned char *data_ptr;
|
|
unsigned char first_bit;
|
|
tb_size_t tb_size;
|
|
// align the tb we have to know its size
|
|
|
|
// for reporting tx status to upper layers
|
|
void *rlc;
|
|
void (*rlc_callback) (void *rlcP, unsigned short rlc_tb_type);
|
|
unsigned short rlc_tb_type;
|
|
|
|
unsigned char mac_header[MAC_HEADER_MAX_SIZE]; // worst case : tctf(5bits)+UE-Id type(2bits)+UE-Id(16 or 32bits)+C/T(4bits)=43bits max
|
|
};
|
|
|
|
// MAC-STATUS-Ind/Resp:
|
|
/*!\brief
|
|
MAC-STATUS-Ind primitive indicates to RLC for each logical channel the rate at which it may transfer data to MAC. Parameters
|
|
are the number of PDUs that can be transferred in each transmission time interval and the PDU size; it is possible that MAC
|
|
would use this primitive to indicate that it expects the current buffer occupancy of the addressed logical channel in order
|
|
to provide for optimised TFC selection on transport channels with long transmission time interval. At the UE, MAC-STATUS-Ind
|
|
primitive is also used to indicate from MAC to RLC that MAC has requested data transmission by PHY (i.e. PHY-DATA-REQ has
|
|
been submitted, see Fig. 11.2.2.1), or that transmission of an RLC PDU on RACH or CPCH has failed due to exceeded preamble
|
|
ramping cycle counter.*/
|
|
struct mac_status_ind {
|
|
unsigned short no_pdu; /*!< \brief PDUs number*/
|
|
unsigned short tx_status; /*!< \brief status is successful or unsuccessful*/
|
|
};
|
|
|
|
/*!\brief
|
|
MAC-STATUS-Resp primitive enables RLC to acknowledge a MAC-STATUS-Ind. It is possible
|
|
that RLC would use this primitive to indicate that it has nothing to send or that it is
|
|
in a suspended state or to indicate the current buffer occupancy to MAC.
|
|
*/
|
|
struct mac_status_resp {
|
|
unsigned int
|
|
buffer_occupancy_in_bytes; /*!< \brief the parameter Buffer Occupancy (BO) indicates for each logical channel the amount of data in number of bytes that is available for transmission and retransmission in RLC layer. */
|
|
unsigned short buffer_occupancy_in_pdus; /*!< xxx*/
|
|
uint32_t head_sdu_creation_time;
|
|
uint32_t head_sdu_remaining_size_to_send;
|
|
unsigned char head_sdu_is_segmented;
|
|
struct rlc_entity_info rlc_info; /*!< xxx*/
|
|
};
|
|
|
|
struct mac_tb_ind {
|
|
unsigned char *data_ptr;
|
|
unsigned short size;
|
|
unsigned char error_indication;
|
|
unsigned char first_bit; // 0 if data starts on byte boundary(b7), 1 if b6, 2 if b5, etc
|
|
};
|
|
|
|
// MAC-DATA-Req/Ind:
|
|
|
|
|
|
|
|
//---------------------
|
|
/*! \brief MAC-DATA-Req primitive is used to request that an upper layer PDU be sent using the
|
|
procedures for the information transfer service;
|
|
*/
|
|
struct mac_data_req {
|
|
list_t data; /*!< contains the RLC layer messages (RLC-PDU) to be transmitted*/
|
|
unsigned int buffer_occupancy_in_bytes; /*!< the parameter Buffer Occupancy (BO) indicates for each logical channel the amount of data
|
|
in number of bytes that is available for transmission and retransmission in RLC layer.
|
|
When MAC is connected to an AM RLC entity, control PDUs to be transmitted and RLC PDUs
|
|
outside the RLC Tx window shall also be included in the BO. RLC PDUs that have been
|
|
transmitted but not negatively acknowledged by the peer entity shall not be included in the BO.*/
|
|
unsigned short buffer_occupancy_in_pdus; /*!< xxx*/
|
|
struct rlc_entity_info rlc_info; /*!< indicates to MAC the configuration parameters that are critical to TFC selection depending
|
|
on its mode and the amount of data that could be transmitted at the next TTI. This primitive
|
|
is meant to insure that MAC can perform TFC selection.*/
|
|
unsigned char ue_id_type_indicator; /*!< indicates the UE-ID type to be included in MAC for a DCCH when it is mapped onto a common
|
|
transport channel (i.e. FACH, RACH, DSCH in FDD or CPCH). On the UE side UE-ID Type Indicator
|
|
shall always be set to C-RNTI.*/
|
|
};
|
|
//---------------------
|
|
/*! \brief MAC-DATA-Ind primitive indicates the arrival of upper layer PDUs received within one
|
|
transmission time interval by means of the information transfer service.*/
|
|
struct mac_data_ind {
|
|
list_t data; /*! the RLC layer messages that have been received by the MAC sub-layer*/
|
|
unsigned short no_tb;
|
|
unsigned short tb_size; // in bits
|
|
//unsigned char error_indication;
|
|
};
|
|
|
|
|
|
//---------------------
|
|
|
|
//---------------------
|
|
struct mac_primitive {
|
|
unsigned char primitive_type;
|
|
union {
|
|
struct mac_data_req data_req;
|
|
struct mac_status_resp status_resp;
|
|
struct mac_data_ind data_ind;
|
|
//struct mac_status_ind status_ind;
|
|
} primitive;
|
|
};
|
|
|
|
/** @} */
|
|
#endif
|