mymo stack phy api 110826

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

PatankarMahendra Patel

Initial draft

Copyright 2011, Mymo Wireless Technology Pvt Ltd 2


Table of Contents

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

2.5 typedefs: structs..........................................................9 2.5.1 mymoAntennaInfoStruct .................................................10 2.5.2 mymoCQIReportConfigStruct .............................................10 2.5.3 mymoPDSCHPowerConfigStruct ............................................11 2.5.4 mymoPHICHConfigStruct .................................................11 2.5.5 mymoMasterInfoBlockStruct .............................................12 2.5.6 mymoPRACHConfigStruct .................................................12 2.5.7 mymoPUCCHConfigStruct .................................................12 2.5.8 mymoPUSCHConfigStruct .................................................13 2.5.9 mymoSchedReqConfigStruct ..............................................14 2.5.10 mymoSRSConfigStruct ..................................................14 2.5.11 mymoSemiPersistConfigStruct ..........................................15 2.5.12 mymoTDDConfigStruct ..................................................15 2.5.13 mymoTpcPDCCHConfigStruct .............................................15 2.5.14 mymoULPowerControlStruct .............................................16 2.5.15 mymoENodeBConfigStruct ...............................................17 2.5.16 mymoRNTIStruct .......................................................17 2.5.17 mymoULControlConfigStruct ............................................18 2.5.18 mymoDLControlConfigStruct ............................................18 2.5.19 mymoUEConfigStruct ...................................................19 2.5.20 mymoCellListStruct ...................................................20 2.5.21 mymoSubFrameConfigStruct .............................................20 2.5.22 mymoDLTxConfigStruct .................................................21



References, Legends, Formats

A. References

[1] 3GPP TS 36.201: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical Layer – General Description". V8.3.0 (2009-03)

[2] 3GPP TS 36.211: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical channels and modulation” V8.7.0 (2009-06)

[3] 3GPP TS 36.212: "Evolved Universal Terrestrial Radio Access (E-UTRA); Multiplexing and channel coding". V8.7.0 (2009-06)

[4] 3GPP TS 36.213: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical layer procedures". V8.7.0 (2009-06)

[5] 3GPP TS 36.214: "Evolved Universal Terrestrial Radio Access (E-UTRA); Physical layer – Measurements". V8.6.0 (2009-03)

[6] 3GPP TS 36.104: “Evolved Universal Terrestrial Radio Access (E-UTRA); Base Station (BS) radio transmission and reception”. V8.6.0 (2009-06)

[7] 3GPP TS 36.101: “Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) radio transmission and reception”. V8.6.0(2009-07)

[8] 3GPP TS36.321, “Evolved Universal Terrestrial Radio Access (E-UTRA); Medium Access Control (MAC) protocol specification” V8.6.0 (2009-06)

[9] 3GPP TS36.331, “Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification” V8.6.0 (2009-06)

B. Abbreviations

DMRS De-Modulated Reference Signal

DCI Downlink Control Information

DL-SCH Downlink Shared channel

FDD Frequency Division Duplexing

HI HARQ indicator

MAC Media Access Control

OFDM Orthogonal Frequency Division Multiplexing

PBCH Physical broadcast channel

PCFICH Physical control format indicator channel

PCH Paging channel

PDCCH Physical downlink control channel

PDSCH Physical downlink shared channel



PHICH Physical hybrid-ARQ indicator channel

PMCH Physical multicast channel

PMI Precoding Matrix Indicator

PRACH Physical random access channel

PUCCH Physical Uplink Control Channel

PUSCH Physical Uplink Shared Channel

RACH Random Access channel

RI Rank Indication

SRS Sounding Reference Signal

TDD Time Division Duplexing

TPMI Transmitted Precoding Matrix Indicator

UCI Uplink Control Information

UL-SCH Uplink Shared channel



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.


Figure 1 : LTE UE eNodeB Architecture

http://www.3gpp.org/


1.2 STACK-PHY Interface API

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.


Figure 2 : STACK PHY INTERFACE


2 STACK-PHY API

2.1 Defines:Name Value Remark

2.2 TypeDefs; VariableName Type Remark

byte unsigned char To store 1 Byte

2.4 Message Type and EnumerationsName Type Remark

PHY_ABSTRACT_NUM Message Types

2.4.1 Message TypesName Value Remark

PHY_NULL 0

PHY_ALL 50

PHY_TTI_TICK 100

PHY_READY 105

PHY_SUBFRAME_INIT 110

PHY_mymoAntennaInfoStruct 1

PHY_mymoCQIReportConfigStruct 2

