7 Unknown elementary procedures
37.4663GPPIuant interface: Application partRelease 17TS
Void.
Annex A (normative):
Return codes for secondary devices
Table A.1: Return Codes for Secondary Devices
|
Code |
Name |
Comment |
Alarm |
DownloadMode state |
|
0x00 |
OK |
Normal response |
X |
|
|
0x02 |
Motor Jam |
Motor cannot move |
X |
|
|
0x03 |
ActuatorJam |
Actuator jam has been detected. No movement of the actuator, but movement of the motor was detected |
X |
|
|
0x05 |
Busy |
The device is busy and cannot execute the procedure until an ongoing activity is completed |
||
|
0x06 |
ChecksumError |
Checksum incorrect for otherwise valid data.. |
||
|
0x0B |
FAIL |
Abnormal response. Indicates that a procedure has not been executed successfully |
X |
|
|
0x0E |
NotCalibrated |
The device has not completed a calibration operation, or calibration has been lost |
X |
|
|
0x0F |
NotConfigured |
Actuator configuration data is missing |
X |
|
|
0x11 |
HardwareError |
Any hardware error which cannot be classified. May not be reported as an alarm until the fault is likely to be persistent |
X |
X |
|
0x13 |
OutOfRange |
A parameter given by an operator (e.g. tilt value or memory offset) is out of range |
||
|
0x19 |
UnknownProcedure |
Received procedure code is not defined |
X |
|
|
0x1D |
ReadOnly |
Invalid device data parameter usage |
X |
|
|
0x1E |
UnknownParameter |
Specified parameter is not supported for the used procedure |
X |
|
|
0x21 |
WorkingSoftwareMissing |
The unit is inDownloadMode state. Returned upon unsupported procedure when in DownloadMode state |
X |
|
|
0x22 |
InvalidFileContent |
The data being downloaded is detected to be of wrong format or size |
X |
|
|
0x24 |
FormatError |
Procedure message is inconsistent or if an addressed field or antenna is invalid or the data parameter field length is inconsistent with the corresponding field length parameter |
X |
|
|
0x25 |
UnsupportedProcedure |
The procedure is optional and not supported or the procedure does not apply to this device type |
||
|
0x26 |
InvalidProcedureSequence |
Procedure sequence as described in annex C is expected but not experienced by the secondary device |
||
|
0x27 |
ActuatorInterference |
An actuator movement outside the control of the RET unit has been detected. Probable cause is manual interference |
X |
|
|
0x1A |
MinorTMAFault |
A fault in the TMA subunit is detected which reduces the gain performance but maintains its function. |
x |
|
|
0x1B |
MajorTMAFault |
A fault in the TMA subunit is detected. The fault prevents the function of the TMA subunit. |
x |
|
|
0x1C |
UnsupportedValue |
The requested value is not supported. |
||
|
0x1F |
BypassMode |
The TMA subunit is in bypass mode and cannot report a correct gain value. |
x |
NOTE: A TMA subunit with a fault which is causing it to switch to bypass mode will report both the fault and the BypassMode alarm.
Annex B (normative):
Assigned fields for additional data
The following standard fields have no operational impact and are used by the procedures SetDeviceData, GetDeviceData, AntennaSetDeviceData and AntennaGetDeviceData. Little endian order is used for storage of multiple-octet numbers. Where ASCII variables are shorter than the assigned field lengths the characters are right aligned and leading blanks are filled with null characters (0x00). Unused or not intialized parameter shall return the value 0x00 for the GetDeviceData, AntennaGetDeviceData and TMAGetDeviceData procedure.
Table B.1: Assigned fields for additional data of RETAP
|
Field No. |
Length (octets) |
Format |
Description |
|
0x01 |
15 |
ASCII |
Antenna model number |
|
0x02 |
17 |
ASCII |
Antenna serial number |
|
0x03 |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x08 |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x09 |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x0A |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x0B |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x04 |
8 |
4 x 16-bit unsigned |
Beamwidth for each operating band in band order (deg), beginning with lowest band. The lowest band is transmitted within the first 16-bit value. Not supported in this release |
|
0x05 |
4 |
4 x 8-bit unsigned |
Gain [dBi] for each operating band in band order, expressed in gain value times 10, beginning with the lowest band. The lowest band is transmitted within the first 8-bit value Not supported in this release |
|
0x06 |
2 |
16-bit signed |
Maximum supported electrical tilt [degree], expressed in tilt value times 10, format as in subclause 3.1 |
|
0x07 |
2 |
16-bit signed |
Minimum supported electrical tilt [degree], expressed in tilt value times 10,format as in subclause 3.1 |
|
0x21 |
6 |
ASCII |
Installation date |
|
0x22 |
5 |
ASCII |
Installer’s ID |
|
0x23 |
32 |
ASCII |
Base station ID |
|
0x24 |
32 |
ASCII |
Sector ID |
|
0x25 |
2 |
16-bit unsigned |
Antenna bearing [degree], in the range of 0 – 359,9 degree, expressed as bearing value times 10 |
|
0x26 |
2 |
16-bit signed |
Installed mechanical tilt [degree], expressed in tilt value times 10, format as in subclause 3.1 |
Table B.2: Void
Table B.2-1: Void
Table B.2-2: Void
Table B.2-3: Void
Table B.2-4: Void
The operating bands are defined in subclause 4.3.7 in TS 37.461 [4], an example of operating bands coding is provided in Annex F.
Table B.3: Assigned fields for additional data of TMAAP
|
Field No. |
Length (octets) |
Format |
Description |
|
0x01 |
15 |
ASCII |
Antenna model number |
|
0x02 |
17 |
ASCII |
Antenna serial number |
|
0x03 |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x08 |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x09 |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x0A |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x0B |
2 |
16-bit unsigned |
Antenna operating band(s): Not supported in this release |
|
0x04 |
8 |
4 x 16-bit unsigned |
Beamwidth for each operating band in band order (deg) beginning with lowest band. The lowest band is transmitted within the first 16-bit value. Not supported in this release |
|
0x05 |
4 |
4 x 8-bit unsigned |
Gain [dBi] for each operating band in band order, expressed in gain value times 10, beginning with the lowest band. The lowest band is transmitted within the first 8-bit value Not supported in this release |
|
0x21 |
6 |
ASCII |
Installation date |
|
0x22 |
5 |
ASCII |
Installer’s ID |
|
0x23 |
32 |
ASCII |
Base station ID |
|
0x24 |
32 |
ASCII |
Sector ID |
|
0x25 |
2 |
16-bit unsigned |
Antenna bearing |
|
0x26 |
2 |
16-bit signed |
Installed mechanical tilt (degrees * 10) |
|
0x13 |
1 |
8-bit unsigned |
TMA subunit type (see table B.4) |
|
0x14 |
4 |
2×16-bit unsigned integer |
TMA subunit receive frequency band (see Table B.5) |
|
0x15 |
4 |
2×16-bit unsigned integer |
TMA subunit transmit frequency band (see Table B.5) |
|
0x16 |
1 |
Unsigned integer |
Maximum supported gain given as gain figure expressed in dB/4 |
|
0x17 |
1 |
Unsigned integer |
Minimum supported gain given as gain figure expressed in dB/4 |
|
0x18 |
1 |
Unsigned integer |
Gain resolution given as the gain resolution figure expressed in dB/4 |
Table B.4: Field 0x13 interpretation
|
Bit number |
7… 2 |
1 |
0 |
|
TMA subunit type |
Spare |
Reserved for AISG use |
Bypass |
Bits are numbered from 0….7, bit numbered 0 set to 1 represents the value 0x01.
Bit value 0 represents TMA subunit type is not supported.
Bit value 1 represents TMA subunit type is supported.
Spare bits and Bit 1 shall be set to 0.
Example: 0000 0001 = Bypass
Table B.5: Field 0x14 and 0x15 interpretation
|
Octet number |
Description |
|
0 |
fmin low octet |
|
1 |
fmin high octet |
|
2 |
fmax low octet |
|
3 |
fmax high octet |
fmin and fmax are expressed in 100kHz steps from 0kHz.
Example: For 850MHz, low octet = 0x34, high octet = 0x21.
Annex C (normative):
Procedure sequence for download of software to a secondary device
Figure C.1: Procedure sequence for Software Download
The erasure of the secondary device application software shall not be done before the reception of the Download Application message. The data content of the Download Application message is implementation specific but it is recommended to support an application software validity feature that shall minimise the risk of downloading faulty or invalid application software.
Annex D (informative):
Overview of elementary procedures
Table D.1: Elementary Procedures and Procedure Codes
|
Elementary Procedure |
Procedure Code |
Issued by |
DownloadMode state |
|
Common Procedure Set |
|||
|
(Reserved) |
0x01 |
||
|
Reset Software |
0x03 |
primary device |
Yes |
|
Get Alarm Status |
0x04 |
primary device |
No |
|
Get Information |
0x05 |
primary device |
Yes |
|
Clear Active Alarms |
0x06 |
primary device |
No |
|
Read User Data |
0x10 |
primary device |
No |
|
Write User Data |
0x11 |
primary device |
No |
|
Alarm Subscribe |
0x12 |
primary device |
No |
|
Self Test |
0x0A |
primary device |
No |
|
Download Start |
0x40 |
primary device |
Yes |
|
Download Application |
0x41 |
primary device |
Yes |
|
Download End |
0x42 |
primary device |
Yes |
|
Vendor Specific Procedure |
0x90 |
primary device |
Vendor specific |
|
RETAP Single-Antenna Procedure Set |
|||
|
Set Device Data |
0x0E |
primary device |
No |
|
Get Device Data |
0x0F |
primary device |
No |
|
Calibrate |
0x31 |
primary device |
No |
|
Send Configuration Data |
0x32 |
primary device |
No |
|
Set Tilt |
0x33 |
primary device |
No |
|
Get Tilt |
0x34 |
primary device |
No |
|
Alarm Indication |
0x07 |
secondary device |
No |
|
RETAP Multi-Antenna Procedure Set |
|||
|
Antenna Calibrate |
0x80 |
primary device |
No |
|
Antenna Send Configuration Data |
0x89 |
primary device |
No |
|
Antenna Set Tilt |
0x81 |
primary device |
No |
|
Antenna Get Tilt |
0x82 |
primary device |
No |
|
Antenna Set Device Data |
0x83 |
primary device |
No |
|
Antenna Get Device Data |
0x84 |
primary device |
No |
|
Antenna Alarm Indication |
0x85 |
secondary device |
No |
|
Antenna Clear Active Alarms |
0x86 |
primary device |
No |
|
Antenna Get Alarm Status |
0x87 |
primary device |
No |
|
Antenna Get Number of Antennas |
0x88 |
primary device |
No |
|
TMAAP Procedure Set for multi and single TMA |
|||
|
TMASetMode |
0x70 |
primary device |
No |
|
TMAGetMode |
0x71 |
primary device |
No |
|
TMAGetSupportedFunctions |
0x7A |
primary device |
No |
|
TMASetGain |
0x72 |
primary device |
No |
|
TMAGetGain |
0x73 |
primary device |
No |
|
TMASetDeviceData |
0x74 |
primary device |
No |
|
TMAGetDeviceData |
0x75 |
primary device |
No |
|
TMAAlarmIndication |
0x76 |
secondary device |
No |
|
TMAClearActiveAlarms |
0x77 |
primary device |
No |
|
TMAGetAlarmStatus |
0x78 |
primary device |
No |
|
TMAGetNumberOfSubunits |
0x79 |
primary device |
No |
|
TMAGetSupportedNonLinearGainValues |
0x7B |
primary device |
No |
NOTE: The notion "yes" in the DownloadMode state column indicates that the listed procedures are mandatory if the DownloadMode state can be entered by the secondary device.
Annex E (informative): I-frame and INFO-field format
The I-frame and INFO-field formats for both primary and secondary stations are illustrated. To transfer elementary procedures, the INFO-field of the I-frame is used.
Table E.1: HDLC-Frame:
|
Flag |
ADR |
Control |
INFO |
CRC |
Flag |
||
|
0x7E |
Device Address |
Control bits |
Variable length |
CRC1 |
CRC2 |
0x7E |
|
|
Procedure ID |
Number of data octets |
Data octets |
|
|
1 octet |
low octet |
high octet |
Variable length (must support a maximum length of at least 71 octets) |
Format of the I-Frame and INFO Field
Devices shall support the following data length:
Mandatory: 0 data octets 71
Optional: 0 data octets < 65,536 octets
Annex F (Informative):
Assigned fields for additional data coding for operating bands
NOTE: This Annex is not updated in Rel-16 and onwards.
Table F.1: Band related fields for additional data of RETAP
|
Field No. |
Length (octets) |
Format |
Description |
|
0x03 |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2 below |
|
0x08 |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-1 below |
|
0x09 |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-2 below |
|
0x0A |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-3 below |
|
0x0B |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-4 below |
|
0x04 |
8 |
4 x 16-bit unsigned |
Beamwidth for each operating band in band order (deg), beginning with lowest band. The lowest band is transmitted within the first 16-bit value. (example: width for band I, width for band III) |
|
0x05 |
4 |
4 x 8-bit unsigned |
Gain [dBi] for each operating band in band order , expressed in gain value times 10, beginning with the lowest band. The lowest band is transmitted within the first 8-bit value (example: gain for band I, gain for band III) |
Table F.2: Coding for operating bands in field 0x03
|
Bit no |
15 |
14 |
13 |
12 |
11 |
10 |
9 |
8 |
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|
Operating band UTRA |
Ext. 09 |
Ext. 08 |
XIV |
XIII |
XII |
XI |
X |
IX |
VIII |
VII |
I |
II |
III |
IV |
V |
VI |
|
Operating band E-UTRA |
Ext. 09 |
Ext. 08 |
14 |
13 |
12 |
11 |
10 |
9 |
8 |
7 |
1 |
2 |
3 |
4 |
5 |
6 |
Bit 14 set to "1" indicates that field 0x08 is defined.
Bit 15 set to "1" indicates that field 0x09 is defined.
Table F.2-1: Coding for operating bands in field 0x08
|
Bit no |
15 |
14 |
13 |
12 |
11 |
10 |
9 |
8 |
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|
Operating band UTRA |
– |
– |
– |
– |
XXVI |
XXV |
– |
– |
XXII |
XXI |
XX |
XIX |
XVIII |
XVII |
Res. |
Res. |
|
Operating band E-UTRA |
30 |
29 |
28 |
27 |
26 |
25 |
24 |
23 |
22 |
21 |
20 |
19 |
18 |
17 |
Res. |
Res. |
Table F.2-2: Coding for operating bands in field 0x09
|
Bit no |
15 |
14 |
13 |
12 |
11 |
10 |
9 |
8 |
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|
Operating band UTRA |
Ext 0A |
– |
XXXII |
– |
– |
– |
– |
– |
e |
f |
d |
c |
b)36 |
b)35 |
a)34 |
a)33 |
|
Operating band E-UTRA |
Ext 0A |
65 |
32 |
31 |
44 |
43 |
42 |
41 |
40 |
39 |
38 |
37 |
36 |
35 |
34 |
33 |
Bit 15 set to "1" indicates that field 0x0A is defined.
Table F.2-3: Coding for operating bands in field 0x0A
|
Bit no |
15 |
14 |
13 |
12 |
11 |
10 |
9 |
8 |
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|
Operating band UTRA |
Ext 0B |
– |
– |
– |
– |
– |
– |
– |
– |
– |
– |
– |
– |
– |
– |
– |
|
Operating band E-UTRA |
Ext 0B |
75 |
74 |
72 |
71 |
49 |
51 |
50 |
48 |
69 |
70 |
46 |
68 |
45 |
67 |
66 |
Bit 15 set to "1" indicates that field 0x0B is defined.
Table F.2-4: Coding for operating bands in field 0x0B
|
Bit no |
15 |
14 |
13 |
12 |
11 |
10 |
9 |
8 |
7 |
6 |
5 |
4 |
3 |
2 |
1 |
0 |
|
Operating band UTRA |
Res. |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
– |
– |
– |
– |
|
Operating band E-UTRA |
Res. |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
Spare |
85 |
52 |
73 |
76 |
The operating bands are defined in subclause 4.3.7 in TS 37.461 [4]. In Table F.2-2, the notation a)33 is equivalent to E-UTRA band 33.
Bits are numbered from 0 to 15, bit no 0 set=1 represents the value 0x0001.
Bit set=1 represents operating band is supported.
Bit set=0 represents operating band is not supported.
Spare bits shall be set=0.
Unused Beamwidth and Gain octets shall be set to 0x0000.
Examples of operating bands: 0000 0000 0001 0000 = Operating band II
0000 0000 0011 1000 = Operating band I, II and III
Table F.3: Band relatred fields for additional data of TMAAP
|
Field No. |
Length (octets) |
Format |
Description |
|
0x03 |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2 above |
|
0x08 |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-1 above |
|
0x09 |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-2 above |
|
0x0A |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-3 above |
|
0x0B |
2 |
16-bit unsigned |
Antenna operating band(s): see Table F.2-4 above |
|
0x04 |
8 |
4 x 16-bit unsigned |
Beamwidth for each operating band in band order (deg) beginning with lowest band. The lowest band is transmitted within the first 16-bit value. |
|
0x05 |
4 |
4 x 8-bit unsigned |
Gain [dBi] for each operating band in band order, expressed in gain value times 10, beginning with the lowest band. The lowest band is transmitted within the first 8-bit value (example: gain for band I, gain for band III) |
Annex G (informative):
Change History
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-02 |
R3-103 |
R3-190103 |
Text transferred from 25.466 v15.3.0 (changes shown with rev marks) |
1.15.0 |
|||
|
2019-04 |
RAN#83 |
RP-190606 |
Specification approved by RAN plenary |
15.4.0 |
|||
|
2019-12 |
RP-86 |
RP-192915 |
0001 |
5 |
F |
Correction for Iuant |
15.5.0 |
|
2020-07 |
– |
– |
– |
– |
Update to Rel-16 version (MCC) |
16.0.0 |
|
|
2022-03 |
SA#95-e |
Promotion to Release 17 without technical change |
17.0.0 |
||||