PinIO Class Reference

GPIO Pin Class. More...

Public Types
enum	pin_fn_t {   PIN_FN_IN = 0, PIN_FN_OUT, PIN_FN_A, PIN_FN_B,   PIN_FN_C, PIN_FN_D }

Public Member Functions
	PinIO ()
	Construct an empty PinIO. Exists for bootstrap compatibility; not intended for general use.
constexpr	PinIO (uint32_t port, uint32_t pin)
	Construct a PinIO for a specific cpu pin. More...
constexpr	PinIO (const PinIO &rhs)
	Construct a copy of another PinIO. More...
void	setFn (pin_fn_t fn) const
	Set the pin function for the managed pin(s). More...
void	function (pin_fn_t fn) const
	Set the pin function for the managed pin(s). More...
void	hiz () const
	Configure the pin(s) to Input.
void	drive () const
	Configure the pin(s) to Output, without modifying the driven value.
void	set () const
	Drive the pin(s) High.
void	clr () const
	Drive the pin(s) Low.
bool	tgl () const
	Toggle the driven value for the pin(s). More...
bool	toggle () const
	Toggle the driven value for the pin(s). More...
bool	readBack () const
	Read the state of the pin(s) line state without changing the pin function or direction. More...
bool	read () const
	Configure the pin as an input then return the line state. More...
bool	operator= (bool val)
	Assign a driven value to the pin(s). More...
PinIO &	operator= (const PinIO &rhs)
	Assign a driven value to the pin(s) based on the line state of another pin(s). More...
	operator bool () const
	Read the line state of the pin(s). More...
bool	operator! () const
	Return the oposite of the driven value of the pin(s). More...
void	multidrv (bool enable) const
	Configure the multidrive/open-drain driver for the pin(s). More...
void	setHighStrength (bool bHighDrive)
	Configure the drive strength of the output driver for the pin(s). More...
void	PullUp (bool enable) const
	Configure the pad Pull Up resistor for the pin(s). More...
void	PullDown (bool enable) const
	Configure the pad Pull Down resistor for the pin(s). More...
uint16_t	analogRead () const
	Read an analog voltage on the given Pin. Only available for pins connected to the ADC.

Public Attributes
volatile Pio &	pio
uint32_t	mask

Detailed Description

GPIO Pin Class.

Member Enumeration Documentation

pin_fn_t

enum PinIO::pin_fn_t

Enumerator
PIN_FN_IN	Input.
PIN_FN_OUT	Output.
PIN_FN_A	Peripheral A.
PIN_FN_B	Peripheral B.
PIN_FN_C	Peripheral C.
PIN_FN_D	Peripheral D.

Constructor & Destructor Documentation

PinIO() [1/2]

constexpr PinIO::PinIO ( uint32_t  port, uint32_t  pin  )

inline

Construct a PinIO for a specific cpu pin.

Parameters

port	The zero-indexed numeric instance number of the desired Pio module. (PIOA=0, PIOB=1, PIOC=2, etc.)
pin	The zero-indexed pin number within the requested port that the new PinIO is to manage.

Example usage for pin 'PIOD_24'

PinIO LED1(3, 24);

PinIO() [2/2]

constexpr PinIO::PinIO ( const PinIO &  rhs )

inline

Construct a copy of another PinIO.

Parameters

rhs	The PinIO to construct a copy of.

Member Function Documentation

function()

void PinIO::function ( pin_fn_t  fn ) const

inline

Set the pin function for the managed pin(s).

Parameters

fn	The pin function to be assigned to the managed pin(s).

multidrv()

void PinIO::multidrv ( bool  enable ) const

inline

Configure the multidrive/open-drain driver for the pin(s).

Parameters

enable

True: configure the output driver as Open Drain. False: configure the output driver as Push-Pull.

operator bool()

PinIO::operator bool ( ) const

inline

Read the line state of the pin(s).

Returns

The line state of the pin(s): true = High, false = Low

operator!()

bool PinIO::operator! ( ) const

inline

Return the oposite of the driven value of the pin(s).

Returns

The oposite of the driven value of the pin(s).

operator=() [1/2]

bool PinIO::operator= ( bool  val )

inline

Assign a driven value to the pin(s).

Parameters

val	The value to be driven on the pin(s): true = High, false = Low

Returns

The driven value for the pin(s).

operator=() [2/2]

PinIO& PinIO::operator= ( const PinIO &  rhs )

inline

Assign a driven value to the pin(s) based on the line state of another pin(s).

Parameters

rhs	The pin(s) who's line state will be assigned to this pin.

Returns

A copy of the PinIO being assigned to.

PullDown()

void PinIO::PullDown ( bool  enable ) const

inline

Configure the pad Pull Down resistor for the pin(s).

Parameters

enable

True: enable the pad Pull Down. False: disable the pad Pull Down.

PullUp()

void PinIO::PullUp ( bool  enable ) const

inline

Configure the pad Pull Up resistor for the pin(s).

Parameters

enable

True: enable the pad Pull Up. False: disable the pad Pull Up.

read()

bool PinIO::read ( ) const

inline

Configure the pin as an input then return the line state.

Returns

The line state of the pin(s).

readBack()

bool PinIO::readBack ( ) const

inline

Read the state of the pin(s) line state without changing the pin function or direction.

Returns

The line state of the pin(s).

setFn()

void PinIO::setFn ( pin_fn_t  fn ) const

inline

Set the pin function for the managed pin(s).

Parameters

fn	The pin function to be assigned to the managed pin(s).

setHighStrength()

void PinIO::setHighStrength ( bool  bHighDrive )

inline

Configure the drive strength of the output driver for the pin(s).

Parameters

bHighDrive

True: configure the output driver for High Drive strength. False: configure the output driver for Low Drive strength.

tgl()

bool PinIO::tgl ( ) const

inline

Toggle the driven value for the pin(s).

Returns

The previously driven value for the pin(s).

toggle()

bool PinIO::toggle ( ) const

inline

Toggle the driven value for the pin(s).

Returns

The previously driven value for the pin(s).

---

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

• cpu_pins.h