PHY_mymoPDSCHPowerConfigStruct 3

PHY_mymoPHICHConfigStruct 4

PHY_mymoMasterInfoBlockStruct 5

PHY_mymoPRACHConfigStruct 6

PHY_mymoPUCCHConfigStruct 7

PHY_mymoPUSCHConfigStruct 8

PHY_mymoSchedReqConfigStruct 9

PHY_mymoSRSConfigStruct 10

PHY_mymoSemiPersistConfigStruct 11

PHY_mymoTDDConfigStruct 12

PHY_mymoTpcPDCCHConfigStruct 13

PHY_mymoULPowerControlStruct 14



Name Value Remark

PHY_mymoRNTIStruct 16

PHY_mymoULControlConfigStruct 17

PHY_mymoDLControlConfigStruct 18

PHY_mymoUEConfigStruct 19

PHY_mymoSubFrameConfigStruct 20

PHY_mymoDLTxConfigStruct 21

PHY_mymoCellListStruct 22

PHY_mymoPagingStruct 23

PHY_TOTAL_STRUCTS 24

2.5 typedefs: structsName Remark

mymoAntennaInfoStruct Antenna selection and transmission modes

mymoCQIReportConfigStruct CQI reporting details

mymoPDSCHPowerConfigStruct Common and UE specific power config values for PDSCH

mymoPHICHConfigStruct The PHICH contents as decoded from PBCH - MIB

mymoMasterInfoBlockStruct MIB contents - as retrieved from PBCH

mymoPRACHConfigStruct RACH details provided by MAC Layer

mymoPUCCHConfigStruct Details for PUCCH processing

mymoPUSCHConfigStruct Details for PUSCH processing

mymoSchedReqConfigStruct Schedule Request structure

mymoSRSConfigStruct Sounding RS structure contents as provided by higher layers

mymoSemiPersistConfigStruct SPS data

mymoTDDConfigStruct TDD configuration structure

mymoTpcPDCCHConfigStruct TPC configuration structure of PDCCH applicable for both PUSCH and PUCCH

mymoULPowerControlStruct Uplink Power control structure

mymoENodeBConfigStruct Configuration description of the eNodeB

mymoRNTIStruct Set of RNTI values. Refer to MAC spec 36.321 (8.7.0) Page 38 Section 7.1

mymoULControlConfigStruct UL Control Configuration

mymoDLControlConfigStruct DL Control Configuration

mymoUEConfigStruct Configuration of the UE module

mymoCellListStruct Cell List for cell search

mymoSubFrameConfigStruct Uplink Configuration for a single subframe



Name Remark

processing

mymoDLTxConfigStruct DownLink Transmit Buffer module

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


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]




riConfigIndex short int 0 - 1023; Parameter: RI Config Index IRI, see TS 36.213 [23, 7.2.2-1B].

k byte 1- 4; Sub band size information, see TS 36.213 [23, 7.2.2].

periodicCQIFormatIndicator bool FALSE: wideband; TRUE: UE selected (sub band). PUCCH CQI Feedback Type, see TS 36.213 [23, table 7.2.2-1].

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


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)

pb byte see TS 36.213 [23, Table 5.2-1]. Value: 0 - 3

2.5.4 mymoPHICHConfigStruct The PHICH contents as decoded from PBCH - MIB Direction: Stack To PHYRemark: During Radio Resource Configuration Connection Establishment Process


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.


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


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


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


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

puschHoppingOffset byte see TS 36.211 [21, 5.3.4]. Range: 0 - 98

enable64QAM bool see TS 36.213 [23, 8.6.1]. TRUE indicates that 64QAM is allowed while FALSE indicates otherwise.

betaHARQOffsetIndex byte Index to betaHARQOffsetTable (mymoULConfig.h), see TS 36.213 [23, Table 8.6.3-1].

betaRIOffsetIndex byte Index to betaRIOffsetTable




(mymoULConfig.h), see TS 36.213 [23, Table 8.6.3-2].

betaCQIOffsetIndex byte Index to betaCQIOffsetTable (mymoULConfig.h), see TS 36.213 [23, Table 8.6.3-3].

groupHopEnabled bool see TS 36.211 [21, 5.5.1.3].

sequenceHopEnabled bool see TS 36.211 [21, 5.5.1.4].

groupAssignmentPUSCH byte See TS 36.211 [21, 5.5.1.3]. Range: 0 - 29:

cyclicShift byte see TS 36.211 [21, Table 5.5.2.1.1-2]. Range: 0 - 7

2.5.9 mymoSchedReqConfigStruct Schedule Request structure Direction: Stack To PHYRemark: During SR request from Stack


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


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].

srsBandwidth byte see TS 36.211 [21, table 5.5.3.2-1]. Range: 0 - 3

srsHopBandwidth byte SRS hopping bandwidth, see TS 36.211 [21, 5.5.3.2]. Range: 0 - 3

freqDomainPos byte see TS 36.211 [21, 5.5.3.2]. Range 0




- 23

duration bool see TS 36.213 [21, 8.2]. FALSE corresponds to single and value� � TRUE to indefinite . � �

srsConfigIndex short int ISRS, see TS 36.213 [23, table8.2-1]. Range 0 - 1023

txComb bool Ktc, see TS 36.211 [21, 5.5.3.2]. Values: 0, 1

cyclicShift byte n_alpha_SRS. See TS 36.211 [21, 5.5.3.1], Range: 0 - 7

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


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


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


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�




parameter value is -10.5 + 1.5*pSRS-Offset value.

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


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


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)

C_RNTI unsigned short C-RNTI Range: 0x1 - 0x003C 0x3D-0xFFF3 (0xFFF4-0xFFFD reserved)

T_C_RNTI unsigned short Temporary C-RNTI: Contention Resolution (when no valid C-RNTI is available). Range same as C-RNTI

SPS_RNTI unsigned short Semi-Persistently scheduled unicast




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


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



Remark: during UL Data transfer upon receiving PDCCH DL DCIElement Type Description

newDataIndicator bool Indicates whether the tx data is a fresh transmission

spsActive bool Indicates SPS activate or release when TRUE

isDistributedPRB bool Flag for distributed or localized PRB allocation

modulation byte Modulation type (for PDSCH only, as others are predefined)

harqProcId byte Harq Process Id: 0-7 for FDD and Max of 0-15 for TDD

rvidx byte Redundancy Version

DAI byte Downlink Assignment Index in TDD

numRBs byte Number of RBs allocated

*rbAlloc byte RB Allocation received for the downlink data

RNTI unsigned short 16 bit value

txBlockSize short int Transport Block size in bytes

nCCE byte

precodeInfo byte

pmi byte

2.5.19 mymoUEConfigStruct Configuration of the UE module Direction: NARemark: NA


nSRS bool 0 or 1

rachResponse bool if schedGrant is false, check whether the semi-persistent data belongs to RACH

sync bool Flag to indicate whether UE is in sync with any eNodeB

ulDCIPresent bool Indicates the presence of ulDCI in the received/decoded subframe

subframeNum byte Current DL subframe number: 0 to 9

numDCI byte Number of DCI structures

**dlDCI mymoDLControlConfigStruct list of Downlink DCI structures

ulDCI mymoULControlConfigStruct Uplink DCI structure



2.5.20 mymoCellListStruct Cell List for cell search Direction: Stack To PHYRemark: During Cell Search

Element Type Discription

NumCell unsigned char

enbList[10] mymoENodeBConfigStruct

2.5.21 mymoSubFrameConfigStruct Uplink Configuration for a single subframe processing Direction: Stack To PHYRemark: PUSCH Data for PHY


dataLen int Length of the data

*dataStream byte

cqLen short int Length of CQI/PMI stream

*cqStream byte

riLen short int Length of RankIndicator stream

*riStream byte

hiLen short int Length of HARQ Queue. > 0 indicates presence of HARQ Ack/Nack in the subframe

*harqStream byte

redundancyVersion byte Redundancy Version. Value 0-3

is2BitAck bool TRUE for 2-bit ACK, FALSE for 1-bit ACK

is2BitRI bool TRUE for 2-bit RI, FALSE for 1-bit RI

frequencyHop bool TRUE if frequency hopping is enabled for this transmission - set by the 1 bit info of DCI format 0 in PDCCH

isBitCQI bool TRUE for 20-bit CQI, FALSE for 21-bit or 22-bit CQI with 1 or 2-bit HARQ Ack/Nack

isSR bool TRUE for Scheduling Request

numBits int Total number of bits being transmitted in this subframe

uplink bool TRUE for UE uplink Tx; FALSE for UE DL Rx

subframeNum byte Subframe number for which the UL data is applicable



2.5.22 mymoDLTxConfigStruct DownLink Transmit Buffer module Direction: PHY To StackRemark: PDSCH data from PHY


harqStatus bool 0 for ACK and 1 for NACK

RNTI unsigned short int RNTI corresponding to the Tx Buffer

tbSize short int Current subframe number: 0 to 9

txBuf[TX_BUF_SIZE] byte Number of DCI structures



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.


mymo stack phy api 110826

Documents