"ARR State Bitfield" (APP/LIM)

View Options: (help)

Focus:	Maintenance / Operation
Structures:	Abstract / Concrete

Ancestry:

0x000	pkt	State
0x01B	bf	TARRSTATEBF arr_state

Definition:

Alignment:	1-byte boundary
APID:	783/0x30F
Attribute(s):
C type:	unsigned char
Length:	8 bits (1 byte)
Offset:	0x01B

Description:

Bitfield containing the current ARR observation state.

Layout: (hide detail; help)

Start	Stop	Size		Item Type and Name
0	1	2		TPAD2 pad
2	2	1		TPENDING rep_req_pending
3	5	3		TGRBSTATE grb_state
6	6	1		TACTIVE active
7	7	1		TREADY ready

TARRSTATEBF (bf)
|  TPAD2 pad (0-1)
|  TPENDING rep_req_pending (2)
|  TGRBSTATE grb_state (3-5)
|  TACTIVE active (6)
|  TREADY ready (7)

typedef struct _LIM_TARRSTATEBF_Bfl {

    #if ENDIANNESS_IS_BIG

    /* 2-Bit Padding */
    unsigned char        pad:2;

    /* Pending Status */
    unsigned char        rep_req_pending:1;

    /* GRB State */
    unsigned char        grb_state:3;

    /* Active Status */
    unsigned char        active:1;

    /* Ready Status */
    unsigned char        ready:1;

    #elif ENDIANNESS_IS_LITTLE

    /* Ready Status */
    unsigned char        ready:1;

    /* Active Status */
    unsigned char        active:1;

    /* GRB State */
    unsigned char        grb_state:3;

    /* Pending Status */
    unsigned char        rep_req_pending:1;

    /* 2-Bit Padding */
    unsigned char        pad:2;

    #else

    #error _FILE_ ENDIANNESS NOT DEFINED

    #endif

} __attribute__((packed)) LIM_TARRSTATEBF_Bfl;

typedef union _LIM_TARRSTATEBF {

    /* underlying unsigned char */
    unsigned char                   uc;

    /* struct mapped bitfield */
    struct _LIM_TARRSTATEBF_Bfl     bf;

} LIM_TARRSTATEBF;

Fields:

TACTIVE (index)

Attribute(s):  

Brief:  "Active Status"

Instance(s):  active

Flag to indicate that an activity is active.

TGRBSTATE (index)

Attribute(s):  

Brief:  "GRB State"

Instance(s):  grb_state

Current state of the GRB handler (0=idle, 4=GRB0, 5=GRB1, 6=GRB2).

TPAD2 (index)

Attribute(s):  

Brief:  "2-Bit Padding"

Instance(s):  pad

Explicit padding of 2 bits.

TPENDING (index)

Attribute(s):  

Brief:  "Pending Status"

Instance(s):  rep_req_pending

Flag to indicate that an operation is pending.

TREADY (index)

Attribute(s):  

Brief:  "Ready Status"

Instance(s):  ready

Flag to indicate that an activity is ready to be started.