iPXE
Macros | Typedefs | Functions
pseudobit.h File Reference

Pseudo-bit structures. More...

#include <stdint.h>
#include <byteswap.h>

Go to the source code of this file.

Macros

#define PSEUDO_BIT_STRUCT(_structure)
 Wrapper structure for pseudo_bit_t structures. More...
 
#define PSEUDO_BIT_STRUCT_TYPE(_ptr)   typeof ( *((_ptr)->u.dummy[0]) )
 Get pseudo_bit_t structure type from wrapper structure pointer. More...
 
#define BIT_OFFSET(_ptr, _field)   offsetof ( PSEUDO_BIT_STRUCT_TYPE ( _ptr ), _field )
 Bit offset of a field within a pseudo_bit_t structure. More...
 
#define BIT_WIDTH(_ptr, _field)   sizeof ( ( ( PSEUDO_BIT_STRUCT_TYPE ( _ptr ) * ) NULL )->_field )
 Bit width of a field within a pseudo_bit_t structure. More...
 
#define QWORD_OFFSET(_ptr, _field)   ( BIT_OFFSET ( _ptr, _field ) / 64 )
 Qword offset of a field within a pseudo_bit_t structure. More...
 
#define QWORD_BIT_OFFSET(_ptr, _index, _field)   ( BIT_OFFSET ( _ptr, _field ) - ( 64 * (_index) ) )
 Qword bit offset of a field within a pseudo_bit_t structure. More...
 
#define QWORD_BIT_SHIFT(_ptr, _index, _field)
 Qword bit shift for a field within a pseudo_bit_t structure. More...
 
#define BIT_MASK(_ptr, _field)
 Bit mask for a field within a pseudo_bit_t structure. More...
 
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
 
#define BIT_ASSEMBLE_2(_ptr, _index, _field, _value, ...)
 
#define BIT_ASSEMBLE_3(_ptr, _index, _field, _value, ...)
 
#define BIT_ASSEMBLE_4(_ptr, _index, _field, _value, ...)
 
#define BIT_ASSEMBLE_5(_ptr, _index, _field, _value, ...)
 
#define BIT_ASSEMBLE_6(_ptr, _index, _field, _value, ...)
 
#define BIT_ASSEMBLE_7(_ptr, _index, _field, _value, ...)
 
#define BIT_MASK_1(_ptr, _index, _field)
 
#define BIT_MASK_2(_ptr, _index, _field, ...)
 
#define BIT_MASK_3(_ptr, _index, _field, ...)
 
#define BIT_MASK_4(_ptr, _index, _field, ...)
 
#define BIT_MASK_5(_ptr, _index, _field, ...)
 
#define BIT_MASK_6(_ptr, _index, _field, ...)
 
#define BIT_MASK_7(_ptr, _index, _field, ...)
 
#define BIT_FILL(_ptr, _index, _assembled)
 
#define BIT_FILL_1(_ptr, _field1, ...)
 
#define BIT_FILL_2(_ptr, _field1, ...)
 
#define BIT_FILL_3(_ptr, _field1, ...)
 
#define BIT_FILL_4(_ptr, _field1, ...)
 
#define BIT_FILL_5(_ptr, _field1, ...)
 
#define BIT_FILL_6(_ptr, _field1, ...)
 
#define BIT_QWORD_PTR(_ptr, _field)
 
#define BIT_GET64(_ptr, _field)
 Extract value of named field. More...
 
#define BIT_GET(_ptr, _field)   ( ( unsigned long ) BIT_GET64 ( _ptr, _field ) )
 Extract value of named field (for fields up to the size of a long) More...
 
#define BIT_SET(_ptr, _field, _value)
 

Typedefs

typedef unsigned char pseudo_bit_t
 Datatype used to represent a bit in the pseudo-structures. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 

Detailed Description

Pseudo-bit structures.

Definition in file pseudobit.h.

Macro Definition Documentation

◆ PSEUDO_BIT_STRUCT

#define PSEUDO_BIT_STRUCT (   _structure)
Value:
union { \
uint8_t bytes[ sizeof ( _structure ) / 8 ]; \
uint32_t dwords[ sizeof ( _structure ) / 32 ]; \
uint64_t qwords[ sizeof ( _structure ) / 64 ]; \
_structure *dummy[0]; \
} __attribute__ (( packed )) u
#define __attribute__(x)
Definition: compiler.h:10
union @16 u
uint8_t bytes[64]
Definition: ib_mad.h:16

Wrapper structure for pseudo_bit_t structures.

This structure provides a wrapper around pseudo_bit_t structures. It has the correct size, and also encapsulates type information about the underlying pseudo_bit_t-based structure, which allows the BIT_FILL() etc. macros to work without requiring explicit type information.

Definition at line 70 of file pseudobit.h.

