NetBurner 3.5.8
PDF Version
Public Member Functions | List of all members
_PinVector Class Reference
GPIO & Pin Configuration » MODM7AE70, SBE70LC (PinIO) | GPIO & Pin Configuration » SOMRT1061 (PinIO) | GPIO & Pin Configuration » MODRT1171 (PinIO)

GPIO Pin Vector Base Class. More...

#include <cpu_pins.h>

Inherited by PinVector< 4 >, PinVector< 4 >, PinVector< 4 >, PinVector< n >, PinVector< n >, and PinVector< n >.

Public Member Functions

uint32_t write (uint32_t val)
 Drive a value onto the _PinVector bus.
uint32_t read ()
 Read the line state of the _PinVector bus.
uint32_t operator= (uint32_t val)
 Assign a value to the _PinVector Bus.
PinIO operator[] (int idx)
 Access the PinIO for a specific bit position in the _PinVector.
void config (uint32_t idx, PinIO cfg)
 Set the PinIO that will be used for a given bit position in the _PinVector.
void config (PinIO *pinCfgs, uint32_t count)
 Configure the _PinVector based on an array of PinIOs. The index of the PinIO in the configuration array will determine the bit position within the _PinVector that that PinIO represents.
 operator uint32_t ()
 Read the line state of the _PinVector bus.

Detailed Description

GPIO Pin Vector Base Class.

This class is for building semi-parallel buses using GPIO pins. It facilitates driving a numeric value across a parallel bus of GPIO pins. It should not be confused with a true parallel bus, as each individual pin in the bus is modified sequentially/independently during a bus assignment.

Member Function Documentation

◆ config() [1/2]

void _PinVector::config ( PinIO * pinCfgs,
uint32_t count )

Configure the _PinVector based on an array of PinIOs. The index of the PinIO in the configuration array will determine the bit position within the _PinVector that that PinIO represents.

Parameters
pinCfgsThe configuration to be used.
countThe number of PinIOs in the configuration array to be used.

◆ config() [2/2]

void _PinVector::config ( uint32_t idx,
PinIO cfg )

Set the PinIO that will be used for a given bit position in the _PinVector.

Parameters
idxThe bit position to be configured.
cfgThe PinIO that bit position will represent.

◆ operator uint32_t()

_PinVector::operator uint32_t ( )
inline

Read the line state of the _PinVector bus.

Returns
The current bus value as read from the line state.

◆ operator=()

uint32_t _PinVector::operator= ( uint32_t val)
inline

Assign a value to the _PinVector Bus.

Parameters
valThe value to assign to the bus.
Returns
The value driven on the bus.

◆ operator[]()

PinIO _PinVector::operator[] ( int idx)

Access the PinIO for a specific bit position in the _PinVector.

Parameters
idxThe bit index to access in the _PinVector.
Returns
The PinIO for the given bit position.

◆ read()

uint32_t _PinVector::read ( )

Read the line state of the _PinVector bus.

Returns
The current bus value as read from the line state.

◆ write()

uint32_t _PinVector::write ( uint32_t val)

Drive a value onto the _PinVector bus.

Parameters
valThe value to assign to the bus.
Returns
The value driven on the bus.
The documentation for this class was generated from the following files: