rfm73.h

//***************************************************************************//
//
// COPYRIGHT NOTICE (zlib license)
//
// Loosely based on the example application provided by HopeRF
//
// (c) Wouter van Ooijen - wouter@voti.nl
//
//  This software is provided 'as-is', without any express or implied
//  warranty.  In no event will the authors be held liable for any damages
//  arising from the use of this software.
//
//  Permission is granted to anyone to use this software for any purpose,
//  including commercial applications, and to alter it and redistribute it
//  freely, subject to the following restrictions:
//
//  1. The origin of this software must not be misrepresented; you must not
//     claim that you wrote the original software. If you use this software
//     in a product, an acknowledgment in the product documentation would be
//     appreciated but is not required.
//  2. Altered source versions must be plainly marked as such, and must not be
//     misrepresented as being the original software.
//  3. This notice may not be removed or altered from any source distribution.
//
//***************************************************************************//

#ifndef _RFM73_H_
#define _RFM73_H_

//***************************************************************************//
//
//
//***************************************************************************//

//***************************************************************************//
//
//
//***************************************************************************//


//
#define RFM73_LIB_VERSION "V1.04 (2013-06-14)"

//
#define RFM73_MAX_PACKET_LEN  32

//
typedef unsigned char rfm73_buffer [ RFM73_MAX_PACKET_LEN ];


//***************************************************************************//
//
// RFM73 SPI commands
//
//***************************************************************************//


#define RFM73_CMD_R_RX_PAYLOAD         0x61

#define RFM73_CMD_W_TX_PAYLOAD         0xA0

#define RFM73_CMD_FLUSH_TX             0xE1

#define RFM73_CMD_FLUSH_RX             0xE2

#define RFM73_CMD_REUSE_TX_PL          0xE3

#define RFM73_CMD_W_TX_PAYLOAD_NOACK   0xB0

#define RFM73_CMD_W_ACK_PAYLOAD        0xA8

#define RFM73_CMD_ACTIVATE             0x50

#define RFM73_CMD_R_RX_PL_WID          0x60

#define RFM73_CMD_NOP                  0xFF

//***************************************************************************//
//
// RFM73 register addresses
//
//***************************************************************************//

//
#define RFM73_REG_CONFIG               0x00

//
#define RFM73_REG_EN_AA                0x01

//
#define RFM73_REG_EN_RXADDR            0x02

//
#define RFM73_REG_SETUP_AW             0x03

//
#define RFM73_REG_SETUP_RETR           0x04

//
#define RFM73_REG_RF_CH                0x05

//
#define RFM73_REG_RF_SETUP             0x06

//
#define RFM73_REG_STATUS               0x07

//
#define RFM73_REG_OBSERVE_TX           0x08

//
#define RFM73_REG_CD                   0x09

//
#define RFM73_REG_RX_ADDR_P0           0x0A

//
#define RFM73_REG_RX_ADDR_P1           0x0B

//
#define RFM73_REG_RX_ADDR_P2           0x0C

//
#define RFM73_REG_RX_ADDR_P3           0x0D

//
#define RFM73_REG_RX_ADDR_P4           0x0E

//
#define RFM73_REG_RX_ADDR_P5           0x0F

//
#define RFM73_REG_TX_ADDR              0x10

//
#define RFM73_REG_RX_PW_P0             0x11

//
#define RFM73_REG_RX_PW_P1             0x12

//
#define RFM73_REG_RX_PW_P2             0x13

//
#define RFM73_REG_RX_PW_P3             0x14

//
#define RFM73_REG_RX_PW_P4             0x15

//
#define RFM73_REG_RX_PW_P5             0x16

//
#define RFM73_REG_FIFO_STATUS          0x17

//
#define RFM73_REG_DYNPD                0x1C

//
#define RFM73_REG_FEATURE              0x1D





//
void rfm73_init( void );

//
unsigned char rfm73_register_read( unsigned char reg );

//
void rfm73_buffer_read(
   unsigned char reg,
   unsigned char buf[],
   unsigned char length
);

//
void rfm73_register_write( unsigned char reg, unsigned char val );

//
void rfm73_buffer_write(
   char reg,
   const unsigned char buf[],
   unsigned char length
);

//***************************************************************************//
//
// high-level interface
//
//***************************************************************************//

//
unsigned char rfm73_is_present( void );

//
void rfm73_mode_transmit( void );

//
void rfm73_mode_receive( void );

//
void rfm73_mode_standby( void );

//
void rfm73_mode_powerdown( void );

//
void rfm73_lna_low( void );

//
void rfm73_lna_high( void );

//
void rfm73_channel( unsigned char ch );

//
void rfm73_air_data_rate( unsigned char rate );

//
void rfm73_crc_length( unsigned char len );

//
void rfm73_address_length( unsigned char len );

//
void rfm73_power( unsigned char level ); 

//
void rfm73_retransmit_delay_attempts( unsigned char d, unsigned char n );

//
unsigned char rfm73_retransmit_count( void );

//
unsigned char rfm73_lost_packets_count( void );

//
void rfm73_lost_packets_reset( void );

//
void rfm73_pipe_autoack( unsigned char pipe, unsigned char enabled );

//
void rfm73_pipe_enable( unsigned char d, unsigned char enabled );

//
void rfm73_receive_address_p0( const unsigned char address[ 5 ] );

//
void rfm73_receive_address_p1( const unsigned char address[ 5 ] );

//
void rfm73_receive_address_pn( unsigned char channel, unsigned char address );

//
void rfm73_channel_payload_size( unsigned char n, unsigned char size );

//
void rfm73_transmit_address( const unsigned char address[] );   

//
unsigned char rfm73_transmit_fifo_full( void );

//
unsigned char rfm73_receive_fifo_empty( void );

//
void rfm73_transmit_message(
   const unsigned char buf[],
   unsigned char length
);

//
void rfm73_transmit_message_once(
   const unsigned char buf[],
   unsigned char length
);

//
unsigned char rfm73_receive_next_pipe( void );

//
unsigned char rfm73_receive_next_length( void );

//
unsigned char rfm73_receive(
   unsigned char * pipe,
   unsigned char buf[],
   unsigned char * length
);


#endif