STACK – PHY Interface API Version: mymo_STACK_PHY_API.11.08.26 Date: 26-August-2011 MYMO WIRELESS TECHNOLOGY PVT LTD, 1 ST FLOOR ENTREPRENEURSHIP BLDG, SID, IISC, BANGALORE 560012, INDIA MYMO Wireless Confidential Proprietary The information contained in this document is classified Company Confidential. The use and divulgence of any part of this information can seriously affect the welfare and financial security of the company. The distribution of this information to any individual not employed by Mymo Wireless is strictly controlled through a Non Disclosure Agreement. Any Mymo Wireless employee receiving this document will be held strictly accountable for the discretion and judgment associated with the use of this information.
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
STACK – PHY Interface API
Version: mymo_STACK_PHY_API.11.08.26
Date: 26-August-2011
M Y M O W I R E L E S S T E C H N O L O G Y P V T L T D ,1 S T F L O O R E N T R E P R E N E U R S H I P B L D G , S I D , I I S C ,
B A N G A L O R E 5 6 0 0 1 2 , I N D I A
MYMO Wireless Confidential Proprietary
The information contained in this document is classified Company Confidential. The use and divulgence of any part of this information can seriously affect the welfare and financial security of the company. The distribution of this information to any individual not employed by Mymo Wireless is strictly controlled through a Non Disclosure Agreement. Any Mymo Wireless employee receiving this document will be held strictly accountable for the discretion and judgment associated with the use of this information.
Mymo Wireless Confidential Version:
Revision History
Revision # Date Author Reviewer Description11.0826 26-Aug-2011 Ashwini
Table of Contents A. References..................................................................4 B. Abbreviations...............................................................4 1.1 LTE .......................................................................6 1.2 STACK-PHY Interface API ...................................................7 2.1 Defines:...................................................................8 2.2 TypeDefs; Variable.........................................................8 2.4 Message Type and Enumerations..............................................8 2.4.1 Message Types...........................................................8
1.IntroductionThis document describes an Application Programming Interface (API) which defines the interface between LTE UE L2/L3 software stack and LTE UE L1 PHY. The LTE standard has been designed to support both TDD and FDD deployments.
This document is divided into two sections. The first section provides a description of typical procedures which will occur between the L1 and L2/L3 software. The second section provides the definition of the L1 API messages.
1.1 LTE
LTE is standardized by 3GPP (http://www.3gpp.org) and designed as an evolution to the current WCDMA wireless network, which is in widespread use today. A critical requirement of LTE is the capability of supporting high data rates (300Mbps), and many aspects of the LTE network have been designed specifically to support high data rates and low latency.
Figure 1 shows the architecture of a LTE network. It consists of only two elements; the E-UTRAN Node B (eNB) and the LTE UE. The LTE STACK-PHY API resides within the UE element.
The STACK-PHY Interface, defined in this document, resides within the UE component. The functionality of an UE is shown in Figure 2. In Figure 2 the location of the STACK-PHY Interface is highlighted. Figure 2 shows the protocol model for the UE defined in the E-UTRAN architectural standard. It highlights the separation of control- and data-plane information, which is maintained throughout the LTE network. Both control- and data-plane information is passed through the STACK-PHY API.
Figure 2 also provides an example of how the different Layer 2 and Layer 3 protocol layers will interact with the STACK-PHY API.
2.5.1 mymoAntennaInfoStruct Antenna selection and transmission modes Direction: Stack To PHYRemark: During Radio Resource Config Dedicated – Connection Establishment
Element Type Description
antennaPortsCount byte number of antenna ports: 1, 2 or 4. same as gTxLayers. Note: Port numbers are different. This represents the number of cell specific antenna ports. See TS 36.211, 6.2.1.
transmissionMode byte Points to one of 7 Transmission modes defined in TS 36.213, 7.1 � works in conjunction with C-RNTI, SPS C-RNTI or temporary C-RNTI
bitStringSize1 byteIndicates the number of bits in codebook restriction string. Values: 2, 4, 6, 16 and 64
codebookSubsetRestriction[8] byte bitstream left-aligned bits with size indicated in the previous field.Note: if the value is 0x01, then it will occupy the first 2 bits of the string
ueTxAntennaSelection2 bool TRUE for Closed-loop, FALSE for open-loop
1 Codebook for precoding matrix. See TS 36.213 [23, 7.2] and TS 36.211 [21, 6.3.4.2.3]. 2 Indicates whether UE transmit antenna selection control is closed-loop or open-loop as described in TS 36.213 [23, 8.7]. If antenna selection is disabled by higher layers, tx is done at antenna port-0.
2.5.2 mymoCQIReportConfigStruct CQI reporting details Direction: NARemark: NA
Element Type Description
cqiPUCCHResourceIndex short int n2Pucch in mymoUEStruct. Range: 0 - 1185. See TS 36.213 [23, 7.2]
cqiPmiConfigIndex short int 0 - 1023; CQI/PMI Periodicity and Offset Configuration Index ICQI/PMI, see TS 36.213 [23, tables 7.2.2-1A and 7.2.2-1C]
simultHarqCQI bool Same as transmitAck in mymoUE. See TS 36.213 [23, 10.1]. TRUE indicates that simultaneous transmission of ACK/NACK and CQI is allowed.
cqiAperiodicReportMode byte Values correspond to tx Modes. PUSCH reporting modes are described in TS 36.213 [23, 7.2.1].
nomPDSCHRSOffset char see TS 36.213 [23, 7.2.3]. Actual value = IE value * 2 [dB] � configured by higher layers
2.5.3 mymoPDSCHPowerConfigStruct Common and UE specific power config values for PDSCH Direction: Stack To PHYRemark: During Radio Resource Configuration Connection Establishment Process
Element Type Description
refSigPower short int DL RS EPRE, see TS 36.213 [23, 5.2]. The actual value in dBm from -60 tp +50
pa char see TS 36.213 [23, 5.2]. -6 (-6db), -5 (-4.77db), dB-3, -2 (-1.77db),0, 1, 2, 3 (0db, 1db, 2db and 3db)
2.5.4 mymoPHICHConfigStruct The PHICH contents as decoded from PBCH - MIB Direction: Stack To PHYRemark: During Radio Resource Configuration Connection Establishment Process
Element Type Description
phichDuration bool see TS 36.211 [21, Table 6.9.3-1]. FALSE for normal and TRUE for extended
phichResource byte Ng - see TS 36.211 [21, 6.9]. Values 0, 1, 2 and 3 correspond to 1/6, 1/2, 1 and 2
2.5.5 mymoMasterInfoBlockStruct MIB contents - as retrieved from PBCH Direction: PHY To StackRemark: During System Information Acquisition.
Element Type Description
eNodeBandWidth int Value ranges from 1.4 X 10^6 to 20 X 10^6
phichConfig mymoPHICHConfigStruct Contains PHICH duration and resource
sysFrameNum short int System Frame Number 8+2 bits
2.5.6 mymoPRACHConfigStruct RACH details provided by MAC Layer Direction: Stack To PHYRemark: during Radio Resource Config Common during Connection Setup
Element Type Description
rootSequenceIndex short int RACH_ROOT_SEQUENCE, see TS 36.211 [21, 5.7.1]. Value Range: 0 - 837
raRNTI short int RA-RNTI to be used for PRACH signal
highSpeedFlag bool see TS 36.211, [21, 5.7.2].TRUE corresponds to Restricted set and FALSE to Unrestricted set.
prachConfigIndex byte see TS 36.211 [21, 5.7.1]. Value range 0 - 63
prachPreambleIndex byte This gets initialized through DCI format 1A. Value Range: 0-63
zeroCorrelationZoneConfig byte NCS configuration, see TS 36.211, [21, 5.7.2: table 5.7.2-2] for preamble format 0..3 and TS 36.211, [21, 5.7.2: table 5.7.2-3] for preamble format 4.; Value range 0 - 15
prachFreqOffset byte prach-FrequencyOffset, see TS 36.211, [21, 5.7.1]. For TDD the value range is dependent on the value of prach-ConfigIndex. Value Range: 0 - 94
preambleReceivedTargetPower byte Sent by MAC as per TS 36.321, [14, 5.1.3]
2.5.7 mymoPUCCHConfigStruct Details for PUCCH processing
Direction: Stack To PHYRemark: During RRC Connection Config
Element Type Description
deltaPUCCHShift byte Ref: delPucchShift in mymoUEStruct; see 36.211, 5.4.1, Value Range 1-3 for ds1, ds2 and ds3
n_RB_CQI byte nRB-CQI, see TS 36.211 [21, 5.4]. Range: 0-98
n1CS byte see TS 36.211 [21, 5.4]. Range: 0 - 7
n1Pucch short int see TS 36.213 [23, 10.1]. Range: 0 - 2047
ackNackRepetition bool Indicates whether ACK/NACK repetition is configured, see TS 36.213 [23, 10.1].
repeatFactor byte N_an_rep see TS 36.213 [23, 10.1]; Vallues: 2,4 and 6
n1PucchANRep short int see TS 36.213 [23, 10.1]. n1, an-rep; Value Range: 0 - 2047
tddHARQFeedbackMode bool Parameter indicates one of the two TDD ACK/NACK feedback modes used, see TS 36.213 [23, 7.3]. FALSE: bundling corresponds to use of ACK/NACK bundling whereas, TRUE: multiplexing corresponds to ACK/NACK multiplexing.
2.5.8 mymoPUSCHConfigStruct Details for PUSCH processing Direction: Stack To PHYRemark: During RRC Connection Config
Element Type Description
nSB byte Nsb - number of sub bands. see TS 36.211 [21, 5.3.4]. Range: 1 - 4
hoppingMode bool see TS 36.211 [21, 5.3.4]. FALSE: inter-subframe, TRUE: inter & intra-subframe
2.5.9 mymoSchedReqConfigStruct Schedule Request structure Direction: Stack To PHYRemark: During SR request from Stack
Element Type Description
srPUCCHResourceIndex short int see TS 36.213 [23, 10.1]. Range: 0 - 2047
srConfigIndex byte see TS 36.213 [23,10.1]. Range: 0 - 155
2.5.10 mymoSRSConfigStruct Sounding RS structure contents as provided by higher layers Direction: Stack To PHYRemark: during Radio Resource Configuration proceudre
Element Type Description
srsBWConfig byte SRS Bandwidth Configuration. See TS 36.211, [21, table 5.5.3.2-1, 5.5.3.2-2, 5.5.3.2-3 and 5.5.3.2� 4]. Range: 0 - 7
srsSubframeConfig byte SRS Subframe Configuration. See TS 36.211, [21, table 5.5.3.3-1] applies for FDD whereas TS 36.211, [21, table 5.5.3.3-2] applies for TDD. Range: 0 - 15
transmitHARQSRS bool Simultaneous-AN-and-SRS, see TS 36.213 [23, 8.2].
srsMaxUpPts bool srsMaxUpPts, see TS 36.211 [21, 5.5.3.2]. If TRUE, reconfiguration applies for UpPts.
2.5.11 mymoSemiPersistConfigStruct SPS data Direction: Stack To PHYRemark: During DRB Radio Resource configuration procedure
Element Type Description
n1PUCCHPersistent[4] short int see TS 36.213, [23, 10.1]. Each value is from 0 - 2047
p0NominalPUSCHPersistent short int see TS 36.213 [23, 5.1.1.1] Range: -126 to 24
p0PUSCHPersistent char see TS 36.213 [23, 5.1.1.1] Range: -8 to 7
2.5.12 mymoTDDConfigStruct TDD configuration structure Direction: NARemark: NA
Element Type Description
subframeAssignment byte Indicates DL/UL subframe configuration as specified in TS 36.211 [21, table 4.2.2]. Range: 0 - 6
specialSFPatterns byte Indicates Configuration as in TS 36.211 [21, table 4.2.1]. Range: 0 - 8
2.5.13 mymoTpcPDCCHConfigStruct TPC configuration structure of PDCCH applicable for both PUSCH and PUCCH Direction: Stack To PHYRemark: During Connection Setup Procedure
tpcRNTI short int RNTI for power control using DCI format 3/3A, see TS 36.212 [22].
tpcIndex int Index of N or M, see TS 36.212 [22, 5.3.3.1.6 and 5.3.3.1.7], where N or M is dependent on the used DCI format (i.e. format 3 or 3a).tpcIndex is 16 bits for format 3 and 32 bits for format 3A
2.5.14 mymoULPowerControlStruct Uplink Power control structure Direction: Stack To PHYRemark: During Radio Resource Configuiration procedure
Element Type Description
p0NominalPUSCH short int see TS 36.213, 5.1.1.1, for non-persistent scheduling, only. Range: -126 to 24
p0NominalPUCCH short int see TS 36.213, 5.1.2.1, unit dBm. Range: -127 to -96
alpha float see TS 36.213, 5.1.1.1 Range: 0.0 - 1.0
deltaFPUCCHFormat[5] char for the PUCCH formats 1, 1b, 2, 2a and 2b. See TS 36.213 [23, 5.1.2] Values: -2, 0 and +2 for all formats except format-2 where it is: -2, 0, 1, 2 and format 1b: 1, 3, 5
p0PUSCH char see TS 36.213 [23, 5.1.1.1], unit dB. This field is applicable for non-persistent scheduling, only. Values: -8 to 7
p0PUCCH char see TS 36.213 [23, 5.1.2.1]. Unit dB. Values: -8 to 7
deltaPreambleMsg3 char see TS 36.213 [23, 5.1.1.1]. Range: -1 to 6; Actual value = IE value * 2 [dB].
deltaMCSEnabled bool see TS 36.213 [23, 5.1.1.1]. FALSE: disabled state. TRUE: enabled with value 1.25
accumulation bool Accumulation-enabled, see TS 36.213 [23, 5.1.1.1]. TRUE: enabled and FALSE: disabled.
pSRSOffset float PSRS_OFFSET see TS 36.213 [23, 5.1.3.1]. For Ks=1.25, the actual parameter value is pSRS-Offset value 3. For Ks=0, the actual�
filterCoef float Specifies the filtering coefficient for RSRP measurements used to calculate path loss, as specified in TS 36.213 [23, 5.1.1.1]. The same filtering mechanism applies as for quantityConfig described in 5.5.3.2.
2.5.15 mymoENodeBConfigStruct Configuration description of the eNodeB Direction: PHY To Stack and Stack To PHYRemark: During Cell Search and Cell Camping respectively
Element Type Description
nCellID short int Cell identifier
N_RB short int 6 to 100
cpLength short int 10/9 to 160/144
bandwidth int 1.4MHz to 20 MHz
rsrp float Ref Signal Received Power
frameType byte FDD or TDD
isNormalCP bool 1 for Normal, 0 for Extended
isHandOver bool Indicator to UE to switch to another cell
2.5.16 mymoRNTIStruct Set of RNTI values. Refer to MAC spec 36.321 (8.7.0) Page 38 Section 7.1 Direction: Stack To PHY and PHY To StackRemark: communicated to PHY during Call Setup and vice versa
Element Type Description
P_RNTI unsigned short Paging and System Information change notification. Value: 0xFFFE
SI_RNTI unsigned short Broadcast of System Information, Range: 0xFFFF
RA_RNTI unsigned short Random Access Response. Range: 0x1-0x3C (60)
transmission (activation, reactivation and retransmission). Range same as C-RNTI
TPC_RNTI unsigned short Physical layer Uplink power control. Range same as C-RNTI
2.5.17 mymoULControlConfigStruct UL Control Configuration Direction: PHY To StackRemark: during UL Data transfer upon receiving PDCCH UL DCI
Element Type Description
subframeNum byte UpLink subframe number: 0 to 9
frequencyHop bool Set to TRUE if frequency hopping to be done
newDataIndicator bool Indicates whether the tx data is a fresh transmission
harqFeedback bool PHICH decoded value
cqiRequest bool TRUE if eNodeB is requesting CQI info through DCI format 0
spsActive bool Indicates SPS activate or release when TRUE
modulation byte Modulation type (for PUSCH only, as others are predefined)
freqHopValue byte Value indicated by eNodeB for frequency hopping. To be considered only if frequencyHop is TRUE. if eNodeB BW >= 50, this will be a 2-bit value, otherwise 1-bit.
n2DMRS byte 3-bit cyclic shift value for DMRS generation
rvidx byte Redundancy Version
ulIndex byte UL Index in TDD with DL/UL config 0
DAI byte Downlink Assignment Index in TDD
rbStart byte RBstart received for the uplink grant
numRBs byte uplink grant in RBs
RNTI unsigned short 16 bit value
txBlockSize short int Transport Block size in bytes
2.5.18 mymoDLControlConfigStruct DL Control Configuration Direction: PHY To Stack
3. Message Sequence between STACK and PHYThe below figure [] shows the message seqeuence between UE Stack and PHY. STACK-PHY interface defines the message format.