1.3.5.1.8 MAC_RF_PIB_ATTRIBUTE Enum

C

typedef enum
{
    MAC_PIB_DSN_RF = 0x00000200,
    MAC_PIB_MAX_BE_RF = 0x00000201,
    MAC_PIB_MAX_CSMA_BACKOFFS_RF = 0x00000202,
    MAC_PIB_MAX_FRAME_RETRIES_RF = 0x00000203,
    MAC_PIB_MIN_BE_RF = 0x00000204,
    MAC_PIB_TIMESTAMP_SUPPORTED_RF = 0x00000205,
    MAC_PIB_DEVICE_TABLE_RF = 0x00000206,
    MAC_PIB_FRAME_COUNTER_RF = 0x00000207,
    MAC_PIB_DUPLICATE_DETECTION_TTL_RF = 0x00000208,
    MAC_PIB_COUNTER_OCTETS_RF = 0x00000209,
    MAC_PIB_RETRY_COUNT_RF = 0x0000020A,
    MAC_PIB_MULTIPLE_RETRY_COUNT_RF = 0x0000020B,
    MAC_PIB_TX_FAIL_COUNT_RF = 0x0000020C,
    MAC_PIB_TX_SUCCESS_COUNT_RF = 0x0000020D,
    MAC_PIB_FCS_ERROR_COUNT_RF = 0x0000020E,
    MAC_PIB_SECURITY_FAILURE_COUNT_RF = 0x0000020F,
    MAC_PIB_DUPLICATE_FRAME_COUNT_RF = 0x00000210,
    MAC_PIB_RX_SUCCESS_COUNT_RF = 0x00000211,
    MAC_PIB_NACK_COUNT_RF = 0x00000212,
    MAC_PIB_USE_ENHANCED_BEACON_RF = 0x00000213,
    MAC_PIB_EB_HEADER_IE_LIST_RF = 0x00000214,
    MAC_PIB_EB_PAYLOAD_IE_LIST_RF = 0x00000215,
    MAC_PIB_EB_FILTERING_ENABLED_RF = 0x00000216,
    MAC_PIB_EBSN_RF = 0x00000217,
    MAC_PIB_EB_AUTO_SA_RF = 0x00000218,
    MAC_PIB_SEC_SECURITY_LEVEL_LIST_RF = 0x0000021A,
    MAC_PIB_POS_TABLE_RF = 0x0000021D,
    MAC_PIB_OPERATING_MODE_RF = 0x0000021E,
    MAC_PIB_CHANNEL_NUMBER_RF = 0x0000021F,
    MAC_PIB_DUTY_CYCLE_USAGE_RF = 0x00000220,
    MAC_PIB_DUTY_CYCLE_PERIOD_RF = 0x00000221,
    MAC_PIB_DUTY_CYCLE_LIMIT_RF = 0x00000222,
    MAC_PIB_DUTY_CYCLE_THRESHOLD_RF = 0x00000223,
    MAC_PIB_DISABLE_PHY_RF = 0x00000224,
    MAC_PIB_FREQUENCY_BAND_RF = 0x00000225,
    MAC_PIB_TRANSMIT_ATTEN_RF = 0x00000226,
    MAC_PIB_ADAPTIVE_POWER_STEP_RF = 0x00000227,
    MAC_PIB_ADAPTIVE_POWER_HIGH_BOUND_RF = 0x00000228,
    MAC_PIB_ADAPTIVE_POWER_LOW_BOUND_RF = 0x00000229,
    MAC_PIB_POS_RECENT_ENTRIES_RF = 0x0000022A,

    // Manufacturer specific
    // Resets the device table upon a GMK activation.
    MAC_PIB_MANUF_SECURITY_RESET_RF = 0x08000203,
    // Indicates whether an LBP frame for other destination has been received
    MAC_PIB_MANUF_LBP_FRAME_RECEIVED_RF = 0x08000204,
    // Indicates whether an LBP frame for other destination has been received
    MAC_PIB_MANUF_LNG_FRAME_RECEIVED_RF = 0x08000205,
    // Indicates whether an Beacon frame from other nodes has been received
    MAC_PIB_MANUF_BCN_FRAME_RECEIVED_RF = 0x08000206,
    // Gets number of discarded packets due to Other Destination
    MAC_PIB_MANUF_RX_OTHER_DESTINATION_COUNT_RF = 0x08000207,
    // Gets number of discarded packets due to Invalid Frame Lenght
    MAC_PIB_MANUF_RX_INVALID_FRAME_LENGTH_COUNT_RF = 0x08000208,
    // Gets number of discarded packets due to Wrong Addressing Mode
    MAC_PIB_MANUF_RX_WRONG_ADDR_MODE_COUNT_RF = 0x08000209,
    // Gets number of discarded packets due to Unsupported Security
    MAC_PIB_MANUF_RX_UNSUPPORTED_SECURITY_COUNT_RF = 0x0800020A,
    // Gets number of discarded packets due to Wrong Key Id
    MAC_PIB_MANUF_RX_WRONG_KEY_ID_COUNT_RF = 0x0800020B,
    // Gets number of discarded packets due to Invalid Key
    MAC_PIB_MANUF_RX_INVALID_KEY_COUNT_RF = 0x0800020C,
    // Gets number of discarded packets due to Wrong Frame Counter
    MAC_PIB_MANUF_RX_WRONG_FC_COUNT_RF = 0x0800020D,
    // Gets number of discarded packets due to Decryption Error
    MAC_PIB_MANUF_RX_DECRYPTION_ERROR_COUNT_RF = 0x0800020E,
    // Gets number of transmitted Data packets
    MAC_PIB_MANUF_TX_DATA_PACKET_COUNT_RF = 0x0800020F,
    // Gets number of received Data packets
    MAC_PIB_MANUF_RX_DATA_PACKET_COUNT_RF = 0x08000210,
    // Gets number of transmitted Command packets
    MAC_PIB_MANUF_TX_CMD_PACKET_COUNT_RF = 0x08000211,
    // Gets number of received Command packets
    MAC_PIB_MANUF_RX_CMD_PACKET_COUNT_RF = 0x08000212,
    // Gets number of Channel Access failures
    MAC_PIB_MANUF_CSMA_FAIL_COUNT_RF = 0x08000213,
    // Gets number of received broadcast packets
    MAC_PIB_MANUF_RX_DATA_BROADCAST_COUNT_RF = 0x08000214,
    // Gets number of transmitted broadcast packets
    MAC_PIB_MANUF_TX_DATA_BROADCAST_COUNT_RF = 0x08000215,
    // Gets number of received packets with wrong CRC
    MAC_PIB_MANUF_BAD_CRC_COUNT_RF = 0x08000216,
    // Enables MAC Sniffer
    MAC_PIB_MANUF_ENABLE_MAC_SNIFFER_RF = 0x08000217,
    // Gets number of valid elements in the POS Table
    MAC_PIB_MANUF_POS_TABLE_COUNT_RF = 0x08000218,
    // Gets internal MAC version
    MAC_PIB_MANUF_MAC_INTERNAL_VERSION_RF = 0x08000219,
    // Resets MAC statistics
    MAC_PIB_MANUF_RESET_MAC_STATS_RF = 0x0800021A,
    // Provides access to POS table by short address (referenced as index)
    MAC_PIB_MANUF_POS_TABLE_ELEMENT_RF = 0x0800021B,
    // Configures time between a received frame and the transmission of its ACK
    MAC_PIB_MANUF_ACK_TX_DELAY_RF = 0x0800021C,
    // Configures time to wait for a requested ACK before timing out
    MAC_PIB_MANUF_ACK_RX_WAIT_TIME_RF = 0x0800021D,
    // Configures time to wait for an ACK Confirm before timing out
    MAC_PIB_MANUF_ACK_CONFIRM_WAIT_TIME_RF = 0x0800021E,
    // Configures time to wait for a Data Confirm before timing out
    MAC_PIB_MANUF_DATA_CONFIRM_WAIT_TIME_RF = 0x0800021F,
    // RF Interface availability. 8 bits (bool).
    MAC_PIB_MANUF_RF_IFACE_AVAILABLE = 0x08000221,
    // Last PLC frame duration in ms. 16 bits.
    MAC_PIB_MANUF_LAST_FRAME_DURATION_RF = 0x08000222,
    // Minimum LQI to consider a neighbour for Trickle
    MAC_PIB_MANUF_TRICKLE_MIN_LQI_RF = 0x08000223,
    // Gets or sets a parameter in Phy layer. Index will be used to contain PHY parameter ID
    MAC_PIB_MANUF_PHY_PARAM_RF = 0x08000220
} MAC_RF_PIB_ATTRIBUTE;

