PinIO Class Reference

GPIO Pin Class. More...

#include <cpu_pins.h>

Public Types
enum	pin_fn_t {   PIN_FN_0 = 0 , PIN_FN_1 = 1 , PIN_FN_2 = 2 , PIN_FN_3 = 3 ,   PIN_FN_IN = 4 , PIN_FN_OUT = 8 , PIN_FN_IN = 4 , PIN_FN_OUT = 8 ,   PIN_FN_A , PIN_FN_B , PIN_FN_C , PIN_FN_D ,   PIN_FN_IN = 4 , PIN_FN_OUT = 8 , PIN_FN_0 = 0 , PIN_FN_1 = 1 ,   PIN_FN_2 = 2 , PIN_FN_3 = 3 , PIN_FN_4 = 6 , PIN_FN_5 = 7 ,   PIN_FN_6 = 8 , PIN_FN_7 = 9 , PIN_FN_8 = 10 , PIN_FN_9 = 11 ,   PIN_FN_10 = 12 , PIN_FN_11 = 13 , PIN_FN_12 = 14 , PIN_FN_13 = 15 ,   PIN_FN_14 = 16 , PIN_FN_15 = 17 , PIN_FN_16 = 18 , PIN_FN_17 = 19 ,   PIN_FN_18 = 20 , PIN_FN_19 = 21 , PIN_FN_20 = 22 , PIN_FN_21 = 23 ,   PIN_FN_22 = 24 , PIN_FN_23 = 25 , PIN_FN_24 = 26 , PIN_FN_25 = 27 ,   PIN_FN_26 = 28 , PIN_FN_27 = 29 , PIN_FN_28 = 30 , PIN_FN_29 = 31 ,   PIN_FN_30 = 32 , PIN_FN_31 = 33 , PIN_FN_32 = 34 }
enum	pull_t
enum	pin_fn_t {   PIN_FN_0 = 0 , PIN_FN_1 = 1 , PIN_FN_2 = 2 , PIN_FN_3 = 3 ,   PIN_FN_IN = 4 , PIN_FN_OUT = 8 , PIN_FN_IN = 4 , PIN_FN_OUT = 8 ,   PIN_FN_A , PIN_FN_B , PIN_FN_C , PIN_FN_D ,   PIN_FN_IN = 4 , PIN_FN_OUT = 8 , PIN_FN_0 = 0 , PIN_FN_1 = 1 ,   PIN_FN_2 = 2 , PIN_FN_3 = 3 , PIN_FN_4 = 6 , PIN_FN_5 = 7 ,   PIN_FN_6 = 8 , PIN_FN_7 = 9 , PIN_FN_8 = 10 , PIN_FN_9 = 11 ,   PIN_FN_10 = 12 , PIN_FN_11 = 13 , PIN_FN_12 = 14 , PIN_FN_13 = 15 ,   PIN_FN_14 = 16 , PIN_FN_15 = 17 , PIN_FN_16 = 18 , PIN_FN_17 = 19 ,   PIN_FN_18 = 20 , PIN_FN_19 = 21 , PIN_FN_20 = 22 , PIN_FN_21 = 23 ,   PIN_FN_22 = 24 , PIN_FN_23 = 25 , PIN_FN_24 = 26 , PIN_FN_25 = 27 ,   PIN_FN_26 = 28 , PIN_FN_27 = 29 , PIN_FN_28 = 30 , PIN_FN_29 = 31 ,   PIN_FN_30 = 32 , PIN_FN_31 = 33 , PIN_FN_32 = 34 }
	Pin Function modes to configure the managed pin(s). More...
enum	pull_t
	Pin pullup and pulldown modes to configure the managed pin(s).
enum	pin_fn_t {   PIN_FN_0 = 0 , PIN_FN_1 = 1 , PIN_FN_2 = 2 , PIN_FN_3 = 3 ,   PIN_FN_IN = 4 , PIN_FN_OUT = 8 , PIN_FN_IN = 4 , PIN_FN_OUT = 8 ,   PIN_FN_A , PIN_FN_B , PIN_FN_C , PIN_FN_D ,   PIN_FN_IN = 4 , PIN_FN_OUT = 8 , PIN_FN_0 = 0 , PIN_FN_1 = 1 ,   PIN_FN_2 = 2 , PIN_FN_3 = 3 , PIN_FN_4 = 6 , PIN_FN_5 = 7 ,   PIN_FN_6 = 8 , PIN_FN_7 = 9 , PIN_FN_8 = 10 , PIN_FN_9 = 11 ,   PIN_FN_10 = 12 , PIN_FN_11 = 13 , PIN_FN_12 = 14 , PIN_FN_13 = 15 ,   PIN_FN_14 = 16 , PIN_FN_15 = 17 , PIN_FN_16 = 18 , PIN_FN_17 = 19 ,   PIN_FN_18 = 20 , PIN_FN_19 = 21 , PIN_FN_20 = 22 , PIN_FN_21 = 23 ,   PIN_FN_22 = 24 , PIN_FN_23 = 25 , PIN_FN_24 = 26 , PIN_FN_25 = 27 ,   PIN_FN_26 = 28 , PIN_FN_27 = 29 , PIN_FN_28 = 30 , PIN_FN_29 = 31 ,   PIN_FN_30 = 32 , PIN_FN_31 = 33 , PIN_FN_32 = 34 }
	Pin Function modes to configure the managed pin(s). More...
