hal/nrf24l01p/hal_nrf.h

Go to the documentation of this file.

/* Copyright (c) 2009 Nordic Semiconductor. All Rights Reserved.
 *
 * The information contained herein is confidential property of Nordic
 * Semiconductor ASA.Terms and conditions of usage are described in detail
 * in NORDIC SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
 *
 * Licensees are granted free, non-transferable use of the information. NO
 * WARRENTY of ANY KIND is provided. This heading must NOT be removed from
 * the file.
 *
 * $LastChangedRevision: 2513 $
 */

#ifndef HAL_NRF_H__
#define HAL_NRF_H__

#include <stdint.h>
#include <stdbool.h>

#include "hal_nrf_reg.h"
#include "hal_nrf_hw.h"

/* Setup function prototypes */

void hal_nrf_set_irq_mode(hal_nrf_irq_source_t int_source, bool irq_state);

/* For the obsolete nRF24L01 it is necessary to issue an activate command before the
 * features enabled by the FEATURE register can be used. For nRF24L01+ these features
 * are by default enabled.
*/
void hal_nrf_activate_features(void);

void hal_nrf_enable_dynamic_payload(bool enable);

void hal_nrf_enable_ack_payload(bool enable);

void hal_nrf_enable_dynamic_ack(bool enable);

void hal_nrf_setup_dynamic_payload(uint8_t setup);

uint8_t hal_nrf_read_rx_payload_width(void);

void hal_nrf_write_ack_payload(uint8_t pipe, const uint8_t *tx_pload, uint8_t length);

uint8_t hal_nrf_get_clear_irq_flags(void);

uint8_t hal_nrf_clear_irq_flags_get_status(void);

void hal_nrf_clear_irq_flag(hal_nrf_irq_source_t int_source);

void hal_nrf_set_crc_mode(hal_nrf_crc_mode_t crc_mode);

void hal_nrf_open_pipe(hal_nrf_address_t pipe_num, bool auto_ack);

void hal_nrf_close_pipe(hal_nrf_address_t pipe_num);

void hal_nrf_set_address(const hal_nrf_address_t address, const uint8_t *addr);

uint8_t hal_nrf_get_address (uint8_t address, uint8_t *addr);

void hal_nrf_set_auto_retr(uint8_t retr, uint16_t delay);

void hal_nrf_set_address_width(hal_nrf_address_width_t address_width);

uint8_t hal_nrf_get_address_width (void);

void hal_nrf_set_rx_payload_width(uint8_t pipe_num, uint8_t pload_width);

bool hal_nrf_get_irq_mode(uint8_t int_source);

uint8_t hal_nrf_get_irq_flags(void);

uint8_t hal_nrf_get_pipe_status(uint8_t pipe_num);

uint8_t hal_nrf_get_auto_retr_status(void);

uint8_t hal_nrf_get_packet_lost_ctr(void);

uint8_t hal_nrf_get_rx_payload_width(uint8_t pipe_num);

/* Operation function prototypes */

void hal_nrf_set_operation_mode(hal_nrf_operation_mode_t op_mode);

void hal_nrf_set_power_mode(hal_nrf_pwr_mode_t pwr_mode);

void hal_nrf_set_rf_channel(uint8_t channel);

void hal_nrf_set_output_power(hal_nrf_output_power_t power);

void hal_nrf_set_datarate(hal_nrf_datarate_t datarate);


/* Status functions prototypes */

uint8_t hal_nrf_get_tx_fifo_status(void);

bool hal_nrf_tx_fifo_empty(void);

bool hal_nrf_tx_fifo_full(void);

uint8_t hal_nrf_get_rx_fifo_status(void);

uint8_t hal_nrf_get_fifo_status(void);

bool hal_nrf_rx_fifo_empty(void);

bool hal_nrf_rx_fifo_full(void);

uint8_t hal_nrf_get_transmit_attempts(void);

bool hal_nrf_get_carrier_detect(void);

/* Data operation prototypes */

uint8_t hal_nrf_get_rx_data_source(void);

uint16_t hal_nrf_read_rx_payload(uint8_t *rx_pload);

void hal_nrf_write_tx_payload(const uint8_t *tx_pload, uint8_t length);

void hal_nrf_write_tx_payload_noack(const uint8_t *tx_pload, uint8_t length);

void hal_nrf_reuse_tx(void);

bool hal_nrf_get_reuse_tx_status(void);

void hal_nrf_flush_rx(void);

void hal_nrf_flush_tx(void);

uint8_t hal_nrf_nop(void);

/* Test functions prototypes */

void hal_nrf_set_pll_mode(bool pll_lock);

void hal_nrf_set_lna_gain(bool lna_gain);

void hal_nrf_enable_continious_wave (bool enable);

/* hal_nrf_l01 basic functions, used by all the other functions */



uint8_t hal_nrf_rw(uint8_t value);
#endif // HAL_NRF_H__