Port HAL functions

Functions
PinName	port_pin (PortName port, int pin_n)
	Get the pin name from the port's pin number. More...
void	port_init (port_t *obj, PortName port, int mask, PinDirection dir)
	Initilize the port. More...
void	port_mode (port_t *obj, PinMode mode)
	Set the input port mode. More...
void	port_dir (port_t *obj, PinDirection dir)
	Set port direction (in/out) More...
void	port_write (port_t *obj, int value)
	Write value to the port. More...
int	port_read (port_t *obj)
	Read the current value on the port. More...

Detailed Description

Function Documentation

port_pin()

PinName port_pin	(	PortName	port,
		int	pin_n
	)

Get the pin name from the port's pin number.

Parameters

port	The port name
pin_n	The pin number within the specified port

Returns

The pin name for the port's pin number

port_init()

void port_init	(	port_t *	obj,
		PortName	port,
		int	mask,
		PinDirection	dir
	)

Initilize the port.

Parameters

obj	The port object to initialize
port	The port name
mask	The bitmask to identify which bits in the port should be included (0 - ignore)
dir	The port direction

port_mode()

void port_mode	(	port_t *	obj,
		PinMode	mode
	)

Set the input port mode.

Parameters

obj	The port object
mode	THe port mode to be set

port_dir()

void port_dir	(	port_t *	obj,
		PinDirection	dir
	)

Set port direction (in/out)

Parameters

obj	The port object
dir	The port direction to be set

port_write()

void port_write	(	port_t *	obj,
		int	value
	)

Write value to the port.

Parameters

obj	The port object
value	The value to be set

port_read()

int port_read

(

port_t *

obj

)

Read the current value on the port.

Parameters

obj	The port object

Returns

An integer with each bit corresponding to an associated port pin setting