#include <BusInOut.h>

Inheritance diagram for mbed::BusInOut:

Public Member Functions
	BusInOut (PinName p0, PinName p1=NC, PinName p2=NC, PinName p3=NC, PinName p4=NC, PinName p5=NC, PinName p6=NC, PinName p7=NC, PinName p8=NC, PinName p9=NC, PinName p10=NC, PinName p11=NC, PinName p12=NC, PinName p13=NC, PinName p14=NC, PinName p15=NC)

	BusInOut (PinName pins[16])

void	write (int value)

int	read ()

void	output ()

void	input ()

void	mode (PinMode pull)

int	mask ()

BusInOut &	operator= (int v)

BusInOut &	operator= (BusInOut &rhs)

DigitalInOut &	operator[] (int index)

	operator int ()

Protected Member Functions
virtual void	lock ()

virtual void	unlock ()

Protected Attributes
DigitalInOut *	_pin [16]

int	_nc_mask

PlatformMutex	_mutex

Detailed Description

A digital input output bus, used for setting the state of a collection of pins

Note: Synchronization level: Thread safe

Constructor & Destructor Documentation

mbed::BusInOut::BusInOut	(	PinName	p0,
		PinName	p1 = `NC`,
		PinName	p2 = `NC`,
		PinName	p3 = `NC`,
		PinName	p4 = `NC`,
		PinName	p5 = `NC`,
		PinName	p6 = `NC`,
		PinName	p7 = `NC`,
		PinName	p8 = `NC`,
		PinName	p9 = `NC`,
		PinName	p10 = `NC`,
		PinName	p11 = `NC`,
		PinName	p12 = `NC`,
		PinName	p13 = `NC`,
		PinName	p14 = `NC`,
		PinName	p15 = `NC`
	)

Create an BusInOut, connected to the specified pins

Parameters

p0	DigitalInOut pin to connect to bus bit
p1	DigitalInOut pin to connect to bus bit
p2	DigitalInOut pin to connect to bus bit
p3	DigitalInOut pin to connect to bus bit
p4	DigitalInOut pin to connect to bus bit
p5	DigitalInOut pin to connect to bus bit
p6	DigitalInOut pin to connect to bus bit
p7	DigitalInOut pin to connect to bus bit
p8	DigitalInOut pin to connect to bus bit
p9	DigitalInOut pin to connect to bus bit
p10	DigitalInOut pin to connect to bus bit
p11	DigitalInOut pin to connect to bus bit
p12	DigitalInOut pin to connect to bus bit
p13	DigitalInOut pin to connect to bus bit
p14	DigitalInOut pin to connect to bus bit
p15	DigitalInOut pin to connect to bus bit

Note: It is only required to specify as many pin variables as is required for the bus; the rest will default to NC (not connected)

mbed::BusInOut::BusInOut ( PinName pins[16] )

Create an BusInOut, connected to the specified pins

Parameters

pins	An array of pins to construct a BusInOut from

Member Function Documentation

void mbed::BusInOut::input ( )

Set as an input

int mbed::BusInOut::mask ( )

inline

Binary mask of bus pins connected to actual pins (not NC pins) If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1

Returns: Binary mask of connected pins

void mbed::BusInOut::mode ( PinMode pull )

Set the input pin mode

Parameters

pull	PullUp, PullDown, PullNone

mbed::BusInOut::operator int ( )

A shorthand for read()

See also: BusInOut::read()

BusInOut & mbed::BusInOut::operator= ( int v )

A shorthand for write()

See also: BusInOut::write()

DigitalInOut & mbed::BusInOut::operator[] ( int index )

Access to particular bit in random-iterator fashion

Parameters

index Bit Position

void mbed::BusInOut::output ( )

Set as an output

int mbed::BusInOut::read ( )

Read the value currently output on the bus

Returns: An integer with each bit corresponding to associated DigitalInOut pin setting

void mbed::BusInOut::write ( int value )

Write the value to the output bus

Parameters

value An integer specifying a bit to write for every corresponding DigitalInOut pin

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

mbed-os/drivers/BusInOut.h
mbed-os/drivers/BusInOut.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Important Information for this Arm website