rfm70.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 _RFM70_H_
#define _RFM70_H_

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

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


//
#define RFM70_LIB_VERSION "V1.02 (2011-12-31)"

//
#define RFM70_MAX_PACKET_LEN  32

//
typedef unsigned char rfm70_buffer [ RFM70_MAX_PACKET_LEN ];


//***************************************************************************//
//
// RFM70 SPI commands
//
//***************************************************************************//


#define RFM70_CMD_R_RX_PAYLOAD         0x61

#define RFM70_CMD_W_TX_PAYLOAD         0xA0

#define RFM70_CMD_FLUSH_TX             0xE1

#define RFM70_CMD_FLUSH_RX             0xE2

#define RFM70_CMD_REUSE_TX_PL          0xE3

#define RFM70_CMD_W_TX_PAYLOAD_NOACK   0xB0

#define RFM70_CMD_W_ACK_PAYLOAD        0xA8

#define RFM70_CMD_ACTIVATE             0x50

#define RFM70_CMD_R_RX_PL_WID          0x60

#define RFM70_CMD_NOP                  0xFF

//***************************************************************************//
//
// RFM70 register addresses
//
//***************************************************************************//

//
#define RFM70_REG_CONFIG               0x00

//
#define RFM70_REG_EN_AA                0x01

//
#define RFM70_REG_EN_RXADDR            0x02

//
#define RFM70_REG_SETUP_AW             0x03

//
#define RFM70_REG_SETUP_RETR           0x04

//
#define RFM70_REG_RF_CH                0x05

//
#define RFM70_REG_RF_SETUP             0x06

//
#define RFM70_REG_STATUS               0x07

//
#define RFM70_REG_OBSERVE_TX           0x08

//
#define RFM70_REG_CD                   0x09

//
#define RFM70_REG_RX_ADDR_P0           0x0A

//
#define RFM70_REG_RX_ADDR_P1           0x0B

//
#define RFM70_REG_RX_ADDR_P2           0x0C

//
#define RFM70_REG_RX_ADDR_P3           0x0D

//
#define RFM70_REG_RX_ADDR_P4           0x0E

//
#define RFM70_REG_RX_ADDR_P5           0x0F

//
#define RFM70_REG_TX_ADDR              0x10

//
#define RFM70_REG_RX_PW_P0             0x11

//
#define RFM70_REG_RX_PW_P1             0x12

//
#define RFM70_REG_RX_PW_P2             0x13

//
#define RFM70_REG_RX_PW_P3             0x14

//
#define RFM70_REG_RX_PW_P4             0x15

//
#define RFM70_REG_RX_PW_P5             0x16

//
#define RFM70_REG_FIFO_STATUS          0x17

//
#define RFM70_REG_DYNPD                0x1C

//
#define RFM70_REG_FEATURE              0x1D




#include "pins.h"       


   
class rfm70 {

private:
   pins::output_pin &sclk;      
   pins::output_pin &mosi;      
   pins::input_pin  &miso;      
   pins::output_pin &csn;      
   pins::output_pin &ce;     
    
    void(*wait_ms)(unsigned int);
    void(*wait_us)(unsigned int);
   
   unsigned char SPI_RW( unsigned char value );    

public:
   //
   rfm70( 
      pins::output_pin &sclk,
      pins::output_pin &mosi,
      pins::input_pin  &miso,
      pins::output_pin &csn,
      pins::output_pin &ce
      
       ,void(*wait_ms)(unsigned int)
       ,void(*wait_us)(unsigned int)
      
   ):      
      sclk( sclk ),
      mosi( mosi ),
      miso( miso ),
      csn(  csn ),
      ce(   ce )
       ,wait_ms( wait_ms )
       ,wait_us( wait_us )
   {}     
   
private:   
   void bank( unsigned char b );
   void init_bank1();
   
public:   
   

//
void init( void );

//
unsigned char register_read( unsigned char reg );

//
void buffer_read(
   unsigned char reg,
   unsigned char *buf,
   unsigned char length
);

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

//
void buffer_write(
   char reg,
   const unsigned char *buf,
   unsigned char length
);

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

//
bool is_present( void );

//
void mode_transmit( void );

//
void mode_receive( void );

//
void mode_standby( void );

//
void mode_powerdown( void );

//
void lna_low( void );

//
void lna_high( void );

//
void channel( unsigned char ch );

//
void air_data_rate( unsigned char rate );

//
void crc_length( unsigned char len );

//
void address_length( unsigned char len );

//
void power( unsigned char level ); 

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

//
unsigned char retransmit_count( void );

//
unsigned char lost_packets_count( void );

//
void lost_packets_reset( void );

//
void pipe_autoack( unsigned char pipe, bool enabled );

//
void pipe_enable( unsigned char d, bool enabled );

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

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

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

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

//
void transmit_address( const unsigned char *address );   

//
bool transmit_fifo_full( void );

//
bool receive_fifo_empty( void );

//
void transmit_message(
   const unsigned char *buf,
   unsigned char length
);

//
void transmit_message_once(
   const unsigned char *buf,
   unsigned char length
);

//
unsigned char receive_next_pipe( void );

//
unsigned char receive_next_length( void );

//
bool receive(
   unsigned char & pipe,
   unsigned char *buf,
   unsigned char & length
);


}; // class frm70


#endif