iPXE
Data Fields
bit_basher_operations Struct Reference

Bit-bashing operations. More...

#include <bitbash.h>

Data Fields

void(* open )(struct bit_basher *basher)
 Open bit-bashing interface (optional)
void(* close )(struct bit_basher *basher)
 Close bit-bashing interface (optional)
void(* write )(struct bit_basher *basher, unsigned int bit_id, unsigned long data)
 Set/clear output bit.
int(* read )(struct bit_basher *basher, unsigned int bit_id)
 Read input bit.

Detailed Description

Bit-bashing operations.

Definition at line 15 of file bitbash.h.


Field Documentation

void( * bit_basher_operations::open)(struct bit_basher *basher)

Open bit-bashing interface (optional)

Parameters:
basherBit-bashing interface

Definition at line 21 of file bitbash.h.

Referenced by open_bit().

void( * bit_basher_operations::close)(struct bit_basher *basher)

Close bit-bashing interface (optional)

Parameters:
basherBit-bashing interface

Definition at line 27 of file bitbash.h.

Referenced by close_bit().

void( * bit_basher_operations::write)(struct bit_basher *basher, unsigned int bit_id, unsigned long data)

Set/clear output bit.

Parameters:
basherBit-bashing interface
bit_idBit number
dataValue to write

data will be 0 if a logic 0 should be written (i.e. the bit should be cleared), or -1UL if a logic 1 should be written (i.e. the bit should be set). This is done so that the method may simply binary-AND data with the appropriate bit mask.

Definition at line 41 of file bitbash.h.

Referenced by init_i2c_bit_basher(), init_spi_bit_basher(), and write_bit().

int( * bit_basher_operations::read)(struct bit_basher *basher, unsigned int bit_id)

Read input bit.

Parameters:
basherBit-bashing interface
bit_idBit number
Return values:
zeroInput is a logic 0
non-zeroInput is a logic 1

Definition at line 51 of file bitbash.h.

Referenced by init_i2c_bit_basher(), init_spi_bit_basher(), and read_bit().


The documentation for this struct was generated from the following file: