aliro_uwb_msg_spec.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#define ALIRO_HEADER_LENGTH           4
#define ALIRO_ATTRIBUTE_HEADER_LENGTH 2
 
enum aliro_uwb_message_protocol_type {
        ALIRO_UWB_PROTOCOL_TYPE_AP = 0x00,
        ALIRO_UWB_PROTOCOL_TYPE_UWB_RANGING_SERVICE = 0x01,
        ALIRO_UWB_PROTOCOL_TYPE_NOTIFICATION = 0x02,
        ALIRO_UWB_PROTOCOL_TYPE_SUPPLEMENTARY_SERVICE = 0x03,
        ALIRO_UWB_PROTOCOL_TYPE_THIRD_PARTY_APP = 0x04,
};
 
enum aliro_uwb_message_ranging_service {
        ALIRO_UWB_MESSAGE_SETUP_M1 = 0x00,
        ALIRO_UWB_MESSAGE_SETUP_M2 = 0x01,
        ALIRO_UWB_MESSAGE_SETUP_M3 = 0x02,
        ALIRO_UWB_MESSAGE_SETUP_M4 = 0x03,
        ALIRO_UWB_MESSAGE_SUSPEND_REQUEST = 0x04,
        ALIRO_UWB_MESSAGE_SUSPEND_RESPONSE = 0x05,
        ALIRO_UWB_MESSAGE_RESUME_REQUEST = 0x06,
        ALIRO_UWB_MESSAGE_RESUME_RESPONSE = 0x07,
};
 
/* Ranging-service attribute ids. */
enum aliro_uwb_ranging_service_attribute {
        ALIRO_UWB_RANGING_SERVICE_ATTR_CONFIGURATION_IDENTIFIER = 0x00,
        ALIRO_UWB_RANGING_SERVICE_ATTR_PULSE_SHAPE_COMBO = 0x01,
        ALIRO_UWB_RANGING_SERVICE_ATTR_SESSION_IDENTIFIER = 0x02,
        ALIRO_UWB_RANGING_SERVICE_ATTR_CHANNEL_BITMASK = 0x03,
        ALIRO_UWB_RANGING_SERVICE_ATTR_RAN_MULTIPLIER = 0x04,
        ALIRO_UWB_RANGING_SERVICE_ATTR_SLOT_BITMASK = 0x05,
        ALIRO_UWB_RANGING_SERVICE_ATTR_SYNC_CODE_INDEX_BITMASK = 0x06,
        ALIRO_UWB_RANGING_SERVICE_ATTR_SYNC_CODE_INDEX = 0x07,
        ALIRO_UWB_RANGING_SERVICE_ATTR_HOPPING_CONFIGURATION_BITMASK = 0x08,
        ALIRO_UWB_RANGING_SERVICE_ATTR_NUMBER_CHAPS_PER_SLOT = 0x09,
        ALIRO_UWB_RANGING_SERVICE_ATTR_NUMBER_RESPONDERS_NODES = 0x0A,
        ALIRO_UWB_RANGING_SERVICE_ATTR_NUMBER_SLOTS_PER_ROUND = 0x0B,
        ALIRO_UWB_RANGING_SERVICE_ATTR_STS_INDEX0 = 0x0C,
        ALIRO_UWB_RANGING_SERVICE_ATTR_UWB_TIME0 = 0x0D,
        ALIRO_UWB_RANGING_SERVICE_ATTR_HOP_MODE_KEY = 0x0E,
        ALIRO_UWB_RANGING_SERVICE_ATTR_MAC_MODE = 0x0F,
        ALIRO_UWB_RANGING_SERVICE_ATTR_VENDOR_SPECIFIC = 0x10,
        ALIRO_UWB_RANGING_SERVICE_ATTR_STATUS = 0x11,
        ALIRO_UWB_RANGING_SERVICE_ATTR_MAX = 0x12,
};
 
#define ALIRO_UWB_RANGING_SERVICE_STATUS_ACCEPT  0
#define ALIRO_UWB_RANGING_SERVICE_STATUS_REJECT  1
#define ALIRO_UWB_RANGING_SERVICE_STATUS_UNKNOWN 0xFF
 
enum aliro_uwb_message_notification {
        ALIRO_UWB_MESSAGE_NOTIFICATION_EVENT = 0x00,
        ALIRO_UWB_MESSAGE_NOTIFICATION_RANGING = 0x01,
        ALIRO_UWB_MESSAGE_NOTIFICATION_READER_STATUS_CHANGED = 0x02,
        ALIRO_UWB_MESSAGE_NOTIFICATION_READER_STATUS_AP = 0x03,
        ALIRO_UWB_MESSAGE_NOTIFICATION_PKE_REQUEST = 0x04,
        ALIRO_UWB_MESSAGE_NOTIFICATION_INITIATE_AP = 0x05,
        ALIRO_UWB_MESSAGE_NOTIFICATION_INITIATE_AP_RKE = 0x06,
};
 
#define ALIRO_UWB_NOTIFICATION_ATTR_EVENT_BUSY_LENGTH          0
#define ALIRO_UWB_NOTIFICATION_ATTR_EVENT_GENERAL_ERROR_LENGTH 1
 
enum aliro_uwb_message_notification_event_attribute {
        ALIRO_UWB_MESSAGE_NOTIFICATION_EVENT_ATTR_BUSY = 0x00,
        ALIRO_UWB_MESSAGE_NOTIFICATION_EVENT_ATTR_GENERAL_ERROR = 0x01,
        ALIRO_UWB_MESSAGE_NOTIFICATION_EVENT_ATTR_READER_DESCRIPTOR = 0x02,
};
 
#define ALIRO_UWB_NOTIFICATION_GENERAL_ERROR_UNKNOWN              0
#define ALIRO_UWB_NOTIFICATION_GENERAL_ERROR_RESOURCE_UNAVAILABLE 1
#define ALIRO_UWB_NOTIFICATION_GENERAL_ERROR_WRONG_PARAMS         2
#define ALIRO_UWB_NOTIFICATION_GENERAL_ERROR_URSK_UNAVAILABLE     3
 
enum aliro_uwb_message_notification_ranging_attribute {
        ALIRO_UWB_MESSAGE_NOTIFICATION_RANGING_ATTR_INIT_RANGING = 0x00,
        ALIRO_UWB_MESSAGE_NOTIFICATION_RANGING_ATTR_INIT_RANGING_RESUME = 0x01,
        ALIRO_UWB_MESSAGE_NOTIFICATION_RANGING_ATTR_INIT_RANGING_SETUP_LATER = 0x02,
        ALIRO_UWB_MESSAGE_NOTIFICATION_RANGING_ATTR_INIT_RANGING_RESUME_LATER = 0x03,
        ALIRO_UWB_MESSAGE_NOTIFICATION_RANGING_ATTR_SECURE_RANGING_FAILED = 0x04,
        ALIRO_UWB_MESSAGE_NOTIFICATION_RANGING_ATTR_RANGING_SUSPENDED = 0x05,
};
 
/* Fixed per-attribute value lengths (octets). */
#define ALIRO_UWB_RANGING_SERVICE_ATTR_CONFIGURATION_IDENTIFIER_LENGTH      2
#define ALIRO_UWB_RANGING_SERVICE_ATTR_PULSE_SHAPE_COMBO_LENGTH             1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_SESSION_IDENTIFIER_LENGTH            4
#define ALIRO_UWB_RANGING_SERVICE_ATTR_CHANNEL_BITMASK_LENGTH               1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_RAN_MULTIPLIER_LENGTH                1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_SLOT_BITMASK_LENGTH                  1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_SYNC_CODE_INDEX_BITMASK_LENGTH       4
#define ALIRO_UWB_RANGING_SERVICE_ATTR_SYNC_CODE_INDEX_LENGTH               1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_HOPPING_CONFIGURATION_BITMASK_LENGTH 1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_NUMBER_CHAPS_PER_SLOT_LENGTH         1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_NUMBER_RESPONDERS_NODES_LENGTH       1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_NUMBER_SLOTS_PER_ROUND_LENGTH        1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_STS_INDEX0_LENGTH                    4
#define ALIRO_UWB_RANGING_SERVICE_ATTR_UWB_TIME0_LENGTH                     8
#define ALIRO_UWB_RANGING_SERVICE_ATTR_HOP_MODE_KEY_LENGTH                  4
#define ALIRO_UWB_RANGING_SERVICE_ATTR_MAC_MODE_LENGTH                      1
#define ALIRO_UWB_RANGING_SERVICE_ATTR_VENDOR_SPECIFIC_OUI_CID_LENGTH       3
#define ALIRO_UWB_RANGING_SERVICE_ATTR_STATUS_LENGTH                        1