1.3.4.1.9 MAC_PLC_PIB_ATTRIBUTE Enum

C

typedef enum
{
    MAC_PIB_MAX_BE = 0x00000047,
    MAC_PIB_BSN = 0x00000049,
    MAC_PIB_DSN = 0x0000004C,
    MAC_PIB_MAX_CSMA_BACKOFFS = 0x0000004E,
    MAC_PIB_MIN_BE = 0x0000004F,
    MAC_PIB_MAX_FRAME_RETRIES = 0x00000059,
    MAC_PIB_TIMESTAMP_SUPPORTED = 0x0000005C,
    MAC_PIB_SECURITY_ENABLED = 0x0000005D,
    MAC_PIB_FRAME_COUNTER = 0x00000077,
    MAC_PIB_DUPLICATE_DETECTION_TTL = 0x00000078,
    MAC_PIB_HIGH_PRIORITY_WINDOW_SIZE = 0x00000100,
    MAC_PIB_TX_DATA_PACKET_COUNT = 0x00000101,
    MAC_PIB_RX_DATA_PACKET_COUNT = 0x00000102,
    MAC_PIB_TX_CMD_PACKET_COUNT = 0x00000103,
    MAC_PIB_RX_CMD_PACKET_COUNT = 0x00000104,
    MAC_PIB_CSMA_FAIL_COUNT = 0x00000105,
    MAC_PIB_CSMA_NO_ACK_COUNT = 0x00000106,
    MAC_PIB_RX_DATA_BROADCAST_COUNT = 0x00000107,
    MAC_PIB_TX_DATA_BROADCAST_COUNT = 0x00000108,
    MAC_PIB_BAD_CRC_COUNT = 0x00000109,
    MAC_PIB_NEIGHBOUR_TABLE = 0x0000010A,
    MAC_PIB_FREQ_NOTCHING = 0x0000010B,
    MAC_PIB_CSMA_FAIRNESS_LIMIT = 0x0000010C,
    MAC_PIB_TMR_TTL = 0x0000010D,
    MAC_PIB_TONE_MASK = 0x00000110,
    MAC_PIB_BEACON_RANDOMIZATION_WINDOW_LENGTH = 0x00000111,
    MAC_PIB_A = 0x00000112,
    MAC_PIB_K = 0x00000113,
    MAC_PIB_MIN_CW_ATTEMPTS = 0x00000114,
    MAC_PIB_CENELEC_LEGACY_MODE = 0x00000115,
    MAC_PIB_FCC_LEGACY_MODE = 0x00000116,
    MAC_PIB_BROADCAST_MAX_CW_ENABLE = 0x0000011E,
    MAC_PIB_TRANSMIT_ATTEN = 0x0000011F,
    MAC_PIB_POS_TABLE = 0x00000120,
    MAC_PIB_POS_RECENT_ENTRY_THRESHOLD = 0x00000121,
    MAC_PIB_POS_RECENT_ENTRIES = 0x00000122,
    MAC_PIB_PLC_DISABLE = 0x00000123,
    MAC_PIB_PREAMBLE_LENGTH = 0x00000124,
    // manufacturer specific
    // provides access to device table
    MAC_PIB_MANUF_DEVICE_TABLE = 0x08000000,
    // provides access to neighbour table by short address (transmitted as index)
    MAC_PIB_MANUF_NEIGHBOUR_TABLE_ELEMENT = 0x08000002,
    // returns the maximum number of tones used by the band
    MAC_PIB_MANUF_BAND_INFORMATION = 0x08000003,
    // Short address of the coordinator.
    MAC_PIB_MANUF_COORD_SHORT_ADDRESS = 0x08000004,
    // Maximal payload supported by MAC.
    MAC_PIB_MANUF_MAX_MAC_PAYLOAD_SIZE = 0x08000005,
    // Resets the device table upon a GMK activation.
    MAC_PIB_MANUF_SECURITY_RESET = 0x08000006,
    // Forces Modulation Scheme in every transmitted frame
    // 0 - Not forced, 1 - Force Differential, 2 - Force Coherent
    MAC_PIB_MANUF_FORCED_MOD_SCHEME = 0x08000007,
    // Forces Modulation Type in every transmitted frame
    // 0 - Not forced, 1 - Force BPSK_ROBO, 2 - Force BPSK, 3 - Force QPSK, 4 - Force 8PSK
    MAC_PIB_MANUF_FORCED_MOD_TYPE = 0x08000008,
    // Forces ToneMap in every transmitted frame
    // {0} - Not forced, other value will be used as tonemap
    MAC_PIB_MANUF_FORCED_TONEMAP = 0x08000009,
    // Forces Modulation Scheme bit in Tone Map Response
    // 0 - Not forced, 1 - Force Differential, 2 - Force Coherent
    MAC_PIB_MANUF_FORCED_MOD_SCHEME_ON_TMRESPONSE = 0x0800000A,
    // Forces Modulation Type bits in Tone Map Response
    // 0 - Not forced, 1 - Force BPSK_ROBO, 2 - Force BPSK, 3 - Force QPSK, 4 - Force 8PSK
    MAC_PIB_MANUF_FORCED_MOD_TYPE_ON_TMRESPONSE = 0x0800000B,
    // Forces ToneMap field Tone Map Response
    // {0} - Not forced, other value will be used as tonemap field
    MAC_PIB_MANUF_FORCED_TONEMAP_ON_TMRESPONSE = 0x0800000C,
    // Gets Modulation Scheme of last received frame
    MAC_PIB_MANUF_LAST_RX_MOD_SCHEME = 0x0800000D,
    // Gets Modulation Scheme of last received frame
    MAC_PIB_MANUF_LAST_RX_MOD_TYPE = 0x0800000E,
    // Indicates whether an LBP frame for other destination has been received
    MAC_PIB_MANUF_LBP_FRAME_RECEIVED = 0x0800000F,
    // Indicates whether an LBP frame for other destination has been received
    MAC_PIB_MANUF_LNG_FRAME_RECEIVED = 0x08000010,
    // Indicates whether an Beacon frame from other nodes has been received
    MAC_PIB_MANUF_BCN_FRAME_RECEIVED = 0x08000011,
    // Gets number of valid elements in the Neighbour Table
    MAC_PIB_MANUF_NEIGHBOUR_TABLE_COUNT = 0x08000012,
    // Gets number of discarded packets due to Other Destination
    MAC_PIB_MANUF_RX_OTHER_DESTINATION_COUNT = 0x08000013,
    // Gets number of discarded packets due to Invalid Frame Lenght
    MAC_PIB_MANUF_RX_INVALID_FRAME_LENGTH_COUNT = 0x08000014,
    // Gets number of discarded packets due to MAC Repetition
    MAC_PIB_MANUF_RX_MAC_REPETITION_COUNT = 0x08000015,
    // Gets number of discarded packets due to Wrong Addressing Mode
    MAC_PIB_MANUF_RX_WRONG_ADDR_MODE_COUNT = 0x08000016,
    // Gets number of discarded packets due to Unsupported Security
    MAC_PIB_MANUF_RX_UNSUPPORTED_SECURITY_COUNT = 0x08000017,
    // Gets number of discarded packets due to Wrong Key Id
    MAC_PIB_MANUF_RX_WRONG_KEY_ID_COUNT = 0x08000018,
    // Gets number of discarded packets due to Invalid Key
    MAC_PIB_MANUF_RX_INVALID_KEY_COUNT = 0x08000019,
    // Gets number of discarded packets due to Wrong Frame Counter
    MAC_PIB_MANUF_RX_WRONG_FC_COUNT = 0x0800001A,
    // Gets number of discarded packets due to Decryption Error
    MAC_PIB_MANUF_RX_DECRYPTION_ERROR_COUNT = 0x0800001B,
    // Gets number of discarded packets due to Segment Decode Error
    MAC_PIB_MANUF_RX_SEGMENT_DECODE_ERROR_COUNT = 0x0800001C,
    // Enables MAC Sniffer
    MAC_PIB_MANUF_ENABLE_MAC_SNIFFER = 0x0800001D,
    // Gets number of valid elements in the POS Table
    MAC_PIB_MANUF_POS_TABLE_COUNT = 0x0800001E,
    // Gets or Sets number of retires left before forcing ROBO mode
    MAC_PIB_MANUF_RETRIES_LEFT_TO_FORCE_ROBO = 0x0800001F,
    // Gets internal MAC version
    MAC_PIB_MANUF_MAC_INTERNAL_VERSION = 0x08000021,
    // Gets internal MAC RT version
    MAC_PIB_MANUF_MAC_RT_INTERNAL_VERSION = 0x08000022,
    // Resets MAC statistics
    MAC_PIB_MANUF_RESET_MAC_STATS = 0x08000023,
    // Enable/Disable Sleep Mode
    MAC_PIB_MANUF_MAC_RT_SLEEP_MODE = 0x08000024,
    // Set PLC Debug Mode
    MAC_PIB_MANUF_MAC_RT_DEBUG_SET = 0x08000025,
    // Read PLC Debug Information
    MAC_PIB_MANUF_MAC_RT_DEBUG_READ = 0x08000026,
    // Provides access to POS table by short address (referenced as index)
    MAC_PIB_MANUF_POS_TABLE_ELEMENT = 0x08000027,
    // Minimum LQI to consider a neighbour for Trickle
    MAC_PIB_MANUF_TRICKLE_MIN_LQI = 0x08000028,
    // LQI for a given neighbour, which short address will be indicated by index. 8 bits.
    MAC_PIB_MANUF_NEIGHBOUR_LQI = 0x08000029,
    // Best LQI found in neighbour table. 8 bits.
    MAC_PIB_MANUF_BEST_LQI = 0x0800002A,
    // PLC Interface availability. 8 bits (bool).
    MAC_PIB_MANUF_PLC_IFACE_AVAILABLE = 0x0800002B,
    // Last PLC frame duration in ms. 16 bits.
    MAC_PIB_MANUF_LAST_FRAME_DURATION_PLC = 0x0800002C,
    // Resets TMR TTL for the Short Address contained in Index. 8 bits.
    MAC_PIB_MANUF_RESET_TMR_TTL = 0x0800002E,
    // Gets or sets a parameter in Phy layer. Index will be used to contain PHY parameter ID.
    // Check 'enum EPhyParam' in MacRtMib.h for available Phy parameter IDs
    MAC_PIB_MANUF_PHY_PARAM = 0x08000020
} MAC_PLC_PIB_ATTRIBUTE;

Summary

Lists the available objects in the MAC PLC 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_MAX_BE8 bits8Maximum value of back-off exponent. It should always be greater or equal than macMinBE.
MAC_PIB_BSN8 bitsRandomBeacon frame sequence number
MAC_PIB_DSN8 bitsRandomData or command frame sequence number
MAC_PIB_MAX_CSMA_BACKOFFS8 bits50Maximum number of back-off attempts
MAC_PIB_MIN_BE8 bits3Minimum value of back-off exponent
MAC_PIB_MAX_FRAME_RETRIES8 bits5Maximum number of retransmission
MAC_PIB_TIMESTAMP_SUPPORTED8 bits (bool)TrueMAC frame time stamp support enable (read only)
MAC_PIB_SECURITY_ENABLED8 bits (bool)TrueSecurity enabled
MAC_PIB_FRAME_COUNTER32 bits0The outgoing frame counter for this device
MAC_PIB_DUPLICATE_DETECTION_TTL8 bits3Time a received tuple is retained for duplicate frame detection, in seconds
MAC_PIB_HIGH_PRIORITY_WINDOW_SIZE8 bits7The high priority contention window size in number of slots
MAC_PIB_TX_DATA_PACKET_COUNT32 bits0Statistic counter of successfully transmitted unicast MSDUs
MAC_PIB_RX_DATA_PACKET_COUNT32 bits0Statistic counter of successfully received unicast MSDUs
MAC_PIB_TX_CMD_PACKET_COUNT32 bits0Statistic counter of successfully transmitted command packets
MAC_PIB_RX_CMD_PACKET_COUNT32 bits0Statistic counter of successfully received command packets
MAC_PIB_CSMA_FAIL_COUNT32 bits0Counts the number of times the CSMA backoffs reach macMaxCSMABackoffs
MAC_PIB_CSMA_NO_ACK_COUNT32 bits0Counts the number of times an ACK is not received while transmitting a unicast data frame
MAC_PIB_RX_DATA_BROADCAST_COUNT32 bits0Statistic counter of successfully received broadcast frames
MAC_PIB_TX_DATA_BROADCAST_COUNT32 bits0Statistic counter of the number of broadcast frames sent
MAC_PIB_BAD_CRC_COUNT32 bits0Statistic counter of the number of frames received with bad CRC
MAC_PIB_NEIGHBOUR_TABLE16 Byte entriesEmptyThe Neighbour table defined in G3 Spec
MAC_PIB_FREQ_NOTCHING8 bits (bool)FalseIndicates whether certain frequencies are notched so no signal is injected on them
MAC_PIB_CSMA_FAIRNESS_LIMIT8 bits25Channel access fairness limit. Specifies how many failed backoff attempts, back-off exponent is set to minBE
MAC_PIB_TMR_TTL8 bits10Maximum time to live for an entry in the neighbour table in minutes
MAC_PIB_TONE_MASK9 Byte arrayAll Tones EnabledDefines the tone mask to use during symbol formation. The value shall be identical for all nodes of a PAN. Inconsistency will cause complete loss of communication
MAC_PIB_BEACON_RANDOMIZATION_WINDOW_LENGTH8 bits12Duration time in seconds for beacon randomization
MAC_PIB_A8 bits8This parameter controls the adaptive CW linear decrease
MAC_PIB_K8 bits5Rate adaptation factor for channel access fairness limit
MAC_PIB_MIN_CW_ATTEMPTS8 bits255Number of consecutive attempts while using minimum CW
MAC_PIB_CENELEC_LEGACY_MODE8 bits1This read only attribute indicates the capability of the node. See G3 Spec
MAC_PIB_FCC_LEGACY_MODE8 bits1This read only attribute indicates the capability of the node. See G3 Spec
MAC_PIB_BROADCAST_MAX_CW_ENABLE8 bits (bool)FalseIf enabled, MAC uses maximum contention window for broadcast frames
MAC_PIB_TRANSMIT_ATTEN8 bits0Attenuation of the output level in dB
MAC_PIB_POS_TABLE5 Byte entriesEmptyThe POS table defined in G3 Spec
MAC_PIB_POS_RECENT_ENTRIES16 bits1Number of POS table entries having been refreshed recently and which LQI is above adpTrickleLQIThresholdLow
MAC_PIB_PLC_DISABLE8 bits (bool)FalseDisable PLC PHY Tx and Rx
MAC_PIB_PREAMBLE_LENGTH8 bits8Number of P symbols to use in PHY Preamble
MAC_PIB_MANUF_DEVICE_TABLE6 Byte entriesEmptyThe Device table as defined in G3 Spec
MAC_PIB_MANUF_NEIGHBOUR_TABLE_ELEMENT16 Byte entriesN/AProvides access to Neighbour table using short address as index
MAC_PIB_MANUF_BAND_INFORMATION11 Byte structDepnds on BandMaximum number of tones used by the band
MAC_PIB_MANUF_COORD_SHORT_ADDRESS16 bits0x0000Short address of the PAN Coordinator
MAC_PIB_MANUF_MAX_MAC_PAYLOAD_SIZE16 bits400Maximum payload supported by MAC (read only)
MAC_PIB_MANUF_SECURITY_RESET8 bits (bool)N/AResets the Device table upon a GMK activation (write only)
MAC_PIB_MANUF_FORCED_MOD_SCHEME8 bits0Forces Modulation Scheme in every transmitted frame. 0 - Not forced, 1 - Force Differential, 2 - Force Coherent
MAC_PIB_MANUF_FORCED_MOD_TYPE8 bits0Forces Modulation Type in every transmitted frame. 0 - Not forced, 1 - Force BPSK_ROBO, 2 - Force BPSK, 3 - Force QPSK, 4 - Force 8PSK
MAC_PIB_MANUF_FORCED_TONEMAP3 Byte arrayAll 0'sForces ToneMap in every transmitted frame. {0} - Not forced, other value will be used as tonemap
MAC_PIB_MANUF_FORCED_MOD_SCHEME_ON_TMRESPONSE8 bits0Forces Modulation Scheme bit in Tone Map Response. 0 - Not forced, 1 - Force Differential, 2 - Force Coherent
MAC_PIB_MANUF_FORCED_MOD_TYPE_ON_TMRESPONSE8 bits0Forces Modulation Type bits in Tone Map Response. 0 - Not forced, 1 - Force BPSK_ROBO, 2 - Force BPSK, 3 - Force QPSK, 4 - Force 8PSK
MAC_PIB_MANUF_FORCED_TONEMAP_ON_TMRESPONSE3 Byte arrayAll 0'sForces ToneMap field Tone Map Response. {0} - Not forced, other value will be used as tonemap field
MAC_PIB_MANUF_LAST_RX_MOD_SCHEME8 bitsN/AGets Modulation Scheme of last received frame
MAC_PIB_MANUF_LAST_RX_MOD_TYPE8 bitsN/AGets Modulation Scheme of last received frame
MAC_PIB_MANUF_LBP_FRAME_RECEIVED8 bits (bool)0Indicates whether an LBP frame has been received since IB was set to 0
MAC_PIB_MANUF_LNG_FRAME_RECEIVED8 bits (bool)0Indicates whether an LNG frame has been received since IB was set to 0
MAC_PIB_MANUF_BCN_FRAME_RECEIVED8 bits (bool)0Indicates whether an Beacon frame has been received since IB was set to 0
MAC_PIB_MANUF_NEIGHBOUR_TABLE_COUNT16 bitsN/AGets number of valid elements in the Neighbour Table
MAC_PIB_MANUF_RX_OTHER_DESTINATION_COUNT32 bits0Gets number of discarded packets due to Other Destination
MAC_PIB_MANUF_RX_INVALID_FRAME_LENGTH_COUNT32 bits0Gets number of discarded packets due to Invalid Frame Length
MAC_PIB_MANUF_RX_MAC_REPETITION_COUNT32 bits0Gets number of discarded packets due to MAC Repetition
MAC_PIB_MANUF_RX_WRONG_ADDR_MODE_COUNT32 bits0Gets number of discarded packets due to Wrong Addressing Mode
MAC_PIB_MANUF_RX_UNSUPPORTED_SECURITY_COUNT32 bits0Gets number of discarded packets due to Unsupported Security
MAC_PIB_MANUF_RX_WRONG_KEY_ID_COUNT32 bits0Gets number of discarded packets due to Wrong Key Id
MAC_PIB_MANUF_RX_INVALID_KEY_COUNT32 bits0Gets number of discarded packets due to Invalid Key
MAC_PIB_MANUF_RX_WRONG_FC_COUNT32 bits0Gets number of discarded packets due to Wrong Frame Counter
MAC_PIB_MANUF_RX_DECRYPTION_ERROR_COUNT32 bits0Gets number of discarded packets due to Decryption Error
MAC_PIB_MANUF_RX_SEGMENT_DECODE_ERROR_COUNT32 bits0Gets number of discarded packets due to Segment Decode Error
MAC_PIB_MANUF_ENABLE_MAC_SNIFFER8 bits (bool)FalseEnables MAC Sniffer
MAC_PIB_MANUF_POS_TABLE_COUNT16 bitsN/AGets number of valid elements in the POS Table
MAC_PIB_MANUF_RETRIES_LEFT_TO_FORCE_ROBO8 bits0Gets or Sets number of retires left before forcing ROBO mode
MAC_PIB_MANUF_MAC_INTERNAL_VERSION6 Byte structCurrent VersionGets internal MAC version
MAC_PIB_MANUF_MAC_RT_INTERNAL_VERSION6 Byte structCurrent VersionGets internal MAC RT version
MAC_PIB_MANUF_RESET_MAC_STATS8 bits (bool)0Resets MAC statistics
MAC_PIB_MANUF_MAC_RT_SLEEP_MODE8 bits (bool)0Enable/Disable Sleep Mode
MAC_PIB_MANUF_MAC_RT_DEBUG_SET7 bytesAll 0'sConfigures debug mode to read memory from PLC device
MAC_PIB_MANUF_MAC_RT_DEBUG_READ144 bytesAll 0'sRead memory from PLC device. Address configured through MAC_WRP_PIB_MANUF_DEBUG_SET
MAC_PIB_MANUF_POS_TABLE_ELEMENT5 Byte entriesN/AProvides access to POS table using short address as index
MAC_PIB_MANUF_TRICKLE_MIN_LQI8 bits80Minimum LQI to consider a neighbour for Trickle
MAC_PIB_MANUF_NEIGHBOUR_LQI8 bitsN/ALQI for a given neighbour, which short address will be indicated as index
MAC_PIB_MANUF_BEST_LQI8 bitsN/ABest LQI found in neighbour table
MAC_PIB_MANUF_PLC_IFACE_AVAILABLE8 bits (bool)N/APLC Interface availability
MAC_PIB_MANUF_LAST_FRAME_DURATION_PLC16 bitsN/ALast PLC frame duration in ms
MAC_PIB_MANUF_RESET_TMR_TTL8 bitsN/AResets TMR TTL for the Short Address contained in Index
MAC_PIB_MANUF_PHY_PARAMVariableN/AGets or sets a parameter in Phy layer. Index will be used to contain PHY parameter ID. See MAC_WRP_PHY_PARAM

Remarks

None.