enum	pull_t
	Pin pullup and pulldown modes to configure the managed pin(s).

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.
constexpr	PinIO (const PinIO &rhs)
	Construct a copy of another PinIO.
void	setFn (pin_fn_t fn) const
	Set the pin function for the managed pin(s).
int8_t	getFn ()
	Get the pin function for the managed pin(s).
void	function (pin_fn_t fn) const
	Set the pin function for the managed pin(s).
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).
bool	toggle () const
	Toggle the driven value for the pin(s).
bool	readBack () const
	Read the state of the pin(s) line state without changing the pin function or direction.
bool	read () const
	Configure the pin as an input then return the line state.
bool	operator= (bool val)
	Assign a driven value to the pin(s).
PinIO &	operator= (const PinIO &rhs)
	Assign a driven value to the pin(s) based on the line state of another pin(s).
	operator bool () const
	Read the line state of the pin(s).
bool	operator! () const
	Return the opposite of the driven value of the pin(s).
void	multidrv (bool enable) const
	Configure the multidrive/open-drain driver for the pin(s).
void	setHighStrength (bool bHighDrive)
	Configure the drive strength of the output driver for the pin(s).
void	setPull (pull_t pull)
	Configure the pad Pull resistor for the pin(s).
void	PullUp (bool enable) const
	Configure the pad Pull Up resistor for the pin(s).
void	PullDown (bool enable) const
	Configure the pad Pull Down resistor for the pin(s).
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

Friends
class	_PinVector

Detailed Description

GPIO Pin Class.

Member Enumeration Documentation

pin_fn_t [1/3]

enum PinIO::pin_fn_t

pin_fn_t

Enumerator
PIN_FN_0	Peripheral 0.
PIN_FN_1	Peripheral 1.
PIN_FN_2	Peripheral 2.
PIN_FN_3	Peripheral 3.
PIN_FN_IN	Input.
PIN_FN_OUT	Output.
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.
PIN_FN_IN	Input.
PIN_FN_OUT	Output.
PIN_FN_0	Peripheral 0.
PIN_FN_1	Peripheral 1.
PIN_FN_2	Peripheral 2.
PIN_FN_3	Peripheral 3.
PIN_FN_4	Peripheral 4.
PIN_FN_5	Peripheral 5.
PIN_FN_6	Peripheral 6.
PIN_FN_7	Peripheral 7.
PIN_FN_8	Peripheral 8.
PIN_FN_9	Peripheral 9.
PIN_FN_10	Peripheral 10.
PIN_FN_11	Peripheral 11.
PIN_FN_12	Peripheral 12.
PIN_FN_13	Peripheral 13.
PIN_FN_14	Peripheral 14.
PIN_FN_15	Peripheral 15.
PIN_FN_16	Peripheral 16.
PIN_FN_17	Peripheral 17.
PIN_FN_18	Peripheral 18.
PIN_FN_19	Peripheral 19.
PIN_FN_20	Peripheral 20.
PIN_FN_21	Peripheral 21.
PIN_FN_22	Peripheral 22.
PIN_FN_23	Peripheral 23.
PIN_FN_24	Peripheral 24.
PIN_FN_25	Peripheral 25.
PIN_FN_26	Peripheral 26.
PIN_FN_27	Peripheral 27.
PIN_FN_28	Peripheral 28.
PIN_FN_29	Peripheral 29.
PIN_FN_30	Peripheral 30.
PIN_FN_31	Peripheral 31.
PIN_FN_32	Peripheral 32.

pin_fn_t [2/3]

enum PinIO::pin_fn_t

Pin Function modes to configure the managed pin(s).

