hal_aci_tl.h

Go to the documentation of this file.

/* Copyright (c) 2014, Nordic Semiconductor ASA
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef HAL_ACI_TL_H__
#define HAL_ACI_TL_H__

#include "hal_platform.h"
#include "aci.h"
#include "boards.h"

#include <mraa/aio.h>
#include <mraa/gpio.h>
#include <mraa/spi.h>

#ifndef HAL_ACI_MAX_LENGTH
#define HAL_ACI_MAX_LENGTH 31
#endif

/************************************************************************/
/* Unused nRF8001 pin                                                    */
/************************************************************************/
#define UNUSED          255

typedef struct {
  uint8_t status_byte;
  uint8_t buffer[HAL_ACI_MAX_LENGTH+1];
} _aci_packed_ hal_aci_data_t;

ACI_ASSERT_SIZE(hal_aci_data_t, HAL_ACI_MAX_LENGTH + 2);

typedef struct aci_pins_t
{
    mraa_spi_context        m_spi;
    mraa_gpio_context       m_rdy_ctx;
    mraa_gpio_context       m_req_ctx;
    mraa_gpio_context       m_rst_ctx;

    uint8_t board_name;             //Optional : Use BOARD_DEFAULT if you do not know. See boards.h
    uint8_t reqn_pin;               //Required
    uint8_t rdyn_pin;               //Required
    uint8_t mosi_pin;               //Required
    uint8_t miso_pin;               //Required
    uint8_t sck_pin;                //Required

    uint8_t spi_clock_divider;      //Required : Clock divider on the SPI clock : nRF8001 supports a maximum clock of 3MHz

    uint8_t reset_pin;              //Recommended but optional - Set it to UNUSED when not connected
    uint8_t active_pin;             //Optional - Set it to UNUSED when not connected
    uint8_t optional_chip_sel_pin;  //Optional - Used only when the reqn line is required to be separate from the SPI chip select. Eg. Arduino DUE

    bool    interface_is_interrupt; //Required - true = Uses interrupt on RDYN pin. false - Uses polling on RDYN pin

    uint8_t interrupt_number;       //Required when using interrupts, otherwise ignored
} aci_pins_t;

void hal_aci_tl_init(aci_pins_t *a_pins, bool debug);

bool hal_aci_tl_send(hal_aci_data_t *aci_buffer);

hal_aci_data_t * hal_aci_tl_poll_get(void);

bool hal_aci_tl_event_get(hal_aci_data_t *p_aci_data);

bool hal_aci_tl_event_peek(hal_aci_data_t *p_aci_data);

void hal_aci_tl_debug_print(bool enable);


void hal_aci_tl_pin_reset(void);

 bool hal_aci_tl_rx_q_full(void);

 bool hal_aci_tl_rx_q_empty(void);

 bool hal_aci_tl_tx_q_full(void);

 bool hal_aci_tl_tx_q_empty(void);

void hal_aci_tl_q_flush(void);

#endif // HAL_ACI_TL_H__