◆ PSEUDO_BIT_STRUCT_TYPE

#define PSEUDO_BIT_STRUCT_TYPE (   _ptr)    typeof ( *((_ptr)->u.dummy[0]) )

Get pseudo_bit_t structure type from wrapper structure pointer.

Definition at line 79 of file pseudobit.h.

◆ BIT_OFFSET

#define BIT_OFFSET (   _ptr,
  _field 
)    offsetof ( PSEUDO_BIT_STRUCT_TYPE ( _ptr ), _field )

Bit offset of a field within a pseudo_bit_t structure.

Definition at line 83 of file pseudobit.h.

◆ BIT_WIDTH

#define BIT_WIDTH (   _ptr,
  _field 
)    sizeof ( ( ( PSEUDO_BIT_STRUCT_TYPE ( _ptr ) * ) NULL )->_field )

Bit width of a field within a pseudo_bit_t structure.

Definition at line 87 of file pseudobit.h.

◆ QWORD_OFFSET

#define QWORD_OFFSET (   _ptr,
  _field 
)    ( BIT_OFFSET ( _ptr, _field ) / 64 )

Qword offset of a field within a pseudo_bit_t structure.

Definition at line 91 of file pseudobit.h.

◆ QWORD_BIT_OFFSET

#define QWORD_BIT_OFFSET (   _ptr,
  _index,
  _field 
)    ( BIT_OFFSET ( _ptr, _field ) - ( 64 * (_index) ) )

Qword bit offset of a field within a pseudo_bit_t structure.

Definition at line 95 of file pseudobit.h.

◆ QWORD_BIT_SHIFT

#define QWORD_BIT_SHIFT (   _ptr,
  _index,
  _field 
)
Value:
QWORD_SHIFT ( QWORD_BIT_OFFSET ( _ptr, _index, _field ), \
BIT_WIDTH ( _ptr, _field ) )
#define BIT_WIDTH(_ptr, _field)
Bit width of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:87
#define QWORD_BIT_OFFSET(_ptr, _index, _field)
Qword bit offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:95

Qword bit shift for a field within a pseudo_bit_t structure.

Definition at line 99 of file pseudobit.h.

◆ BIT_MASK

#define BIT_MASK (   _ptr,
  _field 
)
Value:
( ( ~( ( uint64_t ) 0 ) ) >> \
( 64 - BIT_WIDTH ( _ptr, _field ) ) )
#define BIT_WIDTH(_ptr, _field)
Bit width of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:87
unsigned long long uint64_t
Definition: stdint.h:13

Bit mask for a field within a pseudo_bit_t structure.

Definition at line 104 of file pseudobit.h.

◆ BIT_ASSEMBLE_1

#define BIT_ASSEMBLE_1 (   _ptr,
  _index,
  _field,
  _value 
)
Value:
( ( ( uint64_t) (_value) ) << \
QWORD_BIT_SHIFT ( _ptr, _index, _field ) )
unsigned long long uint64_t
Definition: stdint.h:13
#define QWORD_BIT_SHIFT(_ptr, _index, _field)
Qword bit shift for a field within a pseudo_bit_t structure.
Definition: pseudobit.h:99

Definition at line 113 of file pseudobit.h.

◆ BIT_ASSEMBLE_2

#define BIT_ASSEMBLE_2 (   _ptr,
  _index,
  _field,
  _value,
  ... 
)
Value:
( BIT_ASSEMBLE_1 ( _ptr, _index, _field, _value ) | \
BIT_ASSEMBLE_1 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
Definition: pseudobit.h:113

Definition at line 117 of file pseudobit.h.

◆ BIT_ASSEMBLE_3

#define BIT_ASSEMBLE_3 (   _ptr,
  _index,
  _field,
  _value,
  ... 
)
Value:
( BIT_ASSEMBLE_1 ( _ptr, _index, _field, _value ) | \
BIT_ASSEMBLE_2 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
Definition: pseudobit.h:113

Definition at line 121 of file pseudobit.h.

◆ BIT_ASSEMBLE_4

#define BIT_ASSEMBLE_4 (   _ptr,
  _index,
  _field,
  _value,
  ... 
)
Value:
( BIT_ASSEMBLE_1 ( _ptr, _index, _field, _value ) | \
BIT_ASSEMBLE_3 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
Definition: pseudobit.h:113

Definition at line 125 of file pseudobit.h.

◆ BIT_ASSEMBLE_5

#define BIT_ASSEMBLE_5 (   _ptr,
  _index,
  _field,
  _value,
  ... 
)
Value:
( BIT_ASSEMBLE_1 ( _ptr, _index, _field, _value ) | \
BIT_ASSEMBLE_4 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
Definition: pseudobit.h:113

Definition at line 129 of file pseudobit.h.

◆ BIT_ASSEMBLE_6

#define BIT_ASSEMBLE_6 (   _ptr,
  _index,
  _field,
  _value,
  ... 
)
Value:
( BIT_ASSEMBLE_1 ( _ptr, _index, _field, _value ) | \
BIT_ASSEMBLE_5 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
Definition: pseudobit.h:113

Definition at line 133 of file pseudobit.h.

◆ BIT_ASSEMBLE_7

#define BIT_ASSEMBLE_7 (   _ptr,
  _index,
  _field,
  _value,
  ... 
)
Value:
( BIT_ASSEMBLE_1 ( _ptr, _index, _field, _value ) | \
BIT_ASSEMBLE_6 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
Definition: pseudobit.h:113

Definition at line 137 of file pseudobit.h.

◆ BIT_MASK_1

#define BIT_MASK_1 (   _ptr,
  _index,
  _field 
)
Value:
( BIT_MASK ( _ptr, _field ) << \
QWORD_BIT_SHIFT ( _ptr, _index, _field ) )
#define BIT_MASK(_ptr, _field)
Bit mask for a field within a pseudo_bit_t structure.
Definition: pseudobit.h:104