Summary

Lists the available objects in the MAC RF Parameter Information Base (PIB).

Description

MAC PIB is a collection of objects that can be read/written in order to retrieve information and/or configure the MAC layer.

AttributeSizeDefault ValueDescription
MAC_PIB_DSN_RF8 bitsRandomData or command frame sequence number
MAC_PIB_MAX_BE_RF8 bits8Maximum value of back-off exponent. It should always be greater or equal than macMinBE.
MAC_PIB_MAX_CSMA_BACKOFFS_RF8 bits50Maximum number of back-off attempts
MAC_PIB_MAX_FRAME_RETRIES_RF8 bits5Maximum number of retransmission
MAC_PIB_MIN_BE_RF8 bits3Minimum value of back-off exponent
MAC_PIB_TIMESTAMP_SUPPORTED_RF8 bits (bool)FalseMAC frame time stamp support enable (read only)
MAC_PIB_DEVICE_TABLE_RF6 Byte entries.EmptyThe Device table as defined in
MAC_PIB_FRAME_COUNTER_RF32 bits0The outgoing frame counter for this device
MAC_PIB_DUPLICATE_DETECTION_TTL_RF8 bits3Time a received tuple is retained for duplicate frame detection, in seconds
MAC_PIB_COUNTER_OCTETS_RF8 bits4Size of MAC Counters (read only)
MAC_PIB_RETRY_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_MULTIPLE_RETRY_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_TX_FAIL_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_TX_SUCCESS_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_FCS_ERROR_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_SECURITY_FAILURE_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_DUPLICATE_FRAME_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_RX_SUCCESS_COUNT_RF32 bits0Statistics Counter as defined in
MAC_PIB_USE_ENHANCED_BEACON_RF8 bits (bool)TrueUsage of Enhanced Beacon (read only)
MAC_PIB_EB_HEADER_IE_LIST_RFArray of 8 bit elementsN/ACurrently supported Header IEs
MAC_PIB_EB_PAYLOAD_IE_LIST_RFArray of 8 bit elementsEmptyCurrently supported Payload IEs, is always empty
MAC_PIB_EB_FILTERING_ENABLED_RF8 bits (bool)FalseAlways false as no filtering is supported
MAC_PIB_EBSN_RF8 bitsRandomEnahnced Beacon frame sequence number
MAC_PIB_EB_AUTO_SA_RF8 bits2Always set to MAC_ADDRESS_MODE_SHORT (2)
MAC_PIB_SEC_SECURITY_LEVEL_LIST_RF4 Byte entries.N/AFixed list describing expected Security behaviour, see G3 Spec for details
MAC_PIB_POS_TABLE_RF9 Byte entries.EmptyThe RF MAC POS Table
MAC_PIB_OPERATING_MODE_RF8 bits1The RF operating mode as defined in clause 19.3 of
MAC_PIB_CHANNEL_NUMBER_RF16 bits29The channel number as defined in clause 10.1.3.9 of to be used for channel scanning and data transmission
MAC_PIB_DUTY_CYCLE_USAGE_RF8 bits0Current usage of maximum allowed duty cycle in percent over the current sliding-window measurement period
MAC_PIB_DUTY_CYCLE_PERIOD_RF16 bits3600Duration of the measurement period in seconds, e.g., 3600 seconds as default for
MAC_PIB_DUTY_CYCLE_LIMIT_RF16 bits90Duration of the allowed transmission time in seconds, e.g., 2.5% of 3600 seconds as default for
MAC_PIB_DUTY_CYCLE_THRESHOLD_RF8 bits90Duty cycle threshold for stopping RF transmissions
MAC_PIB_DISABLE_PHY_RF8 bits (bool)FalseDisable RF PHY Tx and Rx
MAC_PIB_FREQUENCY_BAND_RF8 bits4Current operating frequency band identifier value as specified in tables 7.21 and 7.22
MAC_PIB_TRANSMIT_ATTEN_RF8 bits0Attenuation of the RF transmit power in dB. The attenuation shall be applied to all transmissions
MAC_PIB_ADAPTIVE_POWER_STEP_RF8 bits3Maximum change (in dB) during one step when adapting transmission power
MAC_PIB_ADAPTIVE_POWER_HIGH_BOUND_RF8 bits104Reverse LQI threshold above which Tx Power shall be reduced. Set to 255 to disable. This value shall be greater than macAdaptivePowerLowBound_RF by at least 20 dB. Default value is configured according to test for adaptive power control
MAC_PIB_ADAPTIVE_POWER_LOW_BOUND_RF8 bits0Reverse LQI threshold below which Tx Power shall be increased. Set to 0 to disable. This value shall be lower than macAdaptivePowerHighBound_RF by at least 20 dB
MAC_PIB_POS_RECENT_ENTRIES_RF16 bits1Number of POS table entries having been refreshed recently and which LQI is above adpTrickleLQIThresholdLow
MAC_PIB_MANUF_SECURITY_RESET_RF8 bits (bool)N/AResets the Device table upon a GMK activation
MAC_PIB_MANUF_LBP_FRAME_RECEIVED_RF8 bits (bool)0Indicates whether an LBP frame for other destination has been received since IB was set to 0
MAC_PIB_MANUF_LNG_FRAME_RECEIVED_RF8 bits (bool)0Indicates whether an LBP frame for other destination has been received since IB was set to 0
MAC_PIB_MANUF_BCN_FRAME_RECEIVED_RF8 bits (bool)0Indicates whether an Beacon frame from other nodes has been received since IB was set to 0
MAC_PIB_MANUF_RX_OTHER_DESTINATION_COUNT_RF32 bits0Gets number of discarded packets due to Other Destination
MAC_PIB_MANUF_RX_INVALID_FRAME_LENGTH_COUNT_RF32 bits0Gets number of discarded packets due to Invalid Frame Lenght
MAC_PIB_MANUF_RX_WRONG_ADDR_MODE_COUNT_RF32 bits0Gets number of discarded packets due to Wrong Addressing Mode
MAC_PIB_MANUF_RX_UNSUPPORTED_SECURITY_COUNT_RF32 bits0Gets number of discarded packets due to Unsupported Security
MAC_PIB_MANUF_RX_WRONG_KEY_ID_COUNT_RF32 bits0Gets number of discarded packets due to Wrong Key Id
MAC_PIB_MANUF_RX_INVALID_KEY_COUNT_RF32 bits0Gets number of discarded packets due to Invalid Key
MAC_PIB_MANUF_RX_WRONG_FC_COUNT_RF32 bits0Gets number of discarded packets due to Wrong Frame Counter
MAC_PIB_MANUF_RX_DECRYPTION_ERROR_COUNT_RF32 bits0Gets number of discarded packets due to Decryption Error
MAC_PIB_MANUF_TX_DATA_PACKET_COUNT_RF32 bits0Gets number of transmitted Data packets
MAC_PIB_MANUF_RX_DATA_PACKET_COUNT_RF32 bits0Gets number of received Data packets
MAC_PIB_MANUF_TX_CMD_PACKET_COUNT_RF32 bits0Gets number of transmitted Command packets
MAC_PIB_MANUF_RX_CMD_PACKET_COUNT_RF32 bits0Gets number of received Command packets
MAC_PIB_MANUF_CSMA_FAIL_COUNT_RF32 bits0Gets number of Channel Access failures
MAC_PIB_MANUF_RX_DATA_BROADCAST_COUNT_RF32 bits0Gets number of received broadcast packets
MAC_PIB_MANUF_TX_DATA_BROADCAST_COUNT_RF32 bits0Gets number of transmitted broadcast packets
MAC_PIB_MANUF_BAD_CRC_COUNT_RF32 bits0Gets number of received packets with wrong CRC
MAC_PIB_MANUF_ENABLE_MAC_SNIFFER_RF8 bits (bool)0Enables MAC Sniffer
MAC_PIB_MANUF_POS_TABLE_COUNT_RF16 bitsN/AGets number of valid elements in the POS Table
MAC_PIB_MANUF_MAC_INTERNAL_VERSION_RF6 Byte structCurrent VersionGets internal MAC version
MAC_PIB_MANUF_RESET_MAC_STATS_RF8 bits (bool)N/AResets MAC statistics
MAC_PIB_MANUF_POS_TABLE_ELEMENT_RF9 Byte entriesN/AProvides access to POS table using short address as index
MAC_PIB_MANUF_ACK_TX_DELAY_RF32 bits2000Configures time between a received frame and the transmission of its ACK, in microseconds
MAC_PIB_MANUF_ACK_RX_WAIT_TIME_RF32 bits30000Configures time to wait for a requested ACK before timing out, in microseconds
MAC_PIB_MANUF_ACK_CONFIRM_WAIT_TIME_RF32 bits30000Configures time to wait for an ACK Confirm before timing out, in microseconds
MAC_PIB_MANUF_DATA_CONFIRM_WAIT_TIME_RF32 bits90000Configures time to wait for a Data Confirm before timing out, in microseconds
MAC_PIB_MANUF_RF_IFACE_AVAILABLE8 bits (bool)N/ARF Interface availability
MAC_PIB_MANUF_LAST_FRAME_DURATION_RF16 bitsN/ALast PLC frame duration in ms
MAC_PIB_MANUF_TRICKLE_MIN_LQI_RF8 bits85Minimum LQI to consider a neighbour for Trickle
MAC_PIB_MANUF_PHY_PARAM_RFVariableN/AGets or sets a parameter in Phy layer. Index will be used to contain PHY parameter ID. See MAC_WRP_PHY_PARAM_RF

Remarks

None.