Enumerator
PIN_FN_0	Peripheral 0.
PIN_FN_1	Peripheral 1.
PIN_FN_2	Peripheral 2.
PIN_FN_3	Peripheral 3.
PIN_FN_IN	Input.
PIN_FN_OUT	Output.
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.
PIN_FN_IN	Input.
PIN_FN_OUT	Output.
PIN_FN_0	Peripheral 0.
PIN_FN_1	Peripheral 1.
PIN_FN_2	Peripheral 2.
PIN_FN_3	Peripheral 3.
PIN_FN_4	Peripheral 4.
PIN_FN_5	Peripheral 5.
PIN_FN_6	Peripheral 6.
PIN_FN_7	Peripheral 7.
PIN_FN_8	Peripheral 8.
PIN_FN_9	Peripheral 9.
PIN_FN_10	Peripheral 10.
PIN_FN_11	Peripheral 11.
PIN_FN_12	Peripheral 12.
PIN_FN_13	Peripheral 13.
PIN_FN_14	Peripheral 14.
PIN_FN_15	Peripheral 15.
PIN_FN_16	Peripheral 16.
PIN_FN_17	Peripheral 17.
PIN_FN_18	Peripheral 18.
PIN_FN_19	Peripheral 19.
PIN_FN_20	Peripheral 20.
PIN_FN_21	Peripheral 21.
PIN_FN_22	Peripheral 22.
PIN_FN_23	Peripheral 23.
PIN_FN_24	Peripheral 24.
PIN_FN_25	Peripheral 25.
PIN_FN_26	Peripheral 26.
PIN_FN_27	Peripheral 27.
PIN_FN_28	Peripheral 28.
PIN_FN_29	Peripheral 29.
PIN_FN_30	Peripheral 30.
PIN_FN_31	Peripheral 31.
PIN_FN_32	Peripheral 32.

pin_fn_t [3/3]

enum PinIO::pin_fn_t

Pin Function modes to configure the managed pin(s).

Enumerator
PIN_FN_0	Peripheral 0.
PIN_FN_1	Peripheral 1.
PIN_FN_2	Peripheral 2.
PIN_FN_3	Peripheral 3.
PIN_FN_IN	Input.
PIN_FN_OUT	Output.
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.
PIN_FN_IN	Input.
PIN_FN_OUT	Output.
PIN_FN_0	Peripheral 0.
PIN_FN_1	Peripheral 1.
PIN_FN_2	Peripheral 2.
PIN_FN_3	Peripheral 3.
PIN_FN_4	Peripheral 4.
PIN_FN_5	Peripheral 5.
PIN_FN_6	Peripheral 6.
PIN_FN_7	Peripheral 7.
PIN_FN_8	Peripheral 8.
PIN_FN_9	Peripheral 9.
PIN_FN_10	Peripheral 10.
PIN_FN_11	Peripheral 11.
PIN_FN_12	Peripheral 12.
PIN_FN_13	Peripheral 13.
PIN_FN_14	Peripheral 14.
PIN_FN_15	Peripheral 15.
PIN_FN_16	Peripheral 16.
PIN_FN_17	Peripheral 17.
PIN_FN_18	Peripheral 18.
PIN_FN_19	Peripheral 19.
PIN_FN_20	Peripheral 20.
PIN_FN_21	Peripheral 21.
PIN_FN_22	Peripheral 22.
PIN_FN_23	Peripheral 23.
PIN_FN_24	Peripheral 24.
PIN_FN_25	Peripheral 25.
PIN_FN_26	Peripheral 26.
PIN_FN_27	Peripheral 27.
PIN_FN_28	Peripheral 28.
PIN_FN_29	Peripheral 29.
PIN_FN_30	Peripheral 30.
PIN_FN_31	Peripheral 31.
PIN_FN_32	Peripheral 32.

pull_t

enum PinIO::pull_t

pull_t

Constructor & Destructor Documentation

PinIO() [1/2]

PinIO::PinIO ( uint32_t port, uint32_t pin )

inlineconstexpr

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]

PinIO::PinIO ( const PinIO & rhs )

inlineconstexpr

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).

getFn()

int8_t PinIO::getFn ( )

inline

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

Returns

The pin function as a pin_fn_t of the managed pin(s). Returns -1 if pin is not an I/O (ex: GND, VCC)

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 opposite of the driven value of the pin(s).

Returns

The opposite 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

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.

setPull()

void PinIO::setPull

(

pull_t

pull

)

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

Parameters

pull	direction and strength (if available) for the given pin

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 files:

• coldfire/cpu/MCF5441X/include/cpu_pins.h
• cortex-m7/cpu/SAME70/include/cpu_pins.h
• cortex-m7/cpu/MIMXRT10xx/include/cpu_pins.h