drv_sx1509.h

/*
  Copyright (c) 2010 - 2017, Nordic Semiconductor ASA
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.

  2. Redistributions in binary form, except as embedded into a Nordic
     Semiconductor ASA integrated circuit in a product or a software update for
     such product, must reproduce the above copyright notice, this list of
     conditions and the following disclaimer in the documentation and/or other
     materials provided with the distribution.

  3. Neither the name of Nordic Semiconductor ASA nor the names of its
     contributors may be used to endorse or promote products derived from this
     software without specific prior written permission.

  4. This software, with or without modification, must only be used with a
     Nordic Semiconductor ASA integrated circuit.

  5. Any software provided in binary form under this license must not be reverse
     engineered, decompiled, modified and/or disassembled.

  THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DRV_SX1509_H__
#define DRV_SX1509_H__

#include "drv_sx1509_bitfields.h"
#include "nrf_drv_twi.h"

#include <stdint.h>


enum
{
    DRV_SX1509_STATUS_CODE_SUCCESS,      
    DRV_SX1509_STATUS_CODE_DISALLOWED,   
    DRV_SX1509_STATUS_CODE_INVALID_PARAM,
    DRV_SX1509_STATUS_CODE_NOT_SUPPORTED 
};


typedef struct
{
    uint8_t                      twi_addr;
    nrf_drv_twi_t        const * p_twi_instance;  
    nrf_drv_twi_config_t const * p_twi_cfg;       
} drv_sx1509_cfg_t;

void drv_sx1509_init(void);

uint32_t drv_sx1509_reg_get(uint8_t reg_addr, uint8_t * p_value);


uint32_t drv_sx1509_open(drv_sx1509_cfg_t const * const p_drv_sx1509_cfg);


uint32_t drv_sx1509_inpbufdisable_get(uint16_t * p_inputdisable);


uint32_t drv_sx1509_inpbufdisable_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_longslewrate_get(uint16_t * p_longslewrate);


uint32_t drv_sx1509_longslewrate_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_lowdrive_get(uint16_t * p_lowdrive);


uint32_t drv_sx1509_lowdrive_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_pullup_get(uint16_t * p_pullup);


uint32_t drv_sx1509_pullup_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_pulldown_get(uint16_t * p_pulldown);


uint32_t drv_sx1509_pulldown_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_opendrain_get(uint16_t * p_opendrain);


uint32_t drv_sx1509_opendrain_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_polarity_get(uint16_t * p_polarity);


uint32_t drv_sx1509_polarity_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_dir_get(uint16_t * p_dir);


uint32_t drv_sx1509_dir_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_data_get(uint16_t * p_data);


uint32_t drv_sx1509_data_set(uint16_t data);

uint32_t drv_sx1509_data_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_interruptmask_get(uint16_t * p_interruptmask);


uint32_t drv_sx1509_interruptmask_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_sense_get(uint32_t * p_sense);


uint32_t drv_sx1509_sense_modify(uint32_t set_mask, uint32_t clr_mask);


uint32_t drv_sx1509_interruptsource_get(uint16_t * p_interruptsource);


uint32_t drv_sx1509_interruptsource_clr(uint16_t clr_mask);


uint32_t drv_sx1509_eventstatus_get(uint16_t * p_eventstatus);


uint32_t drv_sx1509_eventstatus_clr(uint16_t clr_mask);


uint32_t drv_sx1509_levelshifter_get(uint16_t * p_levelshifter);


uint32_t drv_sx1509_levelshifter_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_clock_get(uint8_t * p_clock);


uint32_t drv_sx1509_clock_modify(uint8_t set_mask, uint8_t clr_mask);


uint32_t drv_sx1509_misc_get(uint8_t * p_misc);


uint32_t drv_sx1509_misc_modify(uint8_t set_mask, uint8_t clr_mask);


uint32_t drv_sx1509_leddriverenable_get(uint16_t * p_leddriverenable);


uint32_t drv_sx1509_leddriverenable_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_debounceconfig_get(uint8_t * p_debounceconfig);


uint32_t drv_sx1509_debounceconfig_modify(uint8_t set_mask, uint8_t clr_mask);


uint32_t drv_sx1509_debounceenable_get(uint16_t * p_debounceenable);


uint32_t drv_sx1509_debounceenable_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_keyconfig_get(uint16_t * p_keyconfig);


uint32_t drv_sx1509_keyconfig_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_keydata_get(uint16_t * p_keydata);


uint32_t drv_sx1509_onoffcfgx_get(uint8_t pin_no, uint32_t * p_onoffcfgx);


uint32_t drv_sx1509_onoffcfgx_modify(uint8_t pin_no, uint32_t set_mask, uint32_t clr_mask);


uint32_t drv_sx1509_risefallcfgx_get(uint8_t pin_no,uint16_t * p_risefallcfgx);


uint32_t drv_sx1509_risefallcfgx_modify(uint8_t pin_no, uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_highinpmode_get(uint16_t * p_highinpmode);


uint32_t drv_sx1509_highinpmode_modify(uint16_t set_mask, uint16_t clr_mask);


uint32_t drv_sx1509_reset(void);


uint32_t drv_sx1509_close(void);

#endif // DRV_SX1509_H__