Definition at line 146 of file pseudobit.h.

◆ BIT_MASK_2

#define BIT_MASK_2 (   _ptr,
  _index,
  _field,
  ... 
)
Value:
( BIT_MASK_1 ( _ptr, _index, _field ) | \
BIT_MASK_1 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_MASK_1(_ptr, _index, _field)
Definition: pseudobit.h:146

Definition at line 150 of file pseudobit.h.

◆ BIT_MASK_3

#define BIT_MASK_3 (   _ptr,
  _index,
  _field,
  ... 
)
Value:
( BIT_MASK_1 ( _ptr, _index, _field ) | \
BIT_MASK_2 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_MASK_1(_ptr, _index, _field)
Definition: pseudobit.h:146

Definition at line 154 of file pseudobit.h.

◆ BIT_MASK_4

#define BIT_MASK_4 (   _ptr,
  _index,
  _field,
  ... 
)
Value:
( BIT_MASK_1 ( _ptr, _index, _field ) | \
BIT_MASK_3 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_MASK_1(_ptr, _index, _field)
Definition: pseudobit.h:146

Definition at line 158 of file pseudobit.h.

◆ BIT_MASK_5

#define BIT_MASK_5 (   _ptr,
  _index,
  _field,
  ... 
)
Value:
( BIT_MASK_1 ( _ptr, _index, _field ) | \
BIT_MASK_4 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_MASK_1(_ptr, _index, _field)
Definition: pseudobit.h:146

Definition at line 162 of file pseudobit.h.

◆ BIT_MASK_6

#define BIT_MASK_6 (   _ptr,
  _index,
  _field,
  ... 
)
Value:
( BIT_MASK_1 ( _ptr, _index, _field ) | \
BIT_MASK_5 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_MASK_1(_ptr, _index, _field)
Definition: pseudobit.h:146

Definition at line 166 of file pseudobit.h.

◆ BIT_MASK_7

#define BIT_MASK_7 (   _ptr,
  _index,
  _field,
  ... 
)
Value:
( BIT_MASK_1 ( _ptr, _index, _field ) | \
BIT_MASK_6 ( _ptr, _index, __VA_ARGS__ ) )
#define BIT_MASK_1(_ptr, _index, _field)
Definition: pseudobit.h:146

Definition at line 170 of file pseudobit.h.

◆ BIT_FILL

#define BIT_FILL (   _ptr,
  _index,
  _assembled 
)
Value:
do { \
uint64_t *__ptr = &(_ptr)->u.qwords[(_index)]; \
uint64_t __assembled = (_assembled); \
*__ptr = cpu_to_BIT64 ( __assembled ); \
} while ( 0 )
union @16 u

Definition at line 179 of file pseudobit.h.

◆ BIT_FILL_1

#define BIT_FILL_1 (   _ptr,
  _field1,
  ... 
)
Value:
BIT_FILL ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
BIT_ASSEMBLE_1 ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
_field1, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_1(_ptr, _index, _field, _value)
Definition: pseudobit.h:113
#define BIT_FILL(_ptr, _index, _assembled)
Definition: pseudobit.h:179
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91

Definition at line 185 of file pseudobit.h.

◆ BIT_FILL_2

#define BIT_FILL_2 (   _ptr,
  _field1,
  ... 
)
Value:
BIT_FILL ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
BIT_ASSEMBLE_2 ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
_field1, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_2(_ptr, _index, _field, _value,...)
Definition: pseudobit.h:117
#define BIT_FILL(_ptr, _index, _assembled)
Definition: pseudobit.h:179
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91

Definition at line 190 of file pseudobit.h.

◆ BIT_FILL_3

