GPIO_NXP_Arduino 1.1.0
GPIO device operation sample code for Arduino
|
#include <GPIO_NXP.h>
Public Types | |
enum | reg_num { Input_Port_0 , Input_Port_1 , Input_Port_2 , reserved0 , Output_Port_0 , Output_Port_1 , Output_Port_2 , reserved1 , Polarity_Inversion_port_0 , Polarity_Inversion_port_1 , Polarity_Inversion_port_2 , reserved2 , Configuration_port_0 , Configuration_port_1 , Configuration_port_2 , Output_drive_strength_register_port_0A =0x40 , Output_drive_strength_register_port_0B , Output_drive_strength_register_port_1A , Output_drive_strength_register_port_1B , Output_drive_strength_register_port_2A , Output_drive_strength_register_port_2B , reserved3 , reserved4 , Input_latch_register_port_0 , Input_latch_register_port_1 , Input_latch_register_port_2 , reserved5 , Pull_up_pull_down_enable_register_port_0 , Pull_up_pull_down_enable_register_port_1 , Pull_up_pull_down_enable_register_port_2 , reserved6 , Pull_up_pull_down_selection_register_port_0 , Pull_up_pull_down_selection_register_port_1 , Pull_up_pull_down_selection_register_port_2 , reserved7 , Interrupt_mask_register_port_0 , Interrupt_mask_register_port_1 , Interrupt_mask_register_port_2 , reserved8 , Interrupt_status_register_port_0 , Interrupt_status_register_port_1 , Interrupt_status_register_port_2 , reserved9 , Output_port_configuration_register , reserved10 , reserved11 , reserved12 , Interrupt_edge_register_port_0A , Interrupt_edge_register_port_0B , Interrupt_edge_register_port_1A , Interrupt_edge_register_port_1B , Interrupt_edge_register_port_2A , Interrupt_edge_register_port_2B , reserved13 , reserved14 , Interrupt_clear_register_port_0 , Interrupt_clear_register_port_1 , Interrupt_clear_register_port_2 , reserved15 , Input_status_port_0 , Input_status_port_1 , Input_status_port_2 , reserved16 , Individual_pin_output_port_0_configuration_register , Individual_pin_output_port_1_configuration_register , Individual_pin_output_port_2_configuration_register , reserved17 , Switch_debounce_enable_0 , Switch_debounce_enable_1 , Switch_debounce_count } |
enum | board { NONE , ARDUINO_SHIELD } |
![]() | |
enum | board { NONE , ARDUINO_SHIELD } |
Public Member Functions | |
PCAL6524 (uint8_t i2c_address=(0x44 > > 1)+0) | |
PCAL6524 (TwoWire &wire, uint8_t i2c_address=(0x44 > > 1)+0) | |
virtual | ~PCAL6524 () |
void | begin (board env=NONE) |
void | output (int port, uint8_t value, uint8_t mask=0) |
void | output (const uint8_t *vp) |
uint8_t | input (int port) |
uint8_t * | input (uint8_t *vp) |
void | config (int port, uint8_t config, uint8_t mask=0) |
void | config (const uint8_t *vp) |
void | write_port (access_word w, const uint8_t *vp) |
void | write_port16 (access_word w, const uint16_t *vp) |
uint8_t * | read_port (access_word w, uint8_t *vp) |
uint16_t * | read_port16 (access_word w, uint16_t *vp) |
void | write_port (access_word w, uint8_t value, int port_num=0) |
void | write_port16 (access_word w, uint16_t value, int port_num=0) |
uint8_t | read_port (access_word w, int port_num=0) |
uint16_t | read_port16 (access_word w, int port_num=0) |
bool | ping (void) |
int | reg_w (uint8_t reg_adr, const uint8_t *data, uint16_t size) |
int | reg_w (uint8_t reg_adr, uint8_t data) |
int | reg_r (uint8_t reg_adr, uint8_t *data, uint16_t size) |
uint8_t | reg_r (uint8_t reg_adr) |
void | write_r8 (uint8_t reg, uint8_t val) |
void | write_r16 (uint8_t reg, uint16_t val) |
uint8_t | read_r8 (uint8_t reg) |
uint16_t | read_r16 (uint8_t reg) |
void | bit_op8 (uint8_t reg, uint8_t mask, uint8_t value) |
void | bit_op16 (uint8_t reg, uint16_t mask, uint16_t value) |
![]() | |
PCAL6xxx_base (uint8_t i2c_address, const int nbits, const uint8_t arp[], uint8_t ai) | |
PCAL6xxx_base (TwoWire &wire, uint8_t i2c_address, const int nbits, const uint8_t arp[], uint8_t ai) | |
![]() | |
GPIO_base (uint8_t i2c_address, int nbits, const uint8_t *arp, uint8_t ai) | |
GPIO_base (TwoWire &wire, uint8_t i2c_address, int nbits, const uint8_t *arp, uint8_t ai) | |
virtual | ~GPIO_base () |
virtual void | begin (board env=NONE) |
Public Attributes | |
const int | n_bits |
const int | n_ports |
![]() | |
const int | n_bits |
const int | n_ports |
Static Public Attributes | |
static constexpr uint8_t | access_ref [NUM_access_word] |
Additional Inherited Members | |
![]() | |
static void | print_bin (uint8_t v) |
![]() | |
const uint8_t | auto_increment |
PCAL6524 class
Definition at line 1419 of file GPIO_NXP.h.
enum PCAL6524::board |
Constants for begin() method
Definition at line 1480 of file GPIO_NXP.h.
enum PCAL6524::reg_num |
Name of the PCAL6524 registers
Definition at line 1423 of file GPIO_NXP.h.
PCAL6524::PCAL6524 | ( | uint8_t | i2c_address = (0x44 >> 1) + 0 | ) |
PCAL6524::PCAL6524 | ( | TwoWire & | wire, |
uint8_t | i2c_address = (0x44 >> 1) + 0 ) |
Constractor
wire | TwoWire instance |
i2c_address | I2C target address |
Definition at line 296 of file GPIO_NXP.cpp.
|
virtual |
Destractor
Definition at line 301 of file GPIO_NXP.cpp.
void PCAL6524::begin | ( | board | env = NONE | ) |
Device/board initialization
This method is needed to initialize Arduino-shield type evaluation boards from NXP. This method takes one argument of "PCAL6524::ARDUINO_SHIELD" to set RESET and ADDRESS pins.
If the devoce is used as it self, this method doesn't need to be called.
env | This argument can be given as "PCAL6524::NONE" ot "PCAL6524::ARDUINO_SHIELD" |
void PCAL6524::bit_op8 | ( | uint8_t | reg, |
uint8_t | mask, | ||
uint8_t | value ) |
Register overwriting with bit-mask
Register can be updated by bit level
reg | register index/address/pointer |
mask | bit-mask to protect overwriting |
value | value to overwrite |
|
virtual |
Config, all ports
Basic GPIO port access function for all port configuration
vp | Pointer to array of configuration values. The array should have 'n_ports' length |
Reimplemented from GPIO_base.
|
virtual |
Config, single port
Basic GPIO port access function for single port configuration
port | Port number |
value | Value to be written into configuration register |
mask | Bit mask. Value will not be changed in bit positions '1' in mask |
Reimplemented from GPIO_base.
|
virtual |
Input, single port
Basic GPIO port access function for single port input
port | Port number |
Reimplemented from GPIO_base.
|
virtual |
Input, all ports
Basic GPIO port access function for all ports input
vp | Pointer to an array of values. The array should have 'n_ports' length |
Reimplemented from GPIO_base.
|
virtual |
Output, all ports
Basic GPIO port access function for all ports output
vp | Pointer to an array of values. The array should have 'n_ports' length |
Reimplemented from GPIO_base.
|
virtual |
Output, single port
Basic GPIO port access function for single port output
port | Port number |
value | Value to be output |
mask | Bit mask. Value will not be changed in bit positions '1' in mask |
Reimplemented from GPIO_base.
bool PCAL6524::ping | ( | void | ) |
Ping the device
|
virtual |
Read single port method
Single port register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
port_num | Option, to specify port number |
Reimplemented from GPIO_base.
|
virtual |
Read all port method
All port register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
vp | Pointer to an array of values. The array should have 'n_ports' length |
Reimplemented from GPIO_base.
|
virtual |
Read single port method
Single port 16 bit register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
port_num | Option, to specify port number |
Reimplemented from GPIO_base.
|
virtual |
Read all port method
All port 16 bit register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
vp | Pointer to an array of values. The array should have 'n_ports' length |
Reimplemented from GPIO_base.
uint16_t PCAL6524::read_r16 | ( | uint8_t | reg | ) |
Register read, 16 bit
This 16 bit access may ot be common but it's useful for sensor devices
reg | register index/address/pointer |
uint8_t PCAL6524::read_r8 | ( | uint8_t | reg | ) |
Register read, 8 bit
reg | register index/address/pointer |
uint8_t PCAL6524::reg_r | ( | uint8_t | reg_adr | ) |
Single register read
reg | register index/address/pointer |
int PCAL6524::reg_r | ( | uint8_t | reg_adr, |
uint8_t * | data, | ||
uint16_t | size ) |
Multiple register read
reg | register index/address/pointer |
data | pointer to data buffer |
size | data size |
int PCAL6524::reg_w | ( | uint8_t | reg_adr, |
const uint8_t * | data, | ||
uint16_t | size ) |
Multiple register write
reg | register index/address/pointer |
data | pointer to data buffer |
size | data size |
int PCAL6524::reg_w | ( | uint8_t | reg_adr, |
uint8_t | data ) |
Single register write
reg | register index/address/pointer |
data | pointer to data buffer |
size | data size |
|
virtual |
Write all port method
All port register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
vp | Pointer to an array of values. The array should have 'n_ports' length |
Reimplemented from GPIO_base.
|
virtual |
Write single port method
Single port register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
value | Value to be written into a register |
port_num | Option, to specify port number |
Reimplemented from GPIO_base.
|
virtual |
Write all port method
All port 16 bit register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
vp | Pointer to an array of values. The array should have 'n_ports' length |
Reimplemented from GPIO_base.
|
virtual |
Write single port method
Single port 16 bit register access function using word of 'access_word'
w | Accsess word. This should be choosen from access_word' |
value | Value to be written into a register |
port_num | Option, to specify port number |
Reimplemented from GPIO_base.
void PCAL6524::write_r16 | ( | uint8_t | reg, |
uint16_t | val ) |
Register write, 16 bit
This 16 bit access may ot be common but it's useful for sensor devices
reg | register index/address/pointer |
val | data value |
void PCAL6524::write_r8 | ( | uint8_t | reg, |
uint8_t | val ) |
Register write, 8 bit
reg | register index/address/pointer |
val | data value |
|
staticconstexpr |
Definition at line 1464 of file GPIO_NXP.h.
const int PCAL6524::n_bits |
Number of IO bits
Definition at line 1486 of file GPIO_NXP.h.
const int PCAL6524::n_ports |
Number of IO ports
Definition at line 1489 of file GPIO_NXP.h.