class::hal::SwitchboardTerminal

class hal::SwitchboardTerminal
  : public api::InfoObject

A Switchboard terminal defines the data structure for either an input or an output.

Inputs and outputs are defined identically. When a terminal is passed to the Switchboard as an input it will be read. And when passed as an output, it will be written.

Summary

[SwitchboardTerminal](#classhal_1_1_switchboard_terminal_1a9cc44cac5611b0e4a18fd366fc54260a)(  

const var::ConstString & name,
int loc,
s8 priority
)

[SwitchboardTerminal](#classhal_1_1_switchboard_terminal_1a71019e720e2ba24f39e9c41a41ae06e0)(  

const switchboard_terminal_t & terminal
)

u32 bytes_transferred() const

u32 loc() const

var::ConstString name() const

s8 priority() const

void set_loc(

int loc
)

void set_name(

const var::ConstString & name
)

void set_priority(

s8 priority
)

Members

SwitchboardTerminal(

const var::ConstString & name,
int loc,
s8 priority
)

Constructs a new Switchboard terminal.

Parameters

  • name The name of the terminal (e.g. uart0 – not /dev/uart0)

  • loc The channel/location to read or write

  • priority Zero for default priority


SwitchboardTerminal(

const switchboard_terminal_t & terminal
)

Constructs a terminal from a switchboard_terminal_t.


u32 bytes_transferred() const

Returns the number of bytes transferred on the terminal.


u32 loc() const

Returns the location/channel value for the terminal.


var::ConstString name() const

Returns the terminal’s name.


s8 priority() const

Returns the terminal interrupt priority.


void set_loc(

int loc
)

Sets the location/channel of the terminal.


void set_name(

const var::ConstString & name
)

Sets the name of the terminal.

Parameters

  • name A pointer to the terminal name

void set_priority(

s8 priority
)

Sets the priority of the terminal.


X

Thanks for Coming!

Subscribe to news and updates