mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Embed: (wiki syntax)

« Back to documentation index

PortInOut Class Reference
Public Member Functions

PortInOut Class Reference
[Drivers]

A multiple pin digital in/out used to set/read multiple bi-directional pins. More...

#include <PortInOut.h>

Public Member Functions

 PortInOut (PortName port, int mask=0xFFFFFFFF)
 Create an PortInOut, connected to the specified port.
void write (int value)
 Write the value to the output port.
int read ()
 Read the value currently output on the port.
void output ()
 Set as an output.
void input ()
 Set as an input.
void mode (PinMode mode)
 Set the input pin mode.
PortInOut & operator= (int value)
 A shorthand for write()
PortInOut & operator= (PortInOut &rhs)
 A shorthand for write()
 operator int ()
 A shorthand for read()
 PortInOut (PortName port, int mask=0xFFFFFFFF)
 Create an PortInOut, connected to the specified port.
void write (int value)
 Write the value to the output port.
int read ()
 Read the value currently output on the port.
void output ()
 Set as an output.
void input ()
 Set as an input.
void mode (PinMode mode)
 Set the input pin mode.
PortInOut & operator= (int value)
 A shorthand for write()
PortInOut & operator= (PortInOut &rhs)
 A shorthand for write()
 operator int ()
 A shorthand for read()

Detailed Description

A multiple pin digital in/out used to set/read multiple bi-directional pins.

Note:
Synchronization level: Interrupt safe

Definition at line 35 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

Constructor & Destructor Documentation

PortInOut ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create an PortInOut, connected to the specified port.

Parameters:
portPort to connect to (Port0-Port5)
maskA bitmask to identify which bits in the port should be included (0 - ignore)

Definition at line 43 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

PortInOut ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create an PortInOut, connected to the specified port.

Parameters:
portPort to connect to (Port0-Port5)
maskA bitmask to identify which bits in the port should be included (0 - ignore)

Definition at line 43 of file drivers/PortInOut.h.

Member Function Documentation

void input (  )

Set as an input.

Definition at line 80 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

void input (  )

Set as an input.

Definition at line 80 of file drivers/PortInOut.h.

void mode ( PinMode  mode )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 91 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

void mode ( PinMode  mode )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain

Definition at line 91 of file drivers/PortInOut.h.

operator int (  )

A shorthand for read()

See also:
PortInOut::read()

Definition at line 119 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

operator int (  )

A shorthand for read()

See also:
PortInOut::read()

Definition at line 119 of file drivers/PortInOut.h.

PortInOut& operator= ( PortInOut &  rhs )

A shorthand for write()

See also:
PortInOut::write()

Definition at line 110 of file drivers/PortInOut.h.

PortInOut& operator= ( int  value )

A shorthand for write()

See also:
PortInOut::write()

Definition at line 101 of file drivers/PortInOut.h.

PortInOut& operator= ( int  value )

A shorthand for write()

See also:
PortInOut::write()

Definition at line 101 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

PortInOut& operator= ( PortInOut &  rhs )

A shorthand for write()

See also:
PortInOut::write()

Definition at line 110 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

void output (  )

Set as an output.

Definition at line 71 of file drivers/PortInOut.h.

void output (  )

Set as an output.

Definition at line 71 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

int read ( void   )

Read the value currently output on the port.

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

Definition at line 64 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

int read ( void   )

Read the value currently output on the port.

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

Definition at line 64 of file drivers/PortInOut.h.

void write ( int  value )

Write the value to the output port.

Parameters:
valueAn integer specifying a bit to write for every corresponding port pin

Definition at line 54 of file cmsis/BUILD/mbed/drivers/PortInOut.h.

void write ( int  value )

Write the value to the output port.

Parameters:
valueAn integer specifying a bit to write for every corresponding port pin

Definition at line 54 of file drivers/PortInOut.h.

Generated on Tue Jul 12 2022 20:41:17 by  doxygen 1.7.2