2 * abstraction of the spi interface of HopeRf rf69 radio module
4 * Copyright (C) 2016 Wolf-Entwicklungen
5 * Marcus Wolf <linux@wolf-entwicklungen.de>
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.
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.
18 /* enable prosa debug info */
20 /* enable print of values on reg access */
22 /* enable print of values on fifo access */
23 #undef DEBUG_FIFO_ACCESS
25 #include <linux/types.h>
26 #include <linux/spi/spi.h>
29 #include "rf69_registers.h"
31 #define F_OSC 32000000 /* in Hz */
32 #define FIFO_SIZE 66 /* in byte */
34 /*-------------------------------------------------------------------------*/
36 #define READ_REG(x) rf69_read_reg (spi, x)
37 #define WRITE_REG(x,y) rf69_write_reg(spi, x, y)
39 /*-------------------------------------------------------------------------*/
41 int rf69_set_mode(struct spi_device *spi, enum mode mode)
44 dev_dbg(&spi->dev, "set: mode");
48 case transmit: return WRITE_REG(REG_OPMODE, (READ_REG(REG_OPMODE) & ~MASK_OPMODE_MODE) | OPMODE_MODE_TRANSMIT);
49 case receive: return WRITE_REG(REG_OPMODE, (READ_REG(REG_OPMODE) & ~MASK_OPMODE_MODE) | OPMODE_MODE_RECEIVE);
50 case synthesizer: return WRITE_REG(REG_OPMODE, (READ_REG(REG_OPMODE) & ~MASK_OPMODE_MODE) | OPMODE_MODE_SYNTHESIZER);
51 case standby: return WRITE_REG(REG_OPMODE, (READ_REG(REG_OPMODE) & ~MASK_OPMODE_MODE) | OPMODE_MODE_STANDBY);
52 case mode_sleep: return WRITE_REG(REG_OPMODE, (READ_REG(REG_OPMODE) & ~MASK_OPMODE_MODE) | OPMODE_MODE_SLEEP);
54 dev_dbg(&spi->dev, "set: illegal input param");
58 // we are using packet mode, so this check is not really needed
59 // but waiting for mode ready is necessary when going from sleep because the FIFO may not be immediately available from previous mode
60 //while (_mode == RF69_MODE_SLEEP && (READ_REG(REG_IRQFLAGS1) & RF_IRQFLAGS1_MODEREADY) == 0x00); // Wait for ModeReady
64 int rf69_set_data_mode(struct spi_device *spi, enum dataMode dataMode)
67 dev_dbg(&spi->dev, "set: data mode");
71 case packet: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODE) | DATAMODUL_MODE_PACKET);
72 case continuous: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODE) | DATAMODUL_MODE_CONTINUOUS);
73 case continuousNoSync: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODE) | DATAMODUL_MODE_CONTINUOUS_NOSYNC);
75 dev_dbg(&spi->dev, "set: illegal input param");
80 int rf69_set_modulation(struct spi_device *spi, enum modulation modulation)
83 dev_dbg(&spi->dev, "set: modulation");
87 case OOK: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_TYPE) | DATAMODUL_MODULATION_TYPE_OOK);
88 case FSK: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_TYPE) | DATAMODUL_MODULATION_TYPE_FSK);
90 dev_dbg(&spi->dev, "set: illegal input param");
95 enum modulation rf69_get_modulation(struct spi_device *spi)
100 dev_dbg(&spi->dev, "get: mode");
103 currentValue = READ_REG(REG_DATAMODUL);
105 switch (currentValue & MASK_DATAMODUL_MODULATION_TYPE >> 3) { // TODO improvement: change 3 to define
106 case DATAMODUL_MODULATION_TYPE_OOK: return OOK;
107 case DATAMODUL_MODULATION_TYPE_FSK: return FSK;
108 default: return undefined;
112 int rf69_set_modulation_shaping(struct spi_device *spi, enum modShaping modShaping)
115 dev_dbg(&spi->dev, "set: mod shaping");
118 if (rf69_get_modulation(spi) == FSK) {
119 switch (modShaping) {
120 case shapingOff: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_SHAPE) | DATAMODUL_MODULATION_SHAPE_NONE);
121 case shaping1_0: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_SHAPE) | DATAMODUL_MODULATION_SHAPE_1_0);
122 case shaping0_5: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_SHAPE) | DATAMODUL_MODULATION_SHAPE_0_3);
123 case shaping0_3: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_SHAPE) | DATAMODUL_MODULATION_SHAPE_0_5);
125 dev_dbg(&spi->dev, "set: illegal input param");
129 switch (modShaping) {
130 case shapingOff: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_SHAPE) | DATAMODUL_MODULATION_SHAPE_NONE);
131 case shapingBR: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_SHAPE) | DATAMODUL_MODULATION_SHAPE_BR);
132 case shaping2BR: return WRITE_REG(REG_DATAMODUL, (READ_REG(REG_DATAMODUL) & ~MASK_DATAMODUL_MODULATION_SHAPE) | DATAMODUL_MODULATION_SHAPE_2BR);
134 dev_dbg(&spi->dev, "set: illegal input param");
140 int rf69_set_bit_rate(struct spi_device *spi, u16 bitRate)
149 dev_dbg(&spi->dev, "set: bit rate");
153 bitRate_min = F_OSC / 8388608; // 8388608 = 2^23;
154 if (bitRate < bitRate_min) {
155 dev_dbg(&spi->dev, "setBitRate: illegal input param");
159 // calculate reg settings
160 bitRate_reg = (F_OSC / bitRate);
162 msb = (bitRate_reg&0xff00) >> 8;
163 lsb = (bitRate_reg&0xff);
166 retval = WRITE_REG(REG_BITRATE_MSB, msb);
167 if (retval) return retval;
168 retval = WRITE_REG(REG_BITRATE_LSB, lsb);
169 if (retval) return retval;
174 int rf69_set_deviation(struct spi_device *spi, u32 deviation)
177 // u32 f_max; TODO: Abhängigkeit von Bitrate beachten!!
182 u64 factor = 1000000; // to improve precision of calculation
185 dev_dbg(&spi->dev, "set: deviation");
188 if (deviation < 600 || deviation > 500000) { //TODO: Abhängigkeit von Bitrate beachten!!
189 dev_dbg(&spi->dev, "set_deviation: illegal input param");
194 f_step = F_OSC * factor;
195 do_div(f_step, 524288); // 524288 = 2^19
197 // calculate register settings
198 f_reg = deviation * factor;
199 do_div(f_reg , f_step);
201 msb = (f_reg&0xff00) >> 8;
205 if (msb & ~FDEVMASB_MASK) {
206 dev_dbg(&spi->dev, "set_deviation: err in calc of msb");
211 retval = WRITE_REG(REG_FDEV_MSB, msb);
212 if (retval) return retval;
213 retval = WRITE_REG(REG_FDEV_LSB, lsb);
214 if (retval) return retval;
219 int rf69_set_frequency(struct spi_device *spi, u32 frequency)
228 u64 factor = 1000000; // to improve precision of calculation
231 dev_dbg(&spi->dev, "set: frequency");
235 f_step = F_OSC * factor;
236 do_div(f_step, 524288); // 524288 = 2^19
239 f_max = div_u64(f_step * 8388608, factor);
240 if (frequency > f_max) {
241 dev_dbg(&spi->dev, "setFrequency: illegal input param");
245 // calculate reg settings
246 f_reg = frequency * factor;
247 do_div(f_reg , f_step);
249 msb = (f_reg&0xff0000) >> 16;
250 mid = (f_reg&0xff00) >> 8;
254 retval = WRITE_REG(REG_FRF_MSB, msb);
255 if (retval) return retval;
256 retval = WRITE_REG(REG_FRF_MID, mid);
257 if (retval) return retval;
258 retval = WRITE_REG(REG_FRF_LSB, lsb);
259 if (retval) return retval;
264 int rf69_set_amplifier_0(struct spi_device *spi, enum optionOnOff optionOnOff)
267 dev_dbg(&spi->dev, "set: amp #0");
270 switch(optionOnOff) {
271 case optionOn: return WRITE_REG(REG_PALEVEL, (READ_REG(REG_PALEVEL) | MASK_PALEVEL_PA0) );
272 case optionOff: return WRITE_REG(REG_PALEVEL, (READ_REG(REG_PALEVEL) & ~MASK_PALEVEL_PA0) );
274 dev_dbg(&spi->dev, "set: illegal input param");
279 int rf69_set_amplifier_1(struct spi_device *spi, enum optionOnOff optionOnOff)
282 dev_dbg(&spi->dev, "set: amp #1");
285 switch(optionOnOff) {
286 case optionOn: return WRITE_REG(REG_PALEVEL, (READ_REG(REG_PALEVEL) | MASK_PALEVEL_PA1) );
287 case optionOff: return WRITE_REG(REG_PALEVEL, (READ_REG(REG_PALEVEL) & ~MASK_PALEVEL_PA1) );
289 dev_dbg(&spi->dev, "set: illegal input param");
294 int rf69_set_amplifier_2(struct spi_device *spi, enum optionOnOff optionOnOff)
297 dev_dbg(&spi->dev, "set: amp #2");
300 switch(optionOnOff) {
301 case optionOn: return WRITE_REG(REG_PALEVEL, (READ_REG(REG_PALEVEL) | MASK_PALEVEL_PA2) );
302 case optionOff: return WRITE_REG(REG_PALEVEL, (READ_REG(REG_PALEVEL) & ~MASK_PALEVEL_PA2) );
304 dev_dbg(&spi->dev, "set: illegal input param");
309 int rf69_set_output_power_level(struct spi_device *spi, u8 powerLevel)
312 dev_dbg(&spi->dev, "set: power level");
315 powerLevel +=18; // TODO Abhängigkeit von PA0,1,2 setting
318 if (powerLevel > 0x1f) {
319 dev_dbg(&spi->dev, "set: illegal input param");
324 return WRITE_REG(REG_PALEVEL, (READ_REG(REG_PALEVEL) & ~MASK_PALEVEL_OUTPUT_POWER) | powerLevel);
327 int rf69_set_pa_ramp(struct spi_device *spi, enum paRamp paRamp)
330 dev_dbg(&spi->dev, "set: pa ramp");
334 case ramp3400: return WRITE_REG(REG_PARAMP, PARAMP_3400);
335 case ramp2000: return WRITE_REG(REG_PARAMP, PARAMP_2000);
336 case ramp1000: return WRITE_REG(REG_PARAMP, PARAMP_1000);
337 case ramp500: return WRITE_REG(REG_PARAMP, PARAMP_500);
338 case ramp250: return WRITE_REG(REG_PARAMP, PARAMP_250);
339 case ramp125: return WRITE_REG(REG_PARAMP, PARAMP_125);
340 case ramp100: return WRITE_REG(REG_PARAMP, PARAMP_100);
341 case ramp62: return WRITE_REG(REG_PARAMP, PARAMP_62);
342 case ramp50: return WRITE_REG(REG_PARAMP, PARAMP_50);
343 case ramp40: return WRITE_REG(REG_PARAMP, PARAMP_40);
344 case ramp31: return WRITE_REG(REG_PARAMP, PARAMP_31);
345 case ramp25: return WRITE_REG(REG_PARAMP, PARAMP_25);
346 case ramp20: return WRITE_REG(REG_PARAMP, PARAMP_20);
347 case ramp15: return WRITE_REG(REG_PARAMP, PARAMP_15);
348 case ramp12: return WRITE_REG(REG_PARAMP, PARAMP_12);
349 case ramp10: return WRITE_REG(REG_PARAMP, PARAMP_10);
351 dev_dbg(&spi->dev, "set: illegal input param");
356 int rf69_set_antenna_impedance(struct spi_device *spi, enum antennaImpedance antennaImpedance)
359 dev_dbg(&spi->dev, "set: antenna impedance");
362 switch(antennaImpedance) {
363 case fiftyOhm: return WRITE_REG(REG_LNA, (READ_REG(REG_LNA) & ~MASK_LNA_ZIN) );
364 case twohundretOhm: return WRITE_REG(REG_LNA, (READ_REG(REG_LNA) | MASK_LNA_ZIN) );
366 dev_dbg(&spi->dev, "set: illegal input param");
371 int rf69_set_lna_gain(struct spi_device *spi, enum lnaGain lnaGain)
374 dev_dbg(&spi->dev, "set: lna gain");
378 case automatic: return WRITE_REG(REG_LNA, ( (READ_REG(REG_LNA) & ~MASK_LNA_GAIN) & LNA_GAIN_AUTO) );
379 case max: return WRITE_REG(REG_LNA, ( (READ_REG(REG_LNA) & ~MASK_LNA_GAIN) & LNA_GAIN_MAX) );
380 case maxMinus6: return WRITE_REG(REG_LNA, ( (READ_REG(REG_LNA) & ~MASK_LNA_GAIN) & LNA_GAIN_MAX_MINUS_6) );
381 case maxMinus12: return WRITE_REG(REG_LNA, ( (READ_REG(REG_LNA) & ~MASK_LNA_GAIN) & LNA_GAIN_MAX_MINUS_12) );
382 case maxMinus24: return WRITE_REG(REG_LNA, ( (READ_REG(REG_LNA) & ~MASK_LNA_GAIN) & LNA_GAIN_MAX_MINUS_24) );
383 case maxMinus36: return WRITE_REG(REG_LNA, ( (READ_REG(REG_LNA) & ~MASK_LNA_GAIN) & LNA_GAIN_MAX_MINUS_36) );
384 case maxMinus48: return WRITE_REG(REG_LNA, ( (READ_REG(REG_LNA) & ~MASK_LNA_GAIN) & LNA_GAIN_MAX_MINUS_48) );
386 dev_dbg(&spi->dev, "set: illegal input param");
391 enum lnaGain rf69_get_lna_gain(struct spi_device *spi)
396 dev_dbg(&spi->dev, "get: lna gain");
399 currentValue = READ_REG(REG_LNA);
401 switch (currentValue & MASK_LNA_CURRENT_GAIN >> 3) { // improvement: change 3 to define
402 case LNA_GAIN_AUTO: return automatic;
403 case LNA_GAIN_MAX: return max;
404 case LNA_GAIN_MAX_MINUS_6: return maxMinus6;
405 case LNA_GAIN_MAX_MINUS_12: return maxMinus12;
406 case LNA_GAIN_MAX_MINUS_24: return maxMinus24;
407 case LNA_GAIN_MAX_MINUS_36: return maxMinus36;
408 case LNA_GAIN_MAX_MINUS_48: return maxMinus48;
409 default: return undefined;
413 int rf69_set_dc_cut_off_frequency_intern(struct spi_device *spi ,u8 reg, enum dccPercent dccPercent)
415 switch (dccPercent) {
416 case dcc16Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_16_PERCENT) );
417 case dcc8Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_8_PERCENT) );
418 case dcc4Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_4_PERCENT) );
419 case dcc2Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_2_PERCENT) );
420 case dcc1Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_1_PERCENT) );
421 case dcc0_5Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_0_5_PERCENT) );
422 case dcc0_25Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_0_25_PERCENT) );
423 case dcc0_125Percent: return WRITE_REG(reg, ( (READ_REG(reg) & ~MASK_BW_DCC_FREQ) | BW_DCC_0_125_PERCENT) );
425 dev_dbg(&spi->dev, "set: illegal input param");
430 int rf69_set_dc_cut_off_frequency(struct spi_device *spi, enum dccPercent dccPercent)
433 dev_dbg(&spi->dev, "set: cut off freq");
436 return rf69_set_dc_cut_off_frequency_intern(spi, REG_RXBW, dccPercent);
439 int rf69_set_dc_cut_off_frequency_during_afc(struct spi_device *spi, enum dccPercent dccPercent)
442 dev_dbg(&spi->dev, "set: cut off freq during afc");
445 return rf69_set_dc_cut_off_frequency_intern(spi, REG_AFCBW, dccPercent);
448 static int rf69_set_bandwidth_intern(struct spi_device *spi, u8 reg,
449 enum mantisse mantisse, u8 exponent)
453 // check value for mantisse and exponent
455 dev_dbg(&spi->dev, "set: illegal input param");
459 if ((mantisse != mantisse16) &&
460 (mantisse != mantisse20) &&
461 (mantisse != mantisse24)) {
462 dev_dbg(&spi->dev, "set: illegal input param");
467 newValue = READ_REG(reg);
469 // "delete" mantisse and exponent = just keep the DCC setting
470 newValue = newValue & MASK_BW_DCC_FREQ;
474 case mantisse16: newValue = newValue | BW_MANT_16; break;
475 case mantisse20: newValue = newValue | BW_MANT_20; break;
476 case mantisse24: newValue = newValue | BW_MANT_24; break;
480 newValue = newValue | exponent;
483 return WRITE_REG(reg, newValue);
486 int rf69_set_bandwidth(struct spi_device *spi, enum mantisse mantisse, u8 exponent)
489 dev_dbg(&spi->dev, "set: band width");
492 return rf69_set_bandwidth_intern(spi, REG_RXBW, mantisse, exponent);
495 int rf69_set_bandwidth_during_afc(struct spi_device *spi, enum mantisse mantisse, u8 exponent)
498 dev_dbg(&spi->dev, "set: band width during afc");
501 return rf69_set_bandwidth_intern(spi, REG_AFCBW, mantisse, exponent);
504 int rf69_set_ook_threshold_type(struct spi_device *spi, enum thresholdType thresholdType)
507 dev_dbg(&spi->dev, "set: threshold type");
510 switch (thresholdType) {
511 case fixed: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESTYPE) | OOKPEAK_THRESHTYPE_FIXED) );
512 case peak: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESTYPE) | OOKPEAK_THRESHTYPE_PEAK) );
513 case average: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESTYPE) | OOKPEAK_THRESHTYPE_AVERAGE) );
515 dev_dbg(&spi->dev, "set: illegal input param");
520 int rf69_set_ook_threshold_step(struct spi_device *spi, enum thresholdStep thresholdStep)
523 dev_dbg(&spi->dev, "set: threshold step");
526 switch (thresholdStep) {
527 case step_0_5db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_0_5_DB) );
528 case step_1_0db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_1_0_DB) );
529 case step_1_5db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_1_5_DB) );
530 case step_2_0db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_2_0_DB) );
531 case step_3_0db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_3_0_DB) );
532 case step_4_0db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_4_0_DB) );
533 case step_5_0db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_5_0_DB) );
534 case step_6_0db: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESSTEP) | OOKPEAK_THRESHSTEP_6_0_DB) );
536 dev_dbg(&spi->dev, "set: illegal input param");
541 int rf69_set_ook_threshold_dec(struct spi_device *spi, enum thresholdDecrement thresholdDecrement)
544 dev_dbg(&spi->dev, "set: threshold decrement");
547 switch (thresholdDecrement) {
548 case dec_every8th: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_EVERY_8TH) );
549 case dec_every4th: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_EVERY_4TH) );
550 case dec_every2nd: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_EVERY_2ND) );
551 case dec_once: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_ONCE) );
552 case dec_twice: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_TWICE) );
553 case dec_4times: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_4_TIMES) );
554 case dec_8times: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_8_TIMES) );
555 case dec_16times: return WRITE_REG(REG_OOKPEAK, ( (READ_REG(REG_OOKPEAK) & ~MASK_OOKPEAK_THRESDEC) | OOKPEAK_THRESHDEC_16_TIMES) );
557 dev_dbg(&spi->dev, "set: illegal input param");
562 int rf69_set_dio_mapping(struct spi_device *spi, u8 DIONumber, u8 value)
570 dev_dbg(&spi->dev, "set: DIO mapping");
574 case 0: mask=MASK_DIO0; shift=SHIFT_DIO0; regaddr=REG_DIOMAPPING1; break;
575 case 1: mask=MASK_DIO1; shift=SHIFT_DIO1; regaddr=REG_DIOMAPPING1; break;
576 case 2: mask=MASK_DIO2; shift=SHIFT_DIO2; regaddr=REG_DIOMAPPING1; break;
577 case 3: mask=MASK_DIO3; shift=SHIFT_DIO3; regaddr=REG_DIOMAPPING1; break;
578 case 4: mask=MASK_DIO4; shift=SHIFT_DIO4; regaddr=REG_DIOMAPPING2; break;
579 case 5: mask=MASK_DIO5; shift=SHIFT_DIO5; regaddr=REG_DIOMAPPING2; break;
581 dev_dbg(&spi->dev, "set: illegal input param");
586 regValue=READ_REG(regaddr);
588 regValue = regValue & ~mask;
590 regValue = regValue | value << shift;
592 return WRITE_REG(regaddr,regValue);
595 bool rf69_get_flag(struct spi_device *spi, enum flag flag)
598 dev_dbg(&spi->dev, "get: flag");
602 case modeSwitchCompleted: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_MODE_READY);
603 case readyToReceive: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_RX_READY);
604 case readyToSend: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_TX_READY);
605 case pllLocked: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_PLL_LOCK);
606 case rssiExceededThreshold: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_RSSI);
607 case timeout: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_TIMEOUT);
608 case automode: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_AUTOMODE);
609 case syncAddressMatch: return (READ_REG(REG_IRQFLAGS1) & MASK_IRQFLAGS1_SYNC_ADDRESS_MATCH);
610 case fifoFull: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_FIFO_FULL);
611 /* case fifoNotEmpty: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_FIFO_NOT_EMPTY); */
612 case fifoEmpty: return !(READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_FIFO_NOT_EMPTY);
613 case fifoLevelBelowThreshold: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_FIFO_LEVEL);
614 case fifoOverrun: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_FIFO_OVERRUN);
615 case packetSent: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_PACKET_SENT);
616 case payloadReady: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_PAYLOAD_READY);
617 case crcOk: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_CRC_OK);
618 case batteryLow: return (READ_REG(REG_IRQFLAGS2) & MASK_IRQFLAGS2_LOW_BAT);
619 default: return false;
623 int rf69_reset_flag(struct spi_device *spi, enum flag flag)
626 dev_dbg(&spi->dev, "reset: flag");
630 case rssiExceededThreshold: return WRITE_REG(REG_IRQFLAGS1, MASK_IRQFLAGS1_RSSI);
631 case syncAddressMatch: return WRITE_REG(REG_IRQFLAGS1, MASK_IRQFLAGS1_SYNC_ADDRESS_MATCH);
632 case fifoOverrun: return WRITE_REG(REG_IRQFLAGS2, MASK_IRQFLAGS2_FIFO_OVERRUN);
634 dev_dbg(&spi->dev, "set: illegal input param");
639 int rf69_set_rssi_threshold(struct spi_device *spi, u8 threshold)
642 dev_dbg(&spi->dev, "set: rssi threshold");
645 /* no value check needed - u8 exactly matches register size */
647 return WRITE_REG(REG_RSSITHRESH, threshold);
650 int rf69_set_rx_start_timeout(struct spi_device *spi, u8 timeout)
653 dev_dbg(&spi->dev, "set: start timeout");
656 /* no value check needed - u8 exactly matches register size */
658 return WRITE_REG(REG_RXTIMEOUT1, timeout);
661 int rf69_set_rssi_timeout(struct spi_device *spi, u8 timeout)
664 dev_dbg(&spi->dev, "set: rssi timeout");
667 /* no value check needed - u8 exactly matches register size */
669 return WRITE_REG(REG_RXTIMEOUT2, timeout);
672 int rf69_set_preamble_length(struct spi_device *spi, u16 preambleLength)
678 dev_dbg(&spi->dev, "set: preamble length");
681 /* no value check needed - u16 exactly matches register size */
683 /* calculate reg settings */
684 msb = (preambleLength&0xff00) >> 8;
685 lsb = (preambleLength&0xff);
687 /* transmit to chip */
688 retval = WRITE_REG(REG_PREAMBLE_MSB, msb);
689 if (retval) return retval;
690 retval = WRITE_REG(REG_PREAMBLE_LSB, lsb);
695 int rf69_set_sync_enable(struct spi_device *spi, enum optionOnOff optionOnOff)
698 dev_dbg(&spi->dev, "set: sync enable");
701 switch(optionOnOff) {
702 case optionOn: return WRITE_REG(REG_SYNC_CONFIG, (READ_REG(REG_SYNC_CONFIG) | MASK_SYNC_CONFIG_SYNC_ON) );
703 case optionOff: return WRITE_REG(REG_SYNC_CONFIG, (READ_REG(REG_SYNC_CONFIG) & ~MASK_SYNC_CONFIG_SYNC_ON) );
705 dev_dbg(&spi->dev, "set: illegal input param");
710 int rf69_set_fifo_fill_condition(struct spi_device *spi, enum fifoFillCondition fifoFillCondition)
713 dev_dbg(&spi->dev, "set: fifo fill condition");
716 switch(fifoFillCondition) {
717 case always: return WRITE_REG(REG_SYNC_CONFIG, (READ_REG(REG_SYNC_CONFIG) | MASK_SYNC_CONFIG_FIFO_FILL_CONDITION) );
718 case afterSyncInterrupt: return WRITE_REG(REG_SYNC_CONFIG, (READ_REG(REG_SYNC_CONFIG) & ~MASK_SYNC_CONFIG_FIFO_FILL_CONDITION) );
720 dev_dbg(&spi->dev, "set: illegal input param");
725 int rf69_set_sync_size(struct spi_device *spi, u8 syncSize)
728 dev_dbg(&spi->dev, "set: sync size");
732 if (syncSize > 0x07) {
733 dev_dbg(&spi->dev, "set: illegal input param");
738 return WRITE_REG(REG_SYNC_CONFIG, (READ_REG(REG_SYNC_CONFIG) & ~MASK_SYNC_CONFIG_SYNC_SIZE) | (syncSize << 3) );
741 int rf69_set_sync_tolerance(struct spi_device *spi, u8 syncTolerance)
744 dev_dbg(&spi->dev, "set: sync tolerance");
748 if (syncTolerance > 0x07) {
749 dev_dbg(&spi->dev, "set: illegal input param");
754 return WRITE_REG(REG_SYNC_CONFIG, (READ_REG(REG_SYNC_CONFIG) & ~MASK_SYNC_CONFIG_SYNC_SIZE) | syncTolerance);
757 int rf69_set_sync_values(struct spi_device *spi, u8 syncValues[8])
762 dev_dbg(&spi->dev, "set: sync values");
765 retval += WRITE_REG(REG_SYNCVALUE1, syncValues[0]);
766 retval += WRITE_REG(REG_SYNCVALUE2, syncValues[1]);
767 retval += WRITE_REG(REG_SYNCVALUE3, syncValues[2]);
768 retval += WRITE_REG(REG_SYNCVALUE4, syncValues[3]);
769 retval += WRITE_REG(REG_SYNCVALUE5, syncValues[4]);
770 retval += WRITE_REG(REG_SYNCVALUE6, syncValues[5]);
771 retval += WRITE_REG(REG_SYNCVALUE7, syncValues[6]);
772 retval += WRITE_REG(REG_SYNCVALUE8, syncValues[7]);
777 int rf69_set_packet_format(struct spi_device *spi, enum packetFormat packetFormat)
780 dev_dbg(&spi->dev, "set: packet format");
783 switch(packetFormat) {
784 case packetLengthVar: return WRITE_REG(REG_PACKETCONFIG1, (READ_REG(REG_PACKETCONFIG1) | MASK_PACKETCONFIG1_PAKET_FORMAT_VARIABLE) );
785 case packetLengthFix: return WRITE_REG(REG_PACKETCONFIG1, (READ_REG(REG_PACKETCONFIG1) & ~MASK_PACKETCONFIG1_PAKET_FORMAT_VARIABLE) );
787 dev_dbg(&spi->dev, "set: illegal input param");
792 int rf69_set_crc_enable(struct spi_device *spi, enum optionOnOff optionOnOff)
795 dev_dbg(&spi->dev, "set: crc enable");
798 switch(optionOnOff) {
799 case optionOn: return WRITE_REG(REG_PACKETCONFIG1, (READ_REG(REG_PACKETCONFIG1) | MASK_PACKETCONFIG1_CRC_ON) );
800 case optionOff: return WRITE_REG(REG_PACKETCONFIG1, (READ_REG(REG_PACKETCONFIG1) & ~MASK_PACKETCONFIG1_CRC_ON) );
802 dev_dbg(&spi->dev, "set: illegal input param");
807 int rf69_set_adressFiltering(struct spi_device *spi, enum addressFiltering addressFiltering)
810 dev_dbg(&spi->dev, "set: address filtering");
813 switch (addressFiltering) {
814 case filteringOff: return WRITE_REG(REG_PACKETCONFIG1, ( (READ_REG(REG_PACKETCONFIG1) & ~MASK_PACKETCONFIG1_ADDRESSFILTERING) | PACKETCONFIG1_ADDRESSFILTERING_OFF) );
815 case nodeAddress: return WRITE_REG(REG_PACKETCONFIG1, ( (READ_REG(REG_PACKETCONFIG1) & ~MASK_PACKETCONFIG1_ADDRESSFILTERING) | PACKETCONFIG1_ADDRESSFILTERING_NODE) );
816 case nodeOrBroadcastAddress: return WRITE_REG(REG_PACKETCONFIG1, ( (READ_REG(REG_PACKETCONFIG1) & ~MASK_PACKETCONFIG1_ADDRESSFILTERING) | PACKETCONFIG1_ADDRESSFILTERING_NODEBROADCAST) );
818 dev_dbg(&spi->dev, "set: illegal input param");
823 int rf69_set_payload_length(struct spi_device *spi, u8 payloadLength)
826 dev_dbg(&spi->dev, "set: payload length");
829 return WRITE_REG(REG_PAYLOAD_LENGTH, payloadLength);
832 u8 rf69_get_payload_length(struct spi_device *spi)
835 dev_dbg(&spi->dev, "get: payload length");
838 return (u8) READ_REG(REG_PAYLOAD_LENGTH);
841 int rf69_set_node_address(struct spi_device *spi, u8 nodeAddress)
844 dev_dbg(&spi->dev, "set: node address");
847 return WRITE_REG(REG_NODEADRS, nodeAddress);
850 int rf69_set_broadcast_address(struct spi_device *spi, u8 broadcastAddress)
853 dev_dbg(&spi->dev, "set: broadcast address");
856 return WRITE_REG(REG_BROADCASTADRS, broadcastAddress);
859 int rf69_set_tx_start_condition(struct spi_device *spi, enum txStartCondition txStartCondition)
862 dev_dbg(&spi->dev, "set: start condition");
865 switch(txStartCondition) {
866 case fifoLevel: return WRITE_REG(REG_FIFO_THRESH, (READ_REG(REG_FIFO_THRESH) & ~MASK_FIFO_THRESH_TXSTART) );
867 case fifoNotEmpty: return WRITE_REG(REG_FIFO_THRESH, (READ_REG(REG_FIFO_THRESH) | MASK_FIFO_THRESH_TXSTART) );
869 dev_dbg(&spi->dev, "set: illegal input param");
874 int rf69_set_fifo_threshold(struct spi_device *spi, u8 threshold)
879 dev_dbg(&spi->dev, "set: fifo threshold");
883 if (threshold & 0x80) {
884 dev_dbg(&spi->dev, "set: illegal input param");
889 retval = WRITE_REG(REG_FIFO_THRESH, (READ_REG(REG_FIFO_THRESH) & ~MASK_FIFO_THRESH_VALUE) | threshold);
893 // access the fifo to activate new threshold
894 return rf69_read_fifo (spi, (u8*) &retval, 1); // retval used as buffer
897 int rf69_set_dagc(struct spi_device *spi, enum dagc dagc)
900 dev_dbg(&spi->dev, "set: dagc");
904 case normalMode: return WRITE_REG(REG_TESTDAGC, DAGC_NORMAL);
905 case improve: return WRITE_REG(REG_TESTDAGC, DAGC_IMPROVED_LOWBETA0);
906 case improve4LowModulationIndex: return WRITE_REG(REG_TESTDAGC, DAGC_IMPROVED_LOWBETA1);
908 dev_dbg(&spi->dev, "set: illegal input param");
913 /*-------------------------------------------------------------------------*/
915 int rf69_read_fifo (struct spi_device *spi, u8 *buffer, unsigned int size)
917 #ifdef DEBUG_FIFO_ACCESS
920 struct spi_transfer transfer;
921 u8 local_buffer[FIFO_SIZE + 1];
924 if (size > FIFO_SIZE) {
926 dev_dbg(&spi->dev, "read fifo: passed in buffer bigger then internal buffer \n");
931 /* prepare a bidirectional transfer */
932 local_buffer[0] = REG_FIFO;
933 memset(&transfer, 0, sizeof(transfer));
934 transfer.tx_buf = local_buffer;
935 transfer.rx_buf = local_buffer;
936 transfer.len = size+1;
938 retval = spi_sync_transfer(spi, &transfer, 1);
940 #ifdef DEBUG_FIFO_ACCESS
941 for (i=0; i<size; i++)
942 dev_dbg(&spi->dev, "%d - 0x%x\n", i, local_buffer[i+1]);
945 memcpy(buffer, &local_buffer[1], size); // TODO: ohne memcopy wäre schöner
950 int rf69_write_fifo(struct spi_device *spi, u8 *buffer, unsigned int size)
952 #ifdef DEBUG_FIFO_ACCESS
955 char spi_address = REG_FIFO | WRITE_BIT;
956 u8 local_buffer[FIFO_SIZE + 1];
958 if (size > FIFO_SIZE) {
960 dev_dbg(&spi->dev, "read fifo: passed in buffer bigger then internal buffer \n");
965 local_buffer[0] = spi_address;
966 memcpy(&local_buffer[1], buffer, size); // TODO: ohne memcopy wäre schöner
968 #ifdef DEBUG_FIFO_ACCESS
969 for (i=0; i<size; i++)
970 dev_dbg(&spi->dev, "0x%x\n",buffer[i]);
973 return spi_write (spi, local_buffer, size + 1);
976 /*-------------------------------------------------------------------------*/
978 u8 rf69_read_reg(struct spi_device *spi, u8 addr)
982 retval = spi_w8r8(spi, addr);
986 /* should never happen, since we already checked,
987 * that module is connected. Therefore no error
988 * handling, just an optional error message...
990 dev_dbg(&spi->dev, "read 0x%x FAILED\n",
993 dev_dbg(&spi->dev, "read 0x%x from reg 0x%x\n",
1001 int rf69_write_reg(struct spi_device *spi, u8 addr, u8 value)
1006 buffer[0] = addr | WRITE_BIT;
1009 retval = spi_write(spi, &buffer, 2);
1013 /* should never happen, since we already checked,
1014 * that module is connected. Therefore no error
1015 * handling, just an optional error message...
1017 dev_dbg(&spi->dev, "write 0x%x to 0x%x FAILED\n",
1021 dev_dbg(&spi->dev, "wrote 0x%x to reg 0x%x\n",