nz_mcp23017.h

Go to the documentation of this file.

 /*********************************************************************
 * @section nz_mcp23017_lic Software License Agreement
 *
 * The software supplied herewith is owned by Modtronix Engineering, and is
 * protected under applicable copyright laws. The software supplied herewith is
 * intended and supplied to you, the Company customer, for use solely and
 * exclusively on products manufactured by Modtronix Engineering. The code may
 * be modified and can be used free of charge for commercial and non commercial
 * applications. All rights are reserved. Any use in violation of the foregoing
 * restrictions may subject the user to criminal sanctions under applicable laws,
 * as well as to civil liability for the breach of the terms and conditions of this license.
 *
 * THIS SOFTWARE IS PROVIDED IN AN 'AS IS' CONDITION. NO WARRANTIES, WHETHER EXPRESS,
 * IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE
 * COMPANY SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 **********************************************************************
 * File History
 *
 * 2011-06-03, David Hosken (DH):
 *    - Initial version
 *********************************************************************/
#ifndef _MCP23017_H_
#define _MCP23017_H_

#define MCP23017_REG_IODIRA      0x00
#define MCP23017_REG_IODIRB      0x01
#define MCP23017_REG_IPOLA       0x02   
#define MCP23017_REG_IPOLB       0x03
#define MCP23017_REG_GPINTENA    0x04
#define MCP23017_REG_GPINTENB    0x05
#define MCP23017_REG_DEFVALA     0x06 
#define MCP23017_REG_DEFVALB     0x07 
#define MCP23017_REG_INTCONA     0x08 
#define MCP23017_REG_INTCONB     0x09 
#define MCP23017_REG_IOCON       0x0A
#define MCP23017_REG_GPPUA       0x0C   
#define MCP23017_REG_GPPUB       0x0D   
#define MCP23017_REG_INTFA       0x0E   
#define MCP23017_REG_INTFB       0x0F   
#define MCP23017_REG_INTCAPA     0x10 
#define MCP23017_REG_INTCAPB     0x11 
#define MCP23017_REG_GPIOA       0x12   
#define MCP23017_REG_GPIOB       0x13   
#define MCP23017_REG_OLATA       0x14   
#define MCP23017_REG_OLATB       0x15   

/* Not used
#define MCP23017_REG_IODIRA_B1      0x00
#define MCP23017_REG_IODIRB_B1      0x10
#define MCP23017_REG_IPOLA_B1       0x01
#define MCP23017_REG_IPOLB_B1       0x11
#define MCP23017_REG_GPINTENA_B1    0x02
#define MCP23017_REG_GPINTENB_B1    0x12
#define MCP23017_REG_DEFVALA_B1     0x03
#define MCP23017_REG_DEFVALB_B1     0x13
#define MCP23017_REG_INTCONA_B1     0x04
#define MCP23017_REG_INTCONB_B1     0x14
#define MCP23017_REG_IOCON_B1       0x05
#define MCP23017_REG_GPPUA_B1       0x06
#define MCP23017_REG_GPPUB_B1       0x16
#define MCP23017_REG_INTFA_B1       0x07
#define MCP23017_REG_INTFB_B1       0x17
#define MCP23017_REG_INTCAPA_B1     0x08
#define MCP23017_REG_INTCAPB_B1     0x18
#define MCP23017_REG_GPIOA_B1       0x09
#define MCP23017_REG_GPIOB_B1       0x19
#define MCP23017_REG_OLATA_B1       0x0A
#define MCP23017_REG_OLATB_B1       0x1A
*/

#define MCP23017_ADDRESS            0x40    /*Base address if A0 to A3 are all 0 */

//Bit address of port pins. A value from 0 - 15 are allocated for port pins GPA0-GPA7 and GPB0-GPB7
#define MCP23017_GPA0               0
#define MCP23017_GPA1               1
#define MCP23017_GPA2               2
#define MCP23017_GPA3               3
#define MCP23017_GPA4               4
#define MCP23017_GPA5               5
#define MCP23017_GPA6               6
#define MCP23017_GPA7               7
#define MCP23017_GPB0               8
#define MCP23017_GPB1               9
#define MCP23017_GPB2               10
#define MCP23017_GPB3               11
#define MCP23017_GPB4               12
#define MCP23017_GPB5               13
#define MCP23017_GPB6               14
#define MCP23017_GPB7               15

#define MCP23017_SETPIN             0x80
#define MCP23017_CLEARPIN           0


typedef struct __attribute__((aligned(2), packed)) _MCP23017
{
    BYTE        adr;        //Slave I2C address.  Depending on state of A0 to A2 lines (bits 1,2 and 3), can be 0x40 to 0x4E
    BYTE        fill;       //Filler byte
    WORD_VAL    dir;        //Direction of 16 ports, 0=output, 1=input
    WORD_VAL    pullUp;     //Indicates if pull-ups are enabled for 16 ports
    WORD_VAL    latch;      //Current setting of output latch for 16 ports
    WORD_VAL    polarity;   //Input polarity for 16 ports
    WORD_VAL    pin;        //Current pin value for 16 ports
} MCP23017;


INT8 mcp23017_Init(MCP23017* obj);

INT8 mcp23017_ConfigDir(MCP23017* obj, UINT16 dir);


INT8 mcp23017_ConfigDirMask(MCP23017* obj, UINT16 dir, UINT16 mask);


INT8 mcp23017_ConfigPullups(MCP23017* obj, UINT16 pullUps);


INT8 mcp23017_ConfigIntPins(MCP23017* obj, UINT16 intPins);


INT8 mcp23017_WritePin(MCP23017* obj, UINT8 pinVal);


INT8 mcp23017_WriteMask(MCP23017* obj, UINT16 val, UINT16 mask);


#define mcp23017_WritePin(obj, pin) mcp23017_WritePin(obj, pin | 0x80)


#define mcp23017_ClearPin(obj, pin) mcp23017_WritePin(obj, pin & 0x7f)


INT8 mcp23017_ReadPins(MCP23017* obj);


#define mcp23017_ReadPins(obj) ((obj)->pin.Val)


//void mcp23017(UINT16 );

#endif