GPIO_NXP.h

 
#ifndef ARDUINO_GPIO_NXP_ARD_H
#define ARDUINO_GPIO_NXP_ARD_H
 
#include    <Arduino.h>
#include    <stdint.h>
 
#include    <I2C_device.h>

enum access_word : uint8_t
{
    IN,
    OUT,
    POLARITY,
    CONFIG,
    DRIVE_STRENGTH,
    LATCH,
    PULL_UD_EN,
    PULL_UD_SEL,
    INT_MASK,
    INT_STATUS,
    OUTPUT_PORT_CONFIG,
    NUM_access_word, 
};

class GPIO_base : public I2C_device
{
public:
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };
    
    const int   n_bits;

    const int   n_ports;
    
    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 );
    
    virtual void        output( int port, uint8_t value, uint8_t mask = 0 );

    virtual void        output( const uint8_t *vp );
    
    virtual uint8_t     input( int port );

    virtual uint8_t*    input( uint8_t *vp );

    virtual void        config( int port, uint8_t config, uint8_t mask = 0 );

    virtual void        config( const uint8_t* vp );

    virtual void        write_port( access_word w, const uint8_t* vp );

    virtual void        write_port16( access_word w, const uint16_t* vp );

    virtual uint8_t*    read_port( access_word w, uint8_t* vp );

    virtual uint16_t*   read_port16( access_word w, uint16_t* vp );

    virtual void        write_port( access_word w, uint8_t value, int port_num = 0 );

    virtual void        write_port16( access_word w, uint16_t value, int port_num = 0 );

    virtual uint8_t     read_port( access_word w, int port_num = 0 );

    virtual uint16_t    read_port16( access_word w, int port_num = 0 );

    static void print_bin( uint8_t v );
 
protected:  
    const uint8_t   auto_increment;
 
private:
    const uint8_t*  arp;
    bool            endian;
    
    static constexpr int RESET_PIN  = 8;
    static constexpr int ADDR_PIN   = 9;
    
    void init( void );
};

class PCA9554 : public GPIO_base
{
public:
    enum reg_num {
        Input_Port,
        Output_Port,
        Polarity_Inversion,
        Configuration,
    };
    
    PCA9554( uint8_t i2c_address = (0x40 >> 1) + 0 );

    PCA9554( TwoWire& wire, uint8_t i2c_address = (0x40 >> 1) + 0 );

    virtual ~PCA9554();
 
    static constexpr uint8_t    access_ref[ NUM_access_word ]   = {
        Input_Port,         //  IN,
        Output_Port,        //  OUT
        Polarity_Inversion, //  POLARITY
        Configuration,      //  CONFIG
        0xFF,   //  DRIVE_STRENGTH      ** CANNOT BE USED **
        0xFF,   //  LATCH           ** CANNOT BE USED **
        0xFF,   //  PULL_UD_EN          ** CANNOT BE USED **
        0xFF,   //  PULL_UD_SEL         ** CANNOT BE USED **
        0xFF,   //  INT_MASK            ** CANNOT BE USED **
        0xFF,   //  INT_STATUS          ** CANNOT BE USED **
        0xFF,   //  OUTPUT_PORT_CONFIG  ** CANNOT BE USED **
    };
    
#if DOXYGEN_ONLY
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };

    const int   n_bits;

    const int   n_ports;

    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 );
#endif  //  DOXYGEN_ONLY
 
};

class PCA9555 : public GPIO_base
{
public:
    enum reg_num {
        Input_Port_0, Input_Port_1, 
        Output_Port_0, Output_Port_1, 
        Polarity_Inversion_Port_0, Polarity_Inversion_Port_1, 
        Configuration_Port_0, Configuration_Port_1, 
    };
    
    PCA9555( uint8_t i2c_address = (0x40 >> 1) + 0 );

    PCA9555( TwoWire& wire, uint8_t i2c_address = (0x40 >> 1) + 0 );

    virtual ~PCA9555();
 
    static constexpr uint8_t    access_ref[ NUM_access_word ]   = {
        Input_Port_0,               //  IN,
        Output_Port_0,              //  OUT
        Polarity_Inversion_Port_0,  //  POLARITY
        Configuration_Port_0,       //  CONFIG
        0xFF,   //  DRIVE_STRENGTH      ** CANNOT BE USED **
        0xFF,   //  LATCH           ** CANNOT BE USED **
        0xFF,   //  PULL_UD_EN          ** CANNOT BE USED **
        0xFF,   //  PULL_UD_SEL         ** CANNOT BE USED **
        0xFF,   //  INT_MASK            ** CANNOT BE USED **
        0xFF,   //  INT_STATUS          ** CANNOT BE USED **
        0xFF,   //  OUTPUT_PORT_CONFIG  ** CANNOT BE USED **
    };
 
#if DOXYGEN_ONLY
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };

    const int   n_bits;

    const int   n_ports;

    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 );
#endif  //  DOXYGEN_ONLY
};

class PCAL6xxx_base : public GPIO_base
{
public:
    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 );

    virtual ~PCAL6xxx_base();
};
 

class PCAL6408A : public PCAL6xxx_base
{
public:
    enum reg_num {
        Input_Port,
        Output_Port,
        Polarity_Inversion,
        Configuration,
        Output_drive_strength_0 = 0x40,
        Output_drive_strength_1,
        Input_latch,
        Pull_up_pull_down_enable,
        Pull_up_pull_down_selection,
        Interrupt_mask,
        Interrupt_status,
        Output_port_configuration,
    };
    
    PCAL6408A( uint8_t i2c_address = (0x40 >> 1) + 0 );

    PCAL6408A( TwoWire& wire, uint8_t i2c_address = (0x40 >> 1) + 0 );

    virtual ~PCAL6408A();
 
    static constexpr uint8_t    access_ref[ NUM_access_word ]   = {
        Input_Port,                     //  IN,
        Output_Port,                    //  OUT
        Polarity_Inversion,             //  POLARITY
        Configuration,                  //  CONFIG
        Output_drive_strength_0,        //  DRIVE_STRENGTH
        Input_latch,                    //  LATCH
        Pull_up_pull_down_enable,       //  PULL_UD_EN
        Pull_up_pull_down_selection,    //  PULL_UD_SEL
        Interrupt_mask,                 //  INT_MASK
        Interrupt_status,               //  INT_STATUS
        Output_port_configuration,      //  OUTPUT_PORT_CONFIG
    };
 
#if DOXYGEN_ONLY
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };

    const int   n_bits;

    const int   n_ports;

    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 );
#endif  //  DOXYGEN_ONLY
};

class PCAL6416A : public PCAL6xxx_base
{
public:
    enum reg_num {
        Input_Port_0, Input_Port_1,
        Output_Port_0, Output_Port_1,
        Polarity_Inversion_port_0, Polarity_Inversion_port_1,
        Configuration_port_0, Configuration_port_1,
        Output_drive_strength_register_0=0x40, Output_drive_strength_register_0B,
        Output_drive_strength_register_1, Output_drive_strength_register_1B,
        Input_latch_register_0, Input_latch_register_1, 
        Pull_up_pull_down_enable_register_0, Pull_up_pull_down_enable_register_1, 
        Pull_up_pull_down_selection_register_0, Pull_up_pull_down_selection_register_1, 
        Interrupt_mask_register_0, Interrupt_mask_register_1, 
        Interrupt_status_register_0, Interrupt_status_register_1, 
        Output_port_configuration_register,  
    };
    
    PCAL6416A( uint8_t i2c_address = (0x40 >> 1) + 0 );

    PCAL6416A( TwoWire& wire, uint8_t i2c_address = (0x40 >> 1) + 0 );

    virtual ~PCAL6416A();
 
    static constexpr uint8_t    access_ref[ NUM_access_word ]   = {
        Input_Port_0,                           //  IN,
        Output_Port_0,                          //  OUT
        Polarity_Inversion_port_0,              //  POLARITY
        Configuration_port_0,                   //  CONFIG
        Output_drive_strength_register_0,       //  DRIVE_STRENGTH
        Input_latch_register_0,                 //  LATCH
        Pull_up_pull_down_enable_register_0,    //  PULL_UD_EN
        Pull_up_pull_down_selection_register_0, //  PULL_UD_SEL
        Interrupt_mask_register_0,              //  INT_MASK
        Interrupt_status_register_0,            //  INT_STATUS
        Output_port_configuration_register,     //  OUTPUT_PORT_CONFIG
    };
 
#if DOXYGEN_ONLY
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };

    const int   n_bits;

    const int   n_ports;

    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 );
#endif  //  DOXYGEN_ONLY
};

class PCAL6524 : public PCAL6xxx_base
{
public:
    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, 
    };
    
    PCAL6524( uint8_t i2c_address = (0x44 >> 1) + 0 );

    PCAL6524( TwoWire& wire, uint8_t i2c_address = (0x44 >> 1) + 0 );

    virtual ~PCAL6524();
 
    static constexpr uint8_t    access_ref[ NUM_access_word ]   = {
        Input_Port_0,                                   //  IN,
        Output_Port_0,                                  //  OUT
        Polarity_Inversion_port_0,                      //  POLARITY
        Configuration_port_0,                           //  CONFIG
        Output_drive_strength_register_port_0A,         //  DRIVE_STRENGTH
        Input_latch_register_port_0,                    //  LATCH
        Pull_up_pull_down_enable_register_port_0,       //  PULL_UD_EN
        Pull_up_pull_down_selection_register_port_0,    //  PULL_UD_SEL
        Interrupt_mask_register_port_0,                 //  INT_MASK
        Interrupt_status_register_port_0,               //  INT_STATUS
        Output_port_configuration_register,             //  OUTPUT_PORT_CONFIG
    };
 
#if DOXYGEN_ONLY
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };

    const int   n_bits;

    const int   n_ports;

    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 );
#endif  //  DOXYGEN_ONLY
};

class PCAL6534 : public PCAL6xxx_base
{
public:
    enum reg_num {
        Input_Port_0,  Input_Port_1,  Input_Port_2,  Input_Port_3,  Input_Port_4,
        Output_Port_0, Output_Port_1, Output_Port_2, Output_Port_3, Output_Port_4,
        Polarity_Inversion_port_0, Polarity_Inversion_port_1, Polarity_Inversion_port_2, Polarity_Inversion_port_3, Polarity_Inversion_port_4,
        Configuration_port_0, Configuration_port_1, Configuration_port_2, Configuration_port_3, Configuration_port_4,
        Output_drive_strength_register_port_0A  = 0x30, 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,
        Output_drive_strength_register_port_3A, Output_drive_strength_register_port_3B,
        Output_drive_strength_register_port_4A, reserved0,
        Input_latch_register_port_0, Input_latch_register_port_1, Input_latch_register_port_2, Input_latch_register_port_3, Input_latch_register_port_4,
        Pull_up_pull_down_enable_register_port_0, Pull_up_pull_down_enable_register_port_1, Pull_up_pull_down_enable_register_port_2, Pull_up_pull_down_enable_register_port_3, Pull_up_pull_down_enable_register_port_4,
        Pull_up_pull_down_selection_register_port_0, Pull_up_pull_down_selection_register_port_1, Pull_up_pull_down_selection_register_port_2, Pull_up_pull_down_selection_register_port_3, Pull_up_pull_down_selection_register_port_4,
        Interrupt_mask_register_port_0, Interrupt_mask_register_port_1, Interrupt_mask_register_port_2, Interrupt_mask_register_port_3, Interrupt_mask_register_port_4,
        Interrupt_status_register_port_0, Interrupt_status_register_port_1, Interrupt_status_register_port_2, Interrupt_status_register_port_3, Interrupt_status_register_port_4,
        Output_port_configuration_register,
        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,
        Interrupt_edge_register_port_3A, Interrupt_edge_register_port_3B,
        Interrupt_edge_register_port_4A, reserved1,
        Interrupt_clear_register_port_0, Interrupt_clear_register_port_1, Interrupt_clear_register_port_2, Interrupt_clear_register_port_3, Interrupt_clear_register_port_4,
        Input_status_port_0, Input_status_port_1, Input_status_port_2, Input_status_port_3, Input_status_port_4,
        Individual_pin_output_port_0_configuration_register, Individual_pin_output_port_1_configuration_register, Individual_pin_output_port_2_configuration_register, Individual_pin_output_port_3_configuration_register, Individual_pin_output_port_4_configuration_register,
        Switch_debounce_enable_0, Switch_debounce_enable_1,
        Switch_debounce_count,
    };
    
    PCAL6534( uint8_t i2c_address = (0x44 >> 1) + 0 );

    PCAL6534( TwoWire& wire, uint8_t i2c_address = (0x44 >> 1) + 0 );

    virtual ~PCAL6534();
 
    static constexpr uint8_t    access_ref[ NUM_access_word ]   = {
        Input_Port_0,                                   //  IN,
        Output_Port_0,                                  //  OUT
        Polarity_Inversion_port_0,                      //  POLARITY
        Configuration_port_0,                           //  CONFIG
        Output_drive_strength_register_port_0A,         //  DRIVE_STRENGTH
        Input_latch_register_port_0,                    //  LATCH
        Pull_up_pull_down_enable_register_port_0,       //  PULL_UD_EN
        Pull_up_pull_down_selection_register_port_0,    //  PULL_UD_SEL
        Interrupt_mask_register_port_0,                 //  INT_MASK
        Interrupt_status_register_port_0,               //  INT_STATUS
        Output_port_configuration_register,             //  OUTPUT_PORT_CONFIG
    };
 
#if DOXYGEN_ONLY
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };

    const int   n_bits;

    const int   n_ports;

    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 );
#endif  //  DOXYGEN_ONLY
};
 
class GPIO_SPI : public GPIO_base
{
public:
    GPIO_SPI( uint8_t device_address, int nbits, const uint8_t* arp, uint8_t ai );

    virtual ~GPIO_SPI();
    
    virtual int reg_w( uint8_t reg_adr, const uint8_t *data, uint16_t size );

    virtual int reg_w( uint8_t reg_adr, uint8_t data );

    virtual int reg_r( uint8_t reg_adr, uint8_t *data, uint16_t size );

    virtual uint8_t reg_r( uint8_t reg_adr );
};

class PCAL97xx_base : public GPIO_SPI
{
public:
    PCAL97xx_base( uint8_t dev_address, const int nbits, const uint8_t arp[], uint8_t ai );
    virtual ~PCAL97xx_base();
};

class PCAL9722 : public PCAL97xx_base
{
public:
    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, 
    };
    
    PCAL9722( uint8_t dev_address = (0x40 >> 1) + 0 );

    virtual ~PCAL9722();

    void    begin( board env = NONE );
    
    static constexpr uint8_t    access_ref[ NUM_access_word ]   = {
        Input_Port_0,                                   //  IN,
        Output_Port_0,                                  //  OUT
        Polarity_Inversion_port_0,                      //  POLARITY
        Configuration_port_0,                           //  CONFIG
        Output_drive_strength_register_port_0A,         //  DRIVE_STRENGTH
        Input_latch_register_port_0,                    //  LATCH
        Pull_up_pull_down_enable_register_port_0,       //  PULL_UD_EN
        Pull_up_pull_down_selection_register_port_0,    //  PULL_UD_SEL
        Interrupt_mask_register_port_0,                 //  INT_MASK
        Interrupt_status_register_port_0,               //  INT_STATUS
        Output_port_configuration_register,             //  OUTPUT_PORT_CONFIG
    };
 
private:
    static constexpr int RESET_PIN_PCAL9722 = 6;
 
public: 
#if DOXYGEN_ONLY
    enum board {
        NONE,
        ARDUINO_SHIELD,
    };

    const int   n_bits;

    const int   n_ports;

    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 );

    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 );
#endif  //  DOXYGEN_ONLY
};
 
 
#endif //   ARDUINO_GPIO_NXP_ARD_H