PORT Class Reference

#include <PORT.h>

Inheritance diagram for PORT:

Public Member Functions
	PORT (GPIO_base &gpio, int port_num, uint8_t _mask=0x00)
void	config (uint8_t config)
void	set (access_word wd, uint8_t value)
PORT &	operator= (uint8_t v)
PORT &	operator= (PORT &rhs)
	operator int ()

Public Attributes
uint8_t	mask

Detailed Description

PORT: a interfacing class for GPIO operation library, Arduino

Author

Tedd OKANO

Released under the MIT license License PORT class

Simple interface for GPIO devices

Definition at line 19 of file PORT.h.

Constructor & Destructor Documentation

PORT()

PORT::PORT	(	GPIO_base &	gpio,
		int	port_num,
		uint8_t	_mask = 0x00 )

Constructor

Parameters

gpio	Pointer to GPIO device instance
port_num	Port number
mask	(option) bit mask for output

Definition at line 3 of file PORT.cpp.

Referenced by GPIO_PORT::GPIO_PORT(), and operator=().

Member Function Documentation

config()

void PORT::config

(

uint8_t

config

)

Config port

Basic GPIO port access function for single port configuration

Parameters

config

8 bit value. 0 for output, 1 for input

Definition at line 8 of file PORT.cpp.

Referenced by config().

operator int()

PORT::operator int

(

)

A short hand for reading pins

Definition at line 29 of file PORT.cpp.

operator=() [1/2]

PORT & PORT::operator=

(

PORT &

rhs

)

Definition at line 24 of file PORT.cpp.

operator=() [2/2]

PORT & PORT::operator=

(

uint8_t

v

)

A short hand for setting pins

Definition at line 18 of file PORT.cpp.

set()

void PORT::set	(	access_word	wd,
		uint8_t	value )

Write a value using an access_word register selector

Parameters

wd	Access word to select the target register
value	Value to write

Definition at line 13 of file PORT.cpp.

Member Data Documentation

mask

uint8_t PORT::mask

Mask setting

Bit mask for output. This is being initialized to 0 if _mask is not given to constructor

Definition at line 61 of file PORT.h.

Referenced by PORT().

---

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

• PORT.h
• PORT.cpp