drv_ext_gpio.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_EXT_GPIO_H__
#define __DRV_EXT_GPIO_H__

#include <stdint.h>
#include "nrf_error.h"
#include "drv_sx1509.h"

enum
{
    DRV_EXT_GPIO_STATUS_CODE_SUCCESS = NRF_SUCCESS,  
    DRV_EXT_GPIO_STATUS_CODE_INVALID_PARAM,          
    DRV_EXT_GPIO_STATUS_CODE_INVALID_PIN             
};

#define DRV_EXT_GPIO_PIN_HIGHEST_ID DRV_SX1509_DATA_PIN15_Pos           
#define DRV_EXT_GPIO_NUM_PINS_TOTAL (DRV_EXT_GPIO_PIN_HIGHEST_ID + 1)   


typedef enum
{
    DRV_EXT_GPIO_PIN_DIR_OUTPUT,    
    DRV_EXT_GPIO_PIN_DIR_INPUT      
} drv_ext_gpio_pin_dir_t;

typedef enum
{
    DRV_EXT_GPIO_PIN_INPUT_BUF_ENABLED,   
    DRV_EXT_GPIO_PIN_INPUT_BUF_DISABLED   
} drv_ext_gpio_pin_input_buf_t;

typedef enum
{
    DRV_EXT_GPIO_PIN_NOPULL,    
    DRV_EXT_GPIO_PIN_PULLDOWN,  
    DRV_EXT_GPIO_PIN_PULLUP     
} drv_ext_gpio_pin_pull_t;

typedef enum
{
    DRV_EXT_GPIO_PIN_DRIVE_PUSHPULL,    
    DRV_EXT_GPIO_PIN_DRIVE_OPENDRAIN    
}drv_ext_gpio_pin_drive_type_t;

typedef enum
{
    DRV_EXT_GPIO_PIN_INCREASED_SLEWRATE_DISABLED, 
    DRV_EXT_GPIO_PIN_INCREASED_SLEWRATE_ENABLED   
}drv_ext_gpio_pin_slew_rate_t;

uint32_t drv_ext_gpio_cfg(
    uint32_t                      pin_number,
    drv_ext_gpio_pin_dir_t        dir,
    drv_ext_gpio_pin_input_buf_t  input_buf,
    drv_ext_gpio_pin_pull_t       pull_config,
    drv_ext_gpio_pin_drive_type_t drive_type,
    drv_ext_gpio_pin_slew_rate_t  slew_rate);

typedef struct
{
    drv_sx1509_cfg_t const * p_cfg;
} drv_ext_gpio_init_t;

uint32_t drv_ext_gpio_reset(void);

uint32_t drv_ext_gpio_cfg_output(uint32_t pin_number);

uint32_t drv_ext_gpio_cfg_input(uint32_t pin_number, drv_ext_gpio_pin_pull_t pull_config);

uint32_t drv_ext_gpio_pin_dir_modify(uint32_t pin_number, drv_ext_gpio_pin_dir_t direction);

uint32_t drv_ext_gpio_pin_slew_rate_modify(uint32_t pin_number, drv_ext_gpio_pin_slew_rate_t slew_rate);

uint32_t drv_ext_gpio_pin_drive_type_modify(uint32_t pin_number, drv_ext_gpio_pin_drive_type_t drive_type);

uint32_t drv_ext_gpio_pin_input_buffer_modify(uint32_t pin_number, drv_ext_gpio_pin_input_buf_t input_buf);

uint32_t drv_ext_gpio_pin_set(uint32_t pin_number);

uint32_t drv_ext_gpio_pins_set(uint32_t pin_mask);

uint32_t drv_ext_gpio_pin_clear(uint32_t pin_number);

uint32_t drv_ext_gpio_pins_clear(uint32_t pin_mask);

uint32_t drv_ext_gpio_pin_toggle(uint32_t pin_number);

uint32_t drv_ext_gpio_pins_toggle(uint32_t pin_mask);

uint32_t drv_ext_gpio_pin_write(uint32_t pin_number, uint32_t value);

uint32_t drv_ext_gpio_pin_read(uint32_t pin_number, uint32_t * const p_pin);

uint32_t drv_ext_gpio_pins_read(uint32_t * const p_pins);

uint32_t drv_ext_gpio_init(drv_ext_gpio_init_t const * const p_init, bool on_init_reset);

#endif