1 // SPDX-License-Identifier: GPL-2.0+
3 * abstraction of the spi interface of HopeRf rf69 radio module
5 * Copyright (C) 2016 Wolf-Entwicklungen
6 * Marcus Wolf <linux@wolf-entwicklungen.de>
9 #include <linux/types.h>
10 #include <linux/spi/spi.h>
13 #include "rf69_registers.h"
15 #define F_OSC 32000000 /* in Hz */
16 #define FIFO_SIZE 66 /* in byte */
18 /*-------------------------------------------------------------------------*/
20 u8 rf69_read_reg(struct spi_device *spi, u8 addr)
22 return spi_w8r8(spi, addr);
25 static int rf69_write_reg(struct spi_device *spi, u8 addr, u8 value)
29 buffer[0] = addr | WRITE_BIT;
32 return spi_write(spi, &buffer, ARRAY_SIZE(buffer));
35 /*-------------------------------------------------------------------------*/
37 static int rf69_set_bit(struct spi_device *spi, u8 reg, u8 mask)
41 tmp = rf69_read_reg(spi, reg);
43 return rf69_write_reg(spi, reg, tmp);
46 static int rf69_clear_bit(struct spi_device *spi, u8 reg, u8 mask)
50 tmp = rf69_read_reg(spi, reg);
52 return rf69_write_reg(spi, reg, tmp);
55 static inline int rf69_read_mod_write(struct spi_device *spi, u8 reg,
60 tmp = rf69_read_reg(spi, reg);
61 tmp = (tmp & ~mask) | value;
62 return rf69_write_reg(spi, reg, tmp);
65 /*-------------------------------------------------------------------------*/
67 int rf69_get_version(struct spi_device *spi)
69 return rf69_read_reg(spi, REG_VERSION);
72 int rf69_set_mode(struct spi_device *spi, enum mode mode)
74 static const u8 mode_map[] = {
75 [transmit] = OPMODE_MODE_TRANSMIT,
76 [receive] = OPMODE_MODE_RECEIVE,
77 [synthesizer] = OPMODE_MODE_SYNTHESIZER,
78 [standby] = OPMODE_MODE_STANDBY,
79 [mode_sleep] = OPMODE_MODE_SLEEP,
82 if (unlikely(mode >= ARRAY_SIZE(mode_map))) {
83 dev_dbg(&spi->dev, "set: illegal mode %u\n", mode);
87 return rf69_read_mod_write(spi, REG_OPMODE, MASK_OPMODE_MODE,
91 * we are using packet mode, so this check is not really needed
92 * but waiting for mode ready is necessary when going from sleep
93 * because the FIFO may not be immediately available from previous mode
94 * while (_mode == RF69_MODE_SLEEP && (READ_REG(REG_IRQFLAGS1) &
95 RF_IRQFLAGS1_MODEREADY) == 0x00); // Wait for ModeReady
99 int rf69_set_data_mode(struct spi_device *spi, u8 data_mode)
101 return rf69_read_mod_write(spi, REG_DATAMODUL, MASK_DATAMODUL_MODE,
105 int rf69_set_modulation(struct spi_device *spi, enum modulation modulation)
107 static const u8 modulation_map[] = {
108 [OOK] = DATAMODUL_MODULATION_TYPE_OOK,
109 [FSK] = DATAMODUL_MODULATION_TYPE_FSK,
112 if (unlikely(modulation >= ARRAY_SIZE(modulation_map))) {
113 dev_dbg(&spi->dev, "set: illegal modulation %u\n", modulation);
117 return rf69_read_mod_write(spi, REG_DATAMODUL,
118 MASK_DATAMODUL_MODULATION_TYPE,
119 modulation_map[modulation]);
122 static enum modulation rf69_get_modulation(struct spi_device *spi)
126 modulation_reg = rf69_read_reg(spi, REG_DATAMODUL);
128 switch (modulation_reg & MASK_DATAMODUL_MODULATION_TYPE) {
129 case DATAMODUL_MODULATION_TYPE_OOK:
131 case DATAMODUL_MODULATION_TYPE_FSK:
138 int rf69_set_modulation_shaping(struct spi_device *spi,
139 enum mod_shaping mod_shaping)
141 switch (rf69_get_modulation(spi)) {
143 switch (mod_shaping) {
145 return rf69_read_mod_write(spi, REG_DATAMODUL,
146 MASK_DATAMODUL_MODULATION_SHAPE,
147 DATAMODUL_MODULATION_SHAPE_NONE);
149 return rf69_read_mod_write(spi, REG_DATAMODUL,
150 MASK_DATAMODUL_MODULATION_SHAPE,
151 DATAMODUL_MODULATION_SHAPE_1_0);
153 return rf69_read_mod_write(spi, REG_DATAMODUL,
154 MASK_DATAMODUL_MODULATION_SHAPE,
155 DATAMODUL_MODULATION_SHAPE_0_5);
157 return rf69_read_mod_write(spi, REG_DATAMODUL,
158 MASK_DATAMODUL_MODULATION_SHAPE,
159 DATAMODUL_MODULATION_SHAPE_0_3);
161 dev_dbg(&spi->dev, "set: illegal mod shaping for FSK %u\n", mod_shaping);
165 switch (mod_shaping) {
167 return rf69_read_mod_write(spi, REG_DATAMODUL,
168 MASK_DATAMODUL_MODULATION_SHAPE,
169 DATAMODUL_MODULATION_SHAPE_NONE);
171 return rf69_read_mod_write(spi, REG_DATAMODUL,
172 MASK_DATAMODUL_MODULATION_SHAPE,
173 DATAMODUL_MODULATION_SHAPE_BR);
175 return rf69_read_mod_write(spi, REG_DATAMODUL,
176 MASK_DATAMODUL_MODULATION_SHAPE,
177 DATAMODUL_MODULATION_SHAPE_2BR);
179 dev_dbg(&spi->dev, "set: illegal mod shaping for OOK %u\n", mod_shaping);
183 dev_dbg(&spi->dev, "set: modulation undefined\n");
188 int rf69_set_bit_rate(struct spi_device *spi, u16 bit_rate)
196 // check if modulation is configured
197 mod = rf69_get_modulation(spi);
199 dev_dbg(&spi->dev, "setBitRate: modulation is undefined\n");
204 if (bit_rate < 1200 || (mod == OOK && bit_rate > 32768)) {
205 dev_dbg(&spi->dev, "setBitRate: illegal input param\n");
209 // calculate reg settings
210 bit_rate_reg = (F_OSC / bit_rate);
212 msb = (bit_rate_reg & 0xff00) >> 8;
213 lsb = (bit_rate_reg & 0xff);
216 retval = rf69_write_reg(spi, REG_BITRATE_MSB, msb);
219 retval = rf69_write_reg(spi, REG_BITRATE_LSB, lsb);
226 int rf69_set_deviation(struct spi_device *spi, u32 deviation)
235 u64 factor = 1000000; // to improve precision of calculation
237 // calculate bit rate
238 bit_rate_reg = rf69_read_reg(spi, REG_BITRATE_MSB) << 8;
239 bit_rate_reg |= rf69_read_reg(spi, REG_BITRATE_LSB);
240 bit_rate = F_OSC / bit_rate_reg;
243 * frequency deviation must exceed 600 Hz but not exceed
244 * 500kHz when taking bitrate dependency into consideration
245 * to ensure proper modulation
247 if (deviation < 600 || (deviation + (bit_rate / 2)) > 500000) {
249 "set_deviation: illegal input param: %u\n", deviation);
254 f_step = F_OSC * factor;
255 do_div(f_step, 524288); // 524288 = 2^19
257 // calculate register settings
258 f_reg = deviation * factor;
259 do_div(f_reg, f_step);
261 msb = (f_reg & 0xff00) >> 8;
262 lsb = (f_reg & 0xff);
265 if (msb & ~FDEVMASB_MASK) {
266 dev_dbg(&spi->dev, "set_deviation: err in calc of msb\n");
271 retval = rf69_write_reg(spi, REG_FDEV_MSB, msb);
274 retval = rf69_write_reg(spi, REG_FDEV_LSB, lsb);
281 int rf69_set_frequency(struct spi_device *spi, u32 frequency)
290 u64 factor = 1000000; // to improve precision of calculation
293 f_step = F_OSC * factor;
294 do_div(f_step, 524288); // 524288 = 2^19
297 f_max = div_u64(f_step * 8388608, factor);
298 if (frequency > f_max) {
299 dev_dbg(&spi->dev, "setFrequency: illegal input param\n");
303 // calculate reg settings
304 f_reg = frequency * factor;
305 do_div(f_reg, f_step);
307 msb = (f_reg & 0xff0000) >> 16;
308 mid = (f_reg & 0xff00) >> 8;
309 lsb = (f_reg & 0xff);
312 retval = rf69_write_reg(spi, REG_FRF_MSB, msb);
315 retval = rf69_write_reg(spi, REG_FRF_MID, mid);
318 retval = rf69_write_reg(spi, REG_FRF_LSB, lsb);
325 int rf69_enable_amplifier(struct spi_device *spi, u8 amplifier_mask)
327 return rf69_set_bit(spi, REG_PALEVEL, amplifier_mask);
330 int rf69_disable_amplifier(struct spi_device *spi, u8 amplifier_mask)
332 return rf69_clear_bit(spi, REG_PALEVEL, amplifier_mask);
335 int rf69_set_output_power_level(struct spi_device *spi, u8 power_level)
337 u8 pa_level, ocp, test_pa1, test_pa2;
338 bool pa0, pa1, pa2, high_power;
341 // check register pa_level
342 pa_level = rf69_read_reg(spi, REG_PALEVEL);
343 pa0 = pa_level & MASK_PALEVEL_PA0;
344 pa1 = pa_level & MASK_PALEVEL_PA1;
345 pa2 = pa_level & MASK_PALEVEL_PA2;
347 // check high power mode
348 ocp = rf69_read_reg(spi, REG_OCP);
349 test_pa1 = rf69_read_reg(spi, REG_TESTPA1);
350 test_pa2 = rf69_read_reg(spi, REG_TESTPA2);
351 high_power = (ocp == 0x0f) && (test_pa1 == 0x5d) && (test_pa2 == 0x7c);
353 if (pa0 && !pa1 && !pa2) {
356 } else if (!pa0 && pa1 && !pa2) {
358 min_power_level = 16;
359 } else if (!pa0 && pa1 && pa2) {
364 min_power_level = 16;
370 if (power_level > 0x1f)
373 if (power_level < min_power_level)
377 return rf69_read_mod_write(spi, REG_PALEVEL, MASK_PALEVEL_OUTPUT_POWER,
380 dev_dbg(&spi->dev, "set: illegal power level %u\n", power_level);
384 int rf69_set_pa_ramp(struct spi_device *spi, enum pa_ramp pa_ramp)
386 static const u8 pa_ramp_map[] = {
387 [ramp3400] = PARAMP_3400,
388 [ramp2000] = PARAMP_2000,
389 [ramp1000] = PARAMP_1000,
390 [ramp500] = PARAMP_500,
391 [ramp250] = PARAMP_250,
392 [ramp125] = PARAMP_125,
393 [ramp100] = PARAMP_100,
394 [ramp62] = PARAMP_62,
395 [ramp50] = PARAMP_50,
396 [ramp40] = PARAMP_40,
397 [ramp31] = PARAMP_31,
398 [ramp25] = PARAMP_25,
399 [ramp20] = PARAMP_20,
400 [ramp15] = PARAMP_15,
401 [ramp10] = PARAMP_10,
404 if (unlikely(pa_ramp >= ARRAY_SIZE(pa_ramp_map))) {
405 dev_dbg(&spi->dev, "set: illegal pa_ramp %u\n", pa_ramp);
409 return rf69_write_reg(spi, REG_PARAMP, pa_ramp_map[pa_ramp]);
412 int rf69_set_antenna_impedance(struct spi_device *spi,
413 enum antenna_impedance antenna_impedance)
415 switch (antenna_impedance) {
417 return rf69_clear_bit(spi, REG_LNA, MASK_LNA_ZIN);
418 case two_hundred_ohm:
419 return rf69_set_bit(spi, REG_LNA, MASK_LNA_ZIN);
421 dev_dbg(&spi->dev, "set: illegal antenna impedance %u\n", antenna_impedance);
426 int rf69_set_lna_gain(struct spi_device *spi, enum lna_gain lna_gain)
428 static const u8 lna_gain_map[] = {
429 [automatic] = LNA_GAIN_AUTO,
430 [max] = LNA_GAIN_MAX,
431 [max_minus_6] = LNA_GAIN_MAX_MINUS_6,
432 [max_minus_12] = LNA_GAIN_MAX_MINUS_12,
433 [max_minus_24] = LNA_GAIN_MAX_MINUS_24,
434 [max_minus_36] = LNA_GAIN_MAX_MINUS_36,
435 [max_minus_48] = LNA_GAIN_MAX_MINUS_48,
438 if (unlikely(lna_gain >= ARRAY_SIZE(lna_gain_map))) {
439 dev_dbg(&spi->dev, "set: illegal lna gain %u\n", lna_gain);
443 return rf69_read_mod_write(spi, REG_LNA, MASK_LNA_GAIN,
444 lna_gain_map[lna_gain]);
447 static int rf69_set_bandwidth_intern(struct spi_device *spi, u8 reg,
448 enum mantisse mantisse, u8 exponent)
452 // check value for mantisse and exponent
454 dev_dbg(&spi->dev, "set: illegal bandwidth exponent %u\n", exponent);
458 if (mantisse != mantisse16 &&
459 mantisse != mantisse20 &&
460 mantisse != mantisse24) {
461 dev_dbg(&spi->dev, "set: illegal bandwidth mantisse %u\n", mantisse);
466 bandwidth = rf69_read_reg(spi, reg);
468 // "delete" mantisse and exponent = just keep the DCC setting
469 bandwidth = bandwidth & MASK_BW_DCC_FREQ;
474 bandwidth = bandwidth | BW_MANT_16;
477 bandwidth = bandwidth | BW_MANT_20;
480 bandwidth = bandwidth | BW_MANT_24;
485 bandwidth = bandwidth | exponent;
488 return rf69_write_reg(spi, reg, bandwidth);
491 int rf69_set_bandwidth(struct spi_device *spi, enum mantisse mantisse,
494 return rf69_set_bandwidth_intern(spi, REG_RXBW, mantisse, exponent);
497 int rf69_set_bandwidth_during_afc(struct spi_device *spi,
498 enum mantisse mantisse,
501 return rf69_set_bandwidth_intern(spi, REG_AFCBW, mantisse, exponent);
504 int rf69_set_ook_threshold_dec(struct spi_device *spi,
505 enum threshold_decrement threshold_decrement)
507 static const u8 td_map[] = {
508 [dec_every8th] = OOKPEAK_THRESHDEC_EVERY_8TH,
509 [dec_every4th] = OOKPEAK_THRESHDEC_EVERY_4TH,
510 [dec_every2nd] = OOKPEAK_THRESHDEC_EVERY_2ND,
511 [dec_once] = OOKPEAK_THRESHDEC_ONCE,
512 [dec_twice] = OOKPEAK_THRESHDEC_TWICE,
513 [dec_4times] = OOKPEAK_THRESHDEC_4_TIMES,
514 [dec_8times] = OOKPEAK_THRESHDEC_8_TIMES,
515 [dec_16times] = OOKPEAK_THRESHDEC_16_TIMES,
518 if (unlikely(threshold_decrement >= ARRAY_SIZE(td_map))) {
519 dev_dbg(&spi->dev, "set: illegal OOK threshold decrement %u\n",
520 threshold_decrement);
524 return rf69_read_mod_write(spi, REG_OOKPEAK, MASK_OOKPEAK_THRESDEC,
525 td_map[threshold_decrement]);
528 int rf69_set_dio_mapping(struct spi_device *spi, u8 dio_number, u8 value)
535 switch (dio_number) {
539 dio_addr = REG_DIOMAPPING1;
544 dio_addr = REG_DIOMAPPING1;
549 dio_addr = REG_DIOMAPPING1;
554 dio_addr = REG_DIOMAPPING1;
559 dio_addr = REG_DIOMAPPING2;
564 dio_addr = REG_DIOMAPPING2;
567 dev_dbg(&spi->dev, "set: illegal dio number %u\n", dio_number);
572 dio_value = rf69_read_reg(spi, dio_addr);
574 dio_value = dio_value & ~mask;
576 dio_value = dio_value | value << shift;
578 return rf69_write_reg(spi, dio_addr, dio_value);
581 int rf69_set_rssi_threshold(struct spi_device *spi, u8 threshold)
583 /* no value check needed - u8 exactly matches register size */
585 return rf69_write_reg(spi, REG_RSSITHRESH, threshold);
588 int rf69_set_preamble_length(struct spi_device *spi, u16 preamble_length)
593 /* no value check needed - u16 exactly matches register size */
595 /* calculate reg settings */
596 msb = (preamble_length & 0xff00) >> 8;
597 lsb = (preamble_length & 0xff);
599 /* transmit to chip */
600 retval = rf69_write_reg(spi, REG_PREAMBLE_MSB, msb);
603 return rf69_write_reg(spi, REG_PREAMBLE_LSB, lsb);
606 int rf69_enable_sync(struct spi_device *spi)
608 return rf69_set_bit(spi, REG_SYNC_CONFIG, MASK_SYNC_CONFIG_SYNC_ON);
611 int rf69_disable_sync(struct spi_device *spi)
613 return rf69_clear_bit(spi, REG_SYNC_CONFIG, MASK_SYNC_CONFIG_SYNC_ON);
616 int rf69_set_fifo_fill_condition(struct spi_device *spi,
617 enum fifo_fill_condition fifo_fill_condition)
619 switch (fifo_fill_condition) {
621 return rf69_set_bit(spi, REG_SYNC_CONFIG,
622 MASK_SYNC_CONFIG_FIFO_FILL_CONDITION);
623 case after_sync_interrupt:
624 return rf69_clear_bit(spi, REG_SYNC_CONFIG,
625 MASK_SYNC_CONFIG_FIFO_FILL_CONDITION);
627 dev_dbg(&spi->dev, "set: illegal fifo fill condition %u\n", fifo_fill_condition);
632 int rf69_set_sync_size(struct spi_device *spi, u8 sync_size)
635 if (sync_size > 0x07) {
636 dev_dbg(&spi->dev, "set: illegal sync size %u\n", sync_size);
641 return rf69_read_mod_write(spi, REG_SYNC_CONFIG,
642 MASK_SYNC_CONFIG_SYNC_SIZE,
646 int rf69_set_sync_values(struct spi_device *spi, u8 sync_values[8])
650 retval += rf69_write_reg(spi, REG_SYNCVALUE1, sync_values[0]);
651 retval += rf69_write_reg(spi, REG_SYNCVALUE2, sync_values[1]);
652 retval += rf69_write_reg(spi, REG_SYNCVALUE3, sync_values[2]);
653 retval += rf69_write_reg(spi, REG_SYNCVALUE4, sync_values[3]);
654 retval += rf69_write_reg(spi, REG_SYNCVALUE5, sync_values[4]);
655 retval += rf69_write_reg(spi, REG_SYNCVALUE6, sync_values[5]);
656 retval += rf69_write_reg(spi, REG_SYNCVALUE7, sync_values[6]);
657 retval += rf69_write_reg(spi, REG_SYNCVALUE8, sync_values[7]);
662 int rf69_set_packet_format(struct spi_device *spi,
663 enum packet_format packet_format)
665 switch (packet_format) {
666 case packet_length_var:
667 return rf69_set_bit(spi, REG_PACKETCONFIG1,
668 MASK_PACKETCONFIG1_PACKET_FORMAT_VARIABLE);
669 case packet_length_fix:
670 return rf69_clear_bit(spi, REG_PACKETCONFIG1,
671 MASK_PACKETCONFIG1_PACKET_FORMAT_VARIABLE);
673 dev_dbg(&spi->dev, "set: illegal packet format %u\n", packet_format);
678 int rf69_enable_crc(struct spi_device *spi)
680 return rf69_set_bit(spi, REG_PACKETCONFIG1, MASK_PACKETCONFIG1_CRC_ON);
683 int rf69_disable_crc(struct spi_device *spi)
685 return rf69_clear_bit(spi, REG_PACKETCONFIG1, MASK_PACKETCONFIG1_CRC_ON);
688 int rf69_set_address_filtering(struct spi_device *spi,
689 enum address_filtering address_filtering)
691 static const u8 af_map[] = {
692 [filtering_off] = PACKETCONFIG1_ADDRESSFILTERING_OFF,
693 [node_address] = PACKETCONFIG1_ADDRESSFILTERING_NODE,
694 [node_or_broadcast_address] =
695 PACKETCONFIG1_ADDRESSFILTERING_NODEBROADCAST,
698 if (unlikely(address_filtering >= ARRAY_SIZE(af_map))) {
699 dev_dbg(&spi->dev, "set: illegal address filtering %u\n", address_filtering);
703 return rf69_read_mod_write(spi, REG_PACKETCONFIG1,
704 MASK_PACKETCONFIG1_ADDRESSFILTERING,
705 af_map[address_filtering]);
708 int rf69_set_payload_length(struct spi_device *spi, u8 payload_length)
710 return rf69_write_reg(spi, REG_PAYLOAD_LENGTH, payload_length);
713 int rf69_set_node_address(struct spi_device *spi, u8 node_address)
715 return rf69_write_reg(spi, REG_NODEADRS, node_address);
718 int rf69_set_broadcast_address(struct spi_device *spi, u8 broadcast_address)
720 return rf69_write_reg(spi, REG_BROADCASTADRS, broadcast_address);
723 int rf69_set_tx_start_condition(struct spi_device *spi,
724 enum tx_start_condition tx_start_condition)
726 switch (tx_start_condition) {
728 return rf69_clear_bit(spi, REG_FIFO_THRESH,
729 MASK_FIFO_THRESH_TXSTART);
731 return rf69_set_bit(spi, REG_FIFO_THRESH,
732 MASK_FIFO_THRESH_TXSTART);
734 dev_dbg(&spi->dev, "set: illegal tx start condition %u\n", tx_start_condition);
739 int rf69_set_fifo_threshold(struct spi_device *spi, u8 threshold)
743 /* check input value */
744 if (threshold & ~MASK_FIFO_THRESH_VALUE) {
745 dev_dbg(&spi->dev, "set: illegal fifo threshold %u\n", threshold);
750 retval = rf69_read_mod_write(spi, REG_FIFO_THRESH,
751 MASK_FIFO_THRESH_VALUE,
757 * access the fifo to activate new threshold
758 * retval (mis-) used as buffer here
760 return rf69_read_fifo(spi, (u8 *)&retval, 1);
763 int rf69_set_dagc(struct spi_device *spi, enum dagc dagc)
765 static const u8 dagc_map[] = {
766 [normal_mode] = DAGC_NORMAL,
767 [improve] = DAGC_IMPROVED_LOWBETA0,
768 [improve_for_low_modulation_index] = DAGC_IMPROVED_LOWBETA1,
771 if (unlikely(dagc >= ARRAY_SIZE(dagc_map))) {
772 dev_dbg(&spi->dev, "set: illegal dagc %u\n", dagc);
776 return rf69_write_reg(spi, REG_TESTDAGC, dagc_map[dagc]);
779 /*-------------------------------------------------------------------------*/
781 int rf69_read_fifo(struct spi_device *spi, u8 *buffer, unsigned int size)
784 struct spi_transfer transfer;
785 u8 local_buffer[FIFO_SIZE + 1] = {};
788 if (size > FIFO_SIZE) {
790 "read fifo: passed in buffer bigger then internal buffer\n");
794 /* prepare a bidirectional transfer */
795 local_buffer[0] = REG_FIFO;
796 memset(&transfer, 0, sizeof(transfer));
797 transfer.tx_buf = local_buffer;
798 transfer.rx_buf = local_buffer;
799 transfer.len = size + 1;
801 retval = spi_sync_transfer(spi, &transfer, 1);
803 /* print content read from fifo for debugging purposes */
804 for (i = 0; i < size; i++)
805 dev_dbg(&spi->dev, "%d - 0x%x\n", i, local_buffer[i + 1]);
807 memcpy(buffer, &local_buffer[1], size);
812 int rf69_write_fifo(struct spi_device *spi, u8 *buffer, unsigned int size)
815 u8 local_buffer[FIFO_SIZE + 1];
817 if (size > FIFO_SIZE) {
819 "write fifo: passed in buffer bigger then internal buffer\n");
823 local_buffer[0] = REG_FIFO | WRITE_BIT;
824 memcpy(&local_buffer[1], buffer, size);
826 /* print content written from fifo for debugging purposes */
827 for (i = 0; i < size; i++)
828 dev_dbg(&spi->dev, "%d - 0x%x\n", i, buffer[i]);
830 return spi_write(spi, local_buffer, size + 1);