NWK data service

The NWK layer data entity SAP (NLDE-SAP) supports the transport of application protocol data units (APDUs) between peer application entities. Table 97 lists the primitives supported by the NLDE-SAP. Each of these primitives will be discussed in the following sub-clauses.

2.3.1.1 NLDE-DATA.request

This primitive requests the transfer of a data PDU (NSDU) from the local APS sub-layer entity to a single or multiple peer APS sub-layer entities.

Table 97 NLDE-SAP Primitives

NLDE-SAP primitive Request Confirm Indication

NLDE-DATA 2.3.1.1 2.3.1.2 2.3.1.3

NWK IB NLME NLDE

Next Higher Layer Entity

NLME-SAP NLDE-SAP

MAC Sub-Layer Entity

MCPS-SAP MLME -SAP

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

2.3.1.1.1 Semantics of the service primitive The semantics of this primitive is as follows:

Table 98 specifies the parameters for the NLDE-DATA.request primitive.

NLDE-DATA.request (

DstAddr, NsduLength, Nsdu, NsduHandle, Radius^a, DiscoverRoute, SecurityEnable )

aCCB Comment #125

Table 98 NLDE-DATA.request parameters

Name Type Valid range Description

DstAddr Network

address

0x0000 – 0xffff The network address of the entity or entities to which the NSDU is being transferred.

NsduLength Integer < aMaxMACFrameSize - nwkcMinHeaderOver-head^a

aCCB Comment #366

The number of octets comprising the NSDU to be transferred.

Nsdu Set of

octets

- The set of octets comprising the NSDU to be transferred.

NsduHandle Integer 0x00 – 0xff The handle associated with the NSDU to be transmitted by the NWK layer entity.

Radius^b

bCCB Comment #125

Unsigned integer

0x00—0xff The distance, in hops, that a frame will be allowed to travel through the net-work.^c

cIbid

DiscoverRoute Integer 0x00-0x02 The DiscoverRoute parameter may be used to control route discovery operations for the transit of this frame (see sub-clause 2.7.3.4).

0x00 = suppress route discovery 0x01 = enable route discovery 0x02 = force route discovery^d

dCCB Comment #256

SecurityEnable Boolean TRUE or FALSE The SecurityEnable parameter may be used to enable NWK layer security processing for the current frame. If the security level speci-fied in the NIB is 0, meaning no security, then this parameter will be ignored. Otherwise, a value of TRUE denotes that the security pro-cessing specified by the security level will be applied and a value of FALSE denotes that no security processing will be applied.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 2.3.1.1.2 When generated

This primitive is generated by a local APS sub-layer entity whenever a data PDU (NSDU) is to be transferred to a peer APS sub-layer entity.

2.3.1.1.3 Effect on receipt

On receipt of this primitive on a device that is not currently associated, the NWK layer will issue an NLDE-DATA.confirm primitive with a status of INVALID_REQUEST.

On receipt of this primitive, the NLDE first constructs an NPDU in order to transmit the supplied NSDU. If, during processing, the NLDE issues the NLDE-DATA.confirm primitive prior to transmission of the NSDU, all further processing is aborted. In constructing the new NPDU, the destination address field of the NWK header will be set to the value provided in the DstAddr parameter and the source address field will have the value of the macShortAddress attribute in the MAC PIB. The discover route sub-field of frame control field of the NWK header will be set to the value provided in the DiscoverRoute parameter. If a value has been supplied for the Radius parameter, that will be placed in the radius field of the NWK header. If a value is not supplied, then the radius field of the NWK header will be set to twice the value of the nwkMaxDepth attribute of the NWK IB. The NWK layer will generate a sequence number for the frame as described in sub-clause 2.7.2.1. The sequence number value shall be inserted into the sequence number field of the NWK header of the frame.⁸⁵ Once the NPDU is constructed, the NSDU is routed using the procedure outline in Figure 57 and described in sub-clause 2.7.3.3. When the routing procedure specifies that the NSDU is to be transmitted, this is accomplished by issuing the MCPS-DATA.request primitive with both the SrcAddrMode and DstAddrMode parameters set to 0x02 indicating the use of 16-bit network addresses.

The SrcPANId and DstPANId parameters should be set to the current value of macPANId from the MAC PIB. The SrcAddr parameter will be set to the value of macShortAddr from the MAC PIB. The value of the DstAddr parameter is the next hop address determined by the routing procedure. The TxOptions parameter should always be non-zero when bitwise ANDed with the value 0x01, denoting that acknowledged transmission is required. On receipt of the MCPS-DATA.confirm primitive, the NLDE issues the NLDE-DATA.confirm primitive with a status equal to that received from the MAC sub-layer.

If the network-wide security level specified in the NIB has a non-zero value and the SecurityEnable parameter has a value of TRUE then NWK layer security processing will be applied to the frame before transmission as described in clause 3.4. Otherwise no security processing will be performed at the NWK layer for this frame. If security processing is done and it fails for any reason, then the frame is discarded and the NLDE issues the NLDE-DATA.confirm primitive with a status parameter value equal to that returned by the security suite.

2.3.1.2 NLDE-DATA.confirm

This primitive reports the results of a request to transfer a data PDU (NSDU) from a local APS sub-layer entity to a single peer APS sub-layer entity.

2.3.1.2.1 Semantics of the service primitive The semantics of this primitive is as follows:

85CCB Comment #101, 109, 125, 111, 256

NLDE-DATA.confirm (

NsduHandle, Status )

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

Table 99 specifies the parameters for the NLDE-DATA.confirm primitive.

2.3.1.2.2 When generated

This primitive is generated by the local NLDE in response to the reception of an NLDE-DATA.request primitive.

The Status field will reflect the status of the corresponding request, as described in sub-clause 2.3.1.1.3.

2.3.1.2.3 Effect on receipt

On receipt of this primitive the APS sub-layer of the initiating device is notified of the result of its request to transmit. If the transmission attempt was successful, the status parameter will be set to SUCCESS.

Otherwise, the status parameter will indicate the error.

2.3.1.3 NLDE-DATA.indication

This primitive indicates the transfer of a data PDU (NSDU) from the NWK layer to the local APS sub-layer entity.

2.3.1.3.1 Semantics of the service primitive The semantics of this primitive is as follows:

Table 99 NLDE-DATA.confirm parameters

Name Type Valid range Description

NsduHandle Integer 0x00 – 0xff The handle associated with the NSDU being confirmed.

Status Status

INVALID_REQUEST, MAX_FRM_COUNTER,

NO_KEY,

BAD_CCM_OUTPUT^a or any status values returned from security suite or the MCPS-DATA.confirm primitive (see

[B1]).

aCCB Comment #159

The status of the corresponding request.

NLDE-DATA.indication (

SrcAddress, NsduLength, Nsdu, LinkQuality }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 Table 100 specifies the parameters for the NLDE-DATA.indication primitive.

2.3.1.3.2 When generated

This primitive is generated by the NLDE and issued to the APS sub-layer on receipt of an appropriately addressed data frame from the local MAC sub-layer entity.

2.3.1.3.3 Effect on receipt

On receipt of this primitive the APS sub-layer is notified of the arrival of data at the device.

2.3.1.3.4 NWK management service

The NWK layer management entity SAP (NLME-SAP) allows the transport of management commands between the next higher layer and the NLME. Table 101 summarizes the primitives supported by the NLME through the NLME-SAP interface. See the following sub-clauses for more details on the individual primitives.

Table 100 NLDE-DATA.indication parameters

Name Type Valid range Description

SrcAddress 16-bit Device address

Any valid device address except the broadcast address.

The individual device address from which the NSDU origi-nated.

NsduLength Integer < aMaxMACFrameSize - nwkcMinHeaderOverhead^a

aCCB Comment #336

The number of octets compris-ing the NSDU becompris-ing indicated.

Nsdu Set of octets - The set of octets comprising the

NSDU being indicated.

LinkQuality Integer 0x00 – 0xff

The link quality indication deliv-ered by the MAC on receipt of this frame as a parameter of the MCPS-DATA.indication primti-tive (see [B1]).

Table 101 Summary of the primitives accessed through the NLME-SAP

Name Request Indication Response Confirm

NLME-NETWORK-DISCOVERY 2.3.2.1 2.3.2.2

NLME-NETWORK-FORMATION 2.3.2.2 2.3.3.2

NLME-PERMIT-JOINING 2.3.6.1 2.3.6.2 2.3.6.3

NLME-START-ROUTER 2.3.5.1 2.3.5.2

NLME-JOIN 2.3.6.1 2.3.6.2 2.3.6.3

NLME-DIRECT-JOIN 2.3.7.1 2.3.7.2

NLME-LEAVE 2.3.8.1 2.3.8.2 2.3.8.3

NLME-RESET 2.3.9.1 2.3.9.2

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54