#define BIT_FILL_3 (   _ptr,
  _field1,
  ... 
)
Value:
BIT_FILL ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
BIT_ASSEMBLE_3 ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
_field1, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_3(_ptr, _index, _field, _value,...)
Definition: pseudobit.h:121
#define BIT_FILL(_ptr, _index, _assembled)
Definition: pseudobit.h:179
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91

Definition at line 195 of file pseudobit.h.

◆ BIT_FILL_4

#define BIT_FILL_4 (   _ptr,
  _field1,
  ... 
)
Value:
BIT_FILL ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
BIT_ASSEMBLE_4 ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
_field1, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_4(_ptr, _index, _field, _value,...)
Definition: pseudobit.h:125
#define BIT_FILL(_ptr, _index, _assembled)
Definition: pseudobit.h:179
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91

Definition at line 200 of file pseudobit.h.

◆ BIT_FILL_5

#define BIT_FILL_5 (   _ptr,
  _field1,
  ... 
)
Value:
BIT_FILL ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
BIT_ASSEMBLE_5 ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
_field1, __VA_ARGS__ ) )
#define BIT_ASSEMBLE_5(_ptr, _index, _field, _value,...)
Definition: pseudobit.h:129
#define BIT_FILL(_ptr, _index, _assembled)
Definition: pseudobit.h:179
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91

Definition at line 205 of file pseudobit.h.

◆ BIT_FILL_6

#define BIT_FILL_6 (   _ptr,
  _field1,
  ... 
)
Value:
BIT_FILL ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
BIT_ASSEMBLE_6 ( _ptr, QWORD_OFFSET ( _ptr, _field1 ), \
_field1, __VA_ARGS__ ) )
#define BIT_FILL(_ptr, _index, _assembled)
Definition: pseudobit.h:179
#define BIT_ASSEMBLE_6(_ptr, _index, _field, _value,...)
Definition: pseudobit.h:133
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91

Definition at line 210 of file pseudobit.h.

◆ BIT_QWORD_PTR

#define BIT_QWORD_PTR (   _ptr,
  _field 
)
Value:
( { \
unsigned int __index = QWORD_OFFSET ( _ptr, _field ); \
uint64_t *__ptr = &(_ptr)->u.qwords[__index]; \
__ptr; \
} )
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91
union @16 u

Definition at line 215 of file pseudobit.h.

◆ BIT_GET64

#define BIT_GET64 (   _ptr,
  _field 
)
Value:
( { \
unsigned int __index = QWORD_OFFSET ( _ptr, _field ); \
uint64_t *__ptr = &(_ptr)->u.qwords[__index]; \
uint64_t __value = BIT64_to_cpu ( *__ptr ); \
__value >>= \
QWORD_BIT_SHIFT ( _ptr, __index, _field ); \
__value &= BIT_MASK ( _ptr, _field ); \
__value; \
} )
unsigned long long uint64_t
Definition: stdint.h:13
#define BIT_MASK(_ptr, _field)
Bit mask for a field within a pseudo_bit_t structure.
Definition: pseudobit.h:104
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91
union @16 u

Extract value of named field.

Definition at line 223 of file pseudobit.h.

◆ BIT_GET

#define BIT_GET (   _ptr,
  _field 
)    ( ( unsigned long ) BIT_GET64 ( _ptr, _field ) )

Extract value of named field (for fields up to the size of a long)

Definition at line 235 of file pseudobit.h.

◆ BIT_SET

#define BIT_SET (   _ptr,
  _field,
  _value 
)
Value:
do { \
unsigned int __index = QWORD_OFFSET ( _ptr, _field ); \
uint64_t *__ptr = &(_ptr)->u.qwords[__index]; \
unsigned int __shift = \
QWORD_BIT_SHIFT ( _ptr, __index, _field ); \
uint64_t __value = (_value); \
*__ptr &= cpu_to_BIT64 ( ~( BIT_MASK ( _ptr, _field ) << \
__shift ) ); \
*__ptr |= cpu_to_BIT64 ( __value << __shift ); \
} while ( 0 )
#define BIT_MASK(_ptr, _field)
Bit mask for a field within a pseudo_bit_t structure.
Definition: pseudobit.h:104
#define QWORD_OFFSET(_ptr, _field)
Qword offset of a field within a pseudo_bit_t structure.
Definition: pseudobit.h:91
union @16 u
#define QWORD_BIT_SHIFT(_ptr, _index, _field)
Qword bit shift for a field within a pseudo_bit_t structure.
Definition: pseudobit.h:99

Definition at line 238 of file pseudobit.h.

Typedef Documentation

◆ pseudo_bit_t

typedef unsigned char pseudo_bit_t

Datatype used to represent a bit in the pseudo-structures.

Definition at line 59 of file pseudobit.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )