Status Codes#
Status Codes contains error and status code definitions used by Simplicity SDK software components and stacks. This module also provides routines to read the string linked with the error and status codes.
Typedefs#
define global status variable.
Functions#
Macros#
sl status space mask.
sl status generic space.
sl status platform 1 space.
sl status platform 2 space.
sl status hardware space.
sl status bluetooth space.
sl status bluetooth mesh space.
sl status can canopen space.
sl status connect space.
sl status net suite space.
sl status thread space.
sl status usb space.
sl status wifi space.
sl status zigbee space.
sl status z wave space.
sl status gecko os 1 space.
sl status gecko os 2 space.
sl status bluetooth ctrl space.
sl status bluetooth att space.
sl status bluetooth mesh foundation space.
sl status bluetooth mesh foundation space.
sl status wisun space.
sl status compute space.
No error.
Generic error.
Generic invalid state error.
Module is not ready for requested operation.
Module is busy and cannot carry out requested operation.
Operation is in progress and not yet complete (pass or fail).
Operation aborted.
Operation timed out.
Operation not allowed per permissions.
Non-blocking operation would block.
Operation/module is Idle, cannot carry requested operation.
Operation cannot be done while construct is waiting.
No task/construct waiting/pending for that action/event.
Operation cannot be done while construct is suspended.
Feature not available due to software configuration.
Feature not supported.
Initialization failed.
Module has not been initialized.
Module has already been initialized.
Object/construct has been deleted.
Illegal call from ISR.
Illegal call because network is up.
Illegal call because network is down.
Failure due to not being joined in a network.
Invalid operation as there are no beacons.
Generic allocation error.
No more resource available to perform the operation.
Item/list/queue is empty.
Item/list/queue is full.
Item would overflow.
Item/list/queue has been overflowed.
Generic ownership error.
Already/still owning resource.
Generic invalid argument or consequence of invalid argument.
Invalid null pointer received as argument.
Invalid configuration provided.
Invalid mode.
Invalid handle.
Invalid type for operation.
Invalid index.
Invalid range.
Invalid key.
Invalid credentials.
Invalid count.
Invalid signature / verification failed.
Item could not be found.
Item already exists.
Generic I/O failure.
I/O failure due to timeout.
Generic transmission error.
Transmit underflowed.
Transmit is incomplete.
Transmit is busy.
Generic reception error.
Failed to read on/via given object.
Failed to write on/via given object.
Message is too long.
EEPROM MFG version mismatch.
EEPROM Stack version mismatch.
Flash write is inhibited.
Flash verification failed.
Flash programming failed.
Flash erase failed.
MAC no data.
MAC no ACK received.
MAC indirect timeout.
MAC unknown header type.
MAC ACK unknown header type.
MAC command transmit failure.
Error in open NVM.
Image checksum is not valid.
Decryption failed.
Command was not recognized.
Command or parameter maximum length exceeded.
Data received does not form a complete command.
Bus error, e.g. invalid DMA address.
CCA failure.
MAC scanning.
MAC incorrect scan type.
Invalid channel mask.
Bad scan duration.
The MAC transmit queue is full.
The transmit attempt failed because the radio scheduler could not find a slot to transmit this packet in or a higher priority event interrupted it.
An unsupported channel setting was specified.
An unsupported power setting was specified.
The expected ACK was received after the last transmission.
The transmit attempt was blocked from going over the air. Typically this is due to the Radio Hold Off (RHO) or Coexistence plugins as they can prevent transmits based on external signals.
The initialization was aborted as the NVM3 instance is not aligned properly in memory.
The initialization was aborted as the size of the NVM3 instance is too small.
The initialization was aborted as the NVM3 page size is not supported.
The application that there was an error initializing some of the tokens.
The initialization was aborted as the NVM3 instance was already opened with other parameters.
Bonding procedure can't be started because device has no space left for bond.
Unspecified error.
Hardware failure.
The bonding does not exist.
Error using crypto functions.
Data was corrupted.
Invalid periodic advertising sync handle.
Bluetooth cannot be used on this hardware.
Error received from radio.
Returned when remote disconnects the connection-oriented channel by sending disconnection request.
Returned when local host disconnect the connection-oriented channel by sending disconnection request.
Returned when local host did not find a connection-oriented channel with given destination CID.
Returned when connection-oriented channel disconnected due to LE connection is dropped.
Returned when connection-oriented channel disconnected due to remote end send data even without credit.
Returned when connection-oriented channel disconnected due to remote end send flow control credits exceed 65535.
Returned when connection-oriented channel has run out of flow control credit and local application still trying to send data.
Returned when connection-oriented channel has not received connection response message within maximum timeout.
Returned when local host received a connection-oriented channel connection response with an invalid destination CID.
Returned when local host application tries to send a command which is not suitable for L2CAP channel's current state.
Flash reserved for PS store is full.
PS key not found.
Mismatched or insufficient security level.
Encryption/decryption operation failed.
Connection does not exist, or connection open request was cancelled.
Pairing or authentication failed due to incorrect results in the pairing or authentication procedure. This could be due to an incorrect PIN or Link Key.
Pairing failed because of missing PIN, or authentication failed because of missing Key.
Controller is out of memory.
Link supervision timeout has expired.
Controller is at limit of connections it can support.
The Synchronous Connection Limit to a Device Exceeded error code indicates that the Controller has reached the limit to the number of synchronous connections that can be achieved to a device.
The ACL Connection Already Exists error code indicates that an attempt to create a new ACL Connection to a device when there is already a connection to this device.
Command requested cannot be executed because the Controller is in a state where it cannot process this command at this time.
The Connection Rejected Due To Limited Resources error code indicates that an incoming connection was rejected due to limited resources.
The Connection Rejected Due To Security Reasons error code indicates that a connection was rejected due to security requirements not being fulfilled, like authentication or pairing.
The Connection was rejected because this device does not accept the BD_ADDR. This may be because the device will only accept connections from specific BD_ADDRs.
The Connection Accept Timeout has been exceeded for this connection attempt.
A feature or parameter value in the HCI command is not supported.
Command contained invalid parameters.
User on the remote device terminated the connection.
The remote device terminated the connection because of low resources.
Remote Device Terminated Connection due to Power Off.
Local device terminated the connection.
The Controller is disallowing an authentication or pairing procedure because too little time has elapsed since the last authentication or pairing attempt failed.
The device does not allow pairing. This can be for example, when a device only allows pairing during a certain time window after some user input allows pairing.
The remote device does not support the feature associated with the issued command.
No other error code specified is appropriate to use.
Connection terminated due to link-layer procedure timeout.
LL procedure has collided with the same transaction or procedure that is already in progress.
The requested encryption mode is not acceptable at this time.
Link key cannot be changed because a fixed unit key is being used.
LMP PDU or LL PDU that includes an instant cannot be performed because the instant when this would have occurred has passed.
It was not possible to pair as a unit key was requested and it is not supported.
LMP transaction was started that collides with an ongoing transaction.
The Controller cannot perform channel assessment because it is not supported.
The HCI command or LMP PDU sent is only possible on an encrypted link.
A parameter value requested is outside the mandatory range of parameters for the given HCI command or LMP PDU.
The IO capabilities request or response was rejected because the sending Host does not support Secure Simple Pairing even though the receiving Link Manager does.
The Host is busy with another pairing operation and unable to support the requested pairing. The receiving device should retry pairing again later.
The Controller could not calculate an appropriate value for the Channel selection operation.
Operation was rejected because the controller is busy and unable to process the request.
Remote device terminated the connection because of an unacceptable connection interval.
Advertising for a fixed duration completed or, for directed advertising, that advertising completed without a connection being created.
Connection was terminated because the Message Integrity Check (MIC) failed on a received packet.
LL initiated a connection but the connection has failed to be established. Controller did not receive any packets from remote end.
The MAC of the 802.11 AMP was requested to connect to a peer, but the connection failed.
The master, at this time, is unable to make a coarse adjustment to the piconet clock, using the supplied parameters. Instead the master will attempt to move the clock using clock dragging.
A command was sent from the Host that should identify an Advertising or Sync handle, but the Advertising or Sync handle does not exist.
Number of operations requested has been reached and has indicated the completion of the activity (e.g., advertising or scanning).
A request to the Controller issued by the Host and still pending was successfully canceled.
An attempt was made to send or receive a packet that exceeds the maximum allowed packet length.
Information was provided too late to the controller.
Information was provided too early to the controller.
The attribute handle given was not valid on this server.
The attribute cannot be read.
The attribute cannot be written.
The attribute PDU was invalid.
The attribute requires authentication before it can be read or written.
Attribute Server does not support the request received from the client.
Offset specified was past the end of the attribute.
The attribute requires authorization before it can be read or written.
Too many prepare writes have been queued.
No attribute found within the given attribute handle range.
The attribute cannot be read or written using the Read Blob Request.
The Encryption Key Size used for encrypting this link is insufficient.
The attribute value length is invalid for the operation.
The attribute request that was requested has encountered an error that was unlikely, and therefore could not be completed as requested.
The attribute requires encryption before it can be read or written.
The attribute type is not a supported grouping attribute as defined by a higher layer specification.
Insufficient Resources to complete the request.
The server requests the client to rediscover the database.
The attribute parameter value was not allowed.
When this is returned in a BGAPI response, the application tried to read or write the value of a user attribute from the GATT database.
The requested write operation cannot be fulfilled for reasons other than permissions.
The Client Characteristic Configuration descriptor is not configured according to the requirements of the profile or service.
The profile or service request cannot be serviced because an operation that has been previously triggered is still in progress.
The attribute value is out of range as defined by a profile or service specification.
The user input of passkey failed, for example, the user cancelled the operation.
Out of Band data is not available for authentication.
The pairing procedure cannot be performed as authentication requirements cannot be met due to IO capabilities of one or both devices.
The confirm value does not match the calculated compare value.
Pairing is not supported by the device.
The resultant encryption key size is insufficient for the security requirements of this device.
The SMP command received is not supported on this device.
Pairing failed due to an unspecified reason.
Pairing or authentication procedure is disallowed because too little time has elapsed since last pairing request or security request.
The Invalid Parameters error code indicates: the command length is invalid or a parameter is outside of the specified range.
Indicates to the remote device that the DHKey Check value received doesn't match the one calculated by the local device.
Indicates that the confirm values in the numeric comparison protocol do not match.
Indicates that the pairing over the LE transport failed due to a Pairing Request sent over the BR/EDR transport in process.
Indicates that the BR/EDR Link Key generated on the BR/EDR transport cannot be used to derive and distribute keys for the LE transport.
Indicates that the device chose not to accept a distributed key.
Returned when trying to add a key or some other unique resource with an ID which already exists.
Returned when trying to manipulate a key or some other resource with an ID which does not exist.
Returned when an operation cannot be executed because a pre-configured limit for keys, key bindings, elements, models, virtual addresses, provisioned devices, or provisioning sessions is reached.
Returned when trying to use a reserved address or add a "pre-provisioned" device using an address already used by some other device.
In a BGAPI response, the user supplied malformed data; in a BGAPI event, the remote end responded with malformed or unrecognized data.
An attempt was made to initialize a subsystem that was already initialized.
An attempt was made to use a subsystem that wasn't initialized yet. Call the subsystem's init function first.
Returned when trying to establish a friendship as a Low Power Node, but no acceptable friend offer message was received.
Provisioning link was unexpectedly closed before provisioning was complete.
An unrecognized provisioning PDU was received.
A provisioning PDU with wrong length or containing field values that are out of bounds was received.
An unexpected (out of sequence) provisioning PDU was received.
The computed confirmation value did not match the expected value.
Provisioning could not be continued due to insufficient resources.
The provisioning data block could not be decrypted.
An unexpected error happened during provisioning.
Device could not assign unicast addresses to all of its elements.
Returned when trying to reuse an address of a previously deleted device before an IV Index Update has been executed.
Returned when trying to assign an address that is used by one of the devices in the Device Database, or by the Provisioner itself.
Application key or publish address are not set.
Application key is not bound to a model.
Returned when address in request was not valid.
Returned when model identified is not found for a given element.
Returned when the key identified by AppKeyIndex is not stored in the node.
Returned when the key identified by NetKeyIndex is not stored in the node.
Returned when The node cannot serve the request due to insufficient resources.
Returned when the key identified is already stored in the node and the new NetKey value is different.
Returned when the model does not support the publish mechanism.
Returned when the model does not support the subscribe mechanism.
Returned when storing of the requested parameters failed.
Returned when requested setting is not supported.
Returned when the requested update operation cannot be performed due to general constraints.
Returned when the requested delete operation cannot be performed due to general constraints.
Returned when the requested bind operation cannot be performed due to general constraints.
Returned when The node cannot start advertising with Node Identity or Proxy since the maximum number of parallel advertising is reached.
Returned when the requested state cannot be set.
Returned when an unspecified error took place.
Returned when the NetKeyIndex and AppKeyIndex combination is not valid for a Config AppKey Update.
Invalid firmware keyset.
The firmware download took too long.
Unknown request ID or wrong interface ID used.
The request is successful but some parameters have been ignored.
No Packets waiting to be received.
The sleep mode is granted.
The WFx does not go back to sleep.
The SecureLink MAC key was not found.
The SecureLink MAC key is already installed in OTP.
The SecureLink MAC key cannot be installed in RAM.
The SecureLink MAC key installation failed.
SecureLink key (re)negotiation failed.
The device is in an inappropriate state to perform the request.
The request failed due to regulatory limitations.
The connection request failed because no suitable AP was found.
The connection request was aborted by host.
The connection request failed because of a timeout.
The connection request failed because the AP rejected the device.
The connection request failed because the WPA handshake did not complete successfully.
The request failed because the retry limit was exceeded.
The request failed because the MSDU life time was exceeded.
Critical fault.
ALU operation output NaN.
ALU numeric overflow.
ALU numeric underflow.
Overflow during array store.
Underflow during array store conversion.
Infinity encountered during array store conversion.
NaN encountered during array store conversion.
MATH NaN encountered.
MATH Infinity encountered.
MATH numeric overflow.
MATH numeric underflow.
Packet is dropped by packet-handoff callbacks.
The APS layer attempted to send or deliver a message and failed.
The maximum number of in-flight messages ::EMBER_APS_UNICAST_MESSAGE_COUNT has been reached.
The application is trying to delete or overwrite a binding that is in use.
The application is trying to overwrite an address table entry that is in use.
After moving, a mobile node's attempt to re-establish contact with the network failed.
The local node ID has changed. The application can get the new node ID by calling ::sl_zigbee_get_node_id()
The chosen security level is not supported by the stack.
An error occurred when trying to encrypt at the APS Level.
An error occurred when trying to encrypt at the APS Level.
There was an attempt to form or join a network with security without calling ::sl_zigbee_set_initial_security_state() first.
There was an attempt to broadcast a key switch too quickly after broadcasting the next network key. The Trust Center must wait at least a period equal to the broadcast timeout so that all routers have a chance to receive the broadcast of the new network key.
The received signature corresponding to the message that was passed to the CBKE Library failed verification and is not valid.
The message could not be sent because the link key corresponding to the destination is not authorized for use in APS data messages.
The application tried to use a binding that has been remotely modified and the change has not yet been reported to the application.
The EUI of the Trust center has changed due to a successful rejoin after TC Swapout.
A Trust Center Swapout Rejoin has occurred without the EUI of the TC changing.
An attempt to generate random bytes failed because of insufficient random data from the radio.
A Zigbee route error command frame was received indicating that a source routed message from this node failed en route.
A Zigbee route error command frame was received indicating that a message sent to this node along a many-to-one route failed en route.
A critical and fatal error indicating that the version of the stack trying to run does not match with the chip it's running on.
The local PAN ID has changed. The application can get the new PAN ID by calling ::emberGetPanId()
The channel has changed.
The network has been opened for joining.
The network has been closed for joining.
An attempt was made to join a Secured Network using a pre-configured key, but the Trust Center sent back a Network Key in-the-clear when an encrypted Network Key was required. (::EMBER_REQUIRE_ENCRYPTED_KEY)
An attempt was made to join a Secured Network, but the device did not receive a Network Key.
After a device joined a Secured Network, a Link Key was requested (::EMBER_GET_LINK_KEY_WHEN_JOINING) but no response was ever received.
An attempt was made to join a Secured Network without a pre-configured key, but the Trust Center sent encrypted data using a pre-configured key.
A Zigbee EZSP error has occured. Track the origin and corresponding EzspStatus for more info.
Function Documentation#
sl_status_get_string_n#
int32_t sl_status_get_string_n (sl_status_t status, char * buffer, uint32_t buffer_length)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_status_t | N/A | status | The status code from which to obtain the status string. |
| char * | N/A | buffer | Pointer to a buffer in which the status string will be copied. A terminating null-character will be appended after the copied status string. |
| uint32_t | N/A | buffer_length | Maximum number of characters that can be written in the buffer, including the terminating null-character. If the status string would be longer than the available length, it will be truncated and a null-terminating character will be the last character contained in the buffer. |
Get a copy of the status string associated to the status code passed, up to 'buffer_length' length, if the string associated to the status code is enabled. If not, the error code number, in hex, prefixed by "SL_STATUS_" will be copied in the buffer instead. For example, the buffer would either contain "SL_STATUS_FAIL" if that status string is enabled, or "SL_STATUS_0x0001" if the string is disabled, as SL_STATUS_FAIL's value is 0x0001.
Returns
The number of characters that would have been written if the buffer_length had been sufficiently large, not counting the terminating null character. If the status code is invalid, 0 or a negative number is returned. Notice that only when this returned value is strictly positive and less than buffer_length, the status string has been completely written in the buffer.
sl_status_print#
void sl_status_print (sl_status_t status)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_status_t | N/A | status | The status code of which to print the status string. |
Print, through printf, the string associated to the passed status code. If the string associated to the status code is enabled, the status string will be printed, for example "SL_STATUS_OK". If the string associated to the status code is disabled, the status number, in hex, prefixed by "SL_STATUS_" will be printed instead, for example "SL_STATUS_0x0000", as SL_STATUS_OK's value is 0x0000.