drivers/staging/pi433/rf69.h

   1 /*
   2  * hardware abstraction/register access for HopeRf rf69 radio module
   3  *
   4  * Copyright (C) 2016 Wolf-Entwicklungen
   5  *      Marcus Wolf <linux@wolf-entwicklungen.de>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  */
  17 #ifndef RF69_H
  18 #define RF69_H
  19
  20 #include "rf69_enum.h"
  21 #include "rf69_registers.h"
  22
  23 #define F_OSC           32000000  /* in Hz */
  24 #define FREQUENCY       433920000 /* in Hz, modifying this value impacts CE certification */
  25 #define FIFO_SIZE       66              /* in byte */
  26 #define FIFO_THRESHOLD  15              /* in byte */
  27
  28 int rf69_set_mode(struct spi_device *spi, enum mode mode);
  29 int rf69_set_data_mode(struct spi_device *spi, enum dataMode dataMode);
  30 int rf69_set_modulation(struct spi_device *spi, enum modulation modulation);
  31 enum modulation rf69_get_modulation(struct spi_device *spi);
  32 int rf69_set_modulation_shaping(struct spi_device *spi, enum modShaping modShaping);
  33 int rf69_set_bit_rate(struct spi_device *spi, u16 bitRate);
  34 int rf69_set_deviation(struct spi_device *spi, u32 deviation);
  35 int rf69_set_frequency(struct spi_device *spi, u32 frequency);
  36 int rf69_set_amplifier_0(struct spi_device *spi, enum optionOnOff optionOnOff);
  37 int rf69_set_amplifier_1(struct spi_device *spi, enum optionOnOff optionOnOff);
  38 int rf69_set_amplifier_2(struct spi_device *spi, enum optionOnOff optionOnOff);
  39 int rf69_set_output_power_level(struct spi_device *spi, u8 powerLevel);
  40 int rf69_set_pa_ramp(struct spi_device *spi, enum paRamp paRamp);
  41 int rf69_set_antenna_impedance(struct spi_device *spi, enum antennaImpedance antennaImpedance);
  42 int rf69_set_lna_gain(struct spi_device *spi, enum lnaGain lnaGain);
  43 enum lnaGain rf69_get_lna_gain(struct spi_device *spi);
  44 int rf69_set_dc_cut_off_frequency_intern(struct spi_device *spi, u8 reg, enum dccPercent dccPercent);
  45 int rf69_set_dc_cut_off_frequency(struct spi_device *spi, enum dccPercent dccPercent);
  46 int rf69_set_dc_cut_off_frequency_during_afc(struct spi_device *spi, enum dccPercent dccPercent);
  47 int rf69_set_bandwidth(struct spi_device *spi, enum mantisse mantisse, u8 exponent);
  48 int rf69_set_bandwidth_during_afc(struct spi_device *spi, enum mantisse mantisse, u8 exponent);
  49 int rf69_set_ook_threshold_type(struct spi_device *spi, enum thresholdType thresholdType);
  50 int rf69_set_ook_threshold_step(struct spi_device *spi, enum thresholdStep thresholdStep);
  51 int rf69_set_ook_threshold_dec(struct spi_device *spi, enum thresholdDecrement thresholdDecrement);
  52 int rf69_set_dio_mapping(struct spi_device *spi, u8 DIONumber, u8 value);
  53 bool rf69_get_flag(struct spi_device *spi, enum flag flag);
  54 int rf69_reset_flag(struct spi_device *spi, enum flag flag);
  55 int rf69_set_rssi_threshold(struct spi_device *spi, u8 threshold);
  56 int rf69_set_rx_start_timeout(struct spi_device *spi, u8 timeout);
  57 int rf69_set_rssi_timeout(struct spi_device *spi, u8 timeout);
  58 int rf69_set_preamble_length(struct spi_device *spi, u16 preambleLength);
  59 int rf69_set_sync_enable(struct spi_device *spi, enum optionOnOff optionOnOff);
  60 int rf69_set_fifo_fill_condition(struct spi_device *spi, enum fifoFillCondition fifoFillCondition);
  61 int rf69_set_sync_size(struct spi_device *spi, u8 sync_size);
  62 int rf69_set_sync_tolerance(struct spi_device *spi, u8 syncTolerance);
  63 int rf69_set_sync_values(struct spi_device *spi, u8 syncValues[8]);
  64 int rf69_set_packet_format(struct spi_device *spi, enum packetFormat packetFormat);
  65 int rf69_set_crc_enable(struct spi_device *spi, enum optionOnOff optionOnOff);
  66 int rf69_set_adressFiltering(struct spi_device *spi, enum addressFiltering addressFiltering);
  67 int rf69_set_payload_length(struct spi_device *spi, u8 payloadLength);
  68 u8  rf69_get_payload_length(struct spi_device *spi);
  69 int rf69_set_node_address(struct spi_device *spi, u8 nodeAddress);
  70 int rf69_set_broadcast_address(struct spi_device *spi, u8 broadcastAddress);
  71 int rf69_set_tx_start_condition(struct spi_device *spi, enum txStartCondition txStartCondition);
  72 int rf69_set_fifo_threshold(struct spi_device *spi, u8 threshold);
  73 int rf69_set_dagc(struct spi_device *spi, enum dagc dagc);
  74
  75 int rf69_read_fifo (struct spi_device *spi, u8 *buffer, unsigned int size);
  76 int rf69_write_fifo(struct spi_device *spi, u8 *buffer, unsigned int size);
  77
  78 u8  rf69_read_reg (struct spi_device *spi, u8 addr);
  79 int rf69_write_reg(struct spi_device *spi, u8 addr, u8 value);
  80
  81
  82 #endif