Mbed SDK for XRange SX1272 LoRa module
Dependents: XRangePingPong XRange-LoRaWAN-lmic-app lora-transceiver
SX1272 LoRa RF module
https://www.netblocks.eu/xrange-sx1272-lora-datasheet/
api/SPISlave.h@339:ac6f3fd999f3, 2016-01-07 (annotated)
- Committer:
- netblocks
- Date:
- Thu Jan 07 13:01:25 2016 +0000
- Revision:
- 339:ac6f3fd999f3
- Parent:
- 336:1e18a06a987b
HSE_VALUE set for XTAL 16Mhz
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
dudmuck | 336:1e18a06a987b | 1 | /* mbed Microcontroller Library |
dudmuck | 336:1e18a06a987b | 2 | * Copyright (c) 2006-2013 ARM Limited |
dudmuck | 336:1e18a06a987b | 3 | * |
dudmuck | 336:1e18a06a987b | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
dudmuck | 336:1e18a06a987b | 5 | * you may not use this file except in compliance with the License. |
dudmuck | 336:1e18a06a987b | 6 | * You may obtain a copy of the License at |
dudmuck | 336:1e18a06a987b | 7 | * |
dudmuck | 336:1e18a06a987b | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
dudmuck | 336:1e18a06a987b | 9 | * |
dudmuck | 336:1e18a06a987b | 10 | * Unless required by applicable law or agreed to in writing, software |
dudmuck | 336:1e18a06a987b | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
dudmuck | 336:1e18a06a987b | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
dudmuck | 336:1e18a06a987b | 13 | * See the License for the specific language governing permissions and |
dudmuck | 336:1e18a06a987b | 14 | * limitations under the License. |
dudmuck | 336:1e18a06a987b | 15 | */ |
dudmuck | 336:1e18a06a987b | 16 | #ifndef MBED_SPISLAVE_H |
dudmuck | 336:1e18a06a987b | 17 | #define MBED_SPISLAVE_H |
dudmuck | 336:1e18a06a987b | 18 | |
dudmuck | 336:1e18a06a987b | 19 | #include "platform.h" |
dudmuck | 336:1e18a06a987b | 20 | |
dudmuck | 336:1e18a06a987b | 21 | #if DEVICE_SPISLAVE |
dudmuck | 336:1e18a06a987b | 22 | |
dudmuck | 336:1e18a06a987b | 23 | #include "spi_api.h" |
dudmuck | 336:1e18a06a987b | 24 | |
dudmuck | 336:1e18a06a987b | 25 | namespace mbed { |
dudmuck | 336:1e18a06a987b | 26 | |
dudmuck | 336:1e18a06a987b | 27 | /** A SPI slave, used for communicating with a SPI Master device |
dudmuck | 336:1e18a06a987b | 28 | * |
dudmuck | 336:1e18a06a987b | 29 | * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz |
dudmuck | 336:1e18a06a987b | 30 | * |
dudmuck | 336:1e18a06a987b | 31 | * Example: |
dudmuck | 336:1e18a06a987b | 32 | * @code |
dudmuck | 336:1e18a06a987b | 33 | * // Reply to a SPI master as slave |
dudmuck | 336:1e18a06a987b | 34 | * |
dudmuck | 336:1e18a06a987b | 35 | * #include "mbed.h" |
dudmuck | 336:1e18a06a987b | 36 | * |
dudmuck | 336:1e18a06a987b | 37 | * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel |
dudmuck | 336:1e18a06a987b | 38 | * |
dudmuck | 336:1e18a06a987b | 39 | * int main() { |
dudmuck | 336:1e18a06a987b | 40 | * device.reply(0x00); // Prime SPI with first reply |
dudmuck | 336:1e18a06a987b | 41 | * while(1) { |
dudmuck | 336:1e18a06a987b | 42 | * if(device.receive()) { |
dudmuck | 336:1e18a06a987b | 43 | * int v = device.read(); // Read byte from master |
dudmuck | 336:1e18a06a987b | 44 | * v = (v + 1) % 0x100; // Add one to it, modulo 256 |
dudmuck | 336:1e18a06a987b | 45 | * device.reply(v); // Make this the next reply |
dudmuck | 336:1e18a06a987b | 46 | * } |
dudmuck | 336:1e18a06a987b | 47 | * } |
dudmuck | 336:1e18a06a987b | 48 | * } |
dudmuck | 336:1e18a06a987b | 49 | * @endcode |
dudmuck | 336:1e18a06a987b | 50 | */ |
dudmuck | 336:1e18a06a987b | 51 | class SPISlave { |
dudmuck | 336:1e18a06a987b | 52 | |
dudmuck | 336:1e18a06a987b | 53 | public: |
dudmuck | 336:1e18a06a987b | 54 | |
dudmuck | 336:1e18a06a987b | 55 | /** Create a SPI slave connected to the specified pins |
dudmuck | 336:1e18a06a987b | 56 | * |
dudmuck | 336:1e18a06a987b | 57 | * Pin Options: |
dudmuck | 336:1e18a06a987b | 58 | * (5, 6, 7i, 8) or (11, 12, 13, 14) |
dudmuck | 336:1e18a06a987b | 59 | * |
dudmuck | 336:1e18a06a987b | 60 | * mosi or miso can be specfied as NC if not used |
dudmuck | 336:1e18a06a987b | 61 | * |
dudmuck | 336:1e18a06a987b | 62 | * @param mosi SPI Master Out, Slave In pin |
dudmuck | 336:1e18a06a987b | 63 | * @param miso SPI Master In, Slave Out pin |
dudmuck | 336:1e18a06a987b | 64 | * @param sclk SPI Clock pin |
dudmuck | 336:1e18a06a987b | 65 | * @param ssel SPI chip select pin |
dudmuck | 336:1e18a06a987b | 66 | * @param name (optional) A string to identify the object |
dudmuck | 336:1e18a06a987b | 67 | */ |
dudmuck | 336:1e18a06a987b | 68 | SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel); |
dudmuck | 336:1e18a06a987b | 69 | |
dudmuck | 336:1e18a06a987b | 70 | /** Configure the data transmission format |
dudmuck | 336:1e18a06a987b | 71 | * |
dudmuck | 336:1e18a06a987b | 72 | * @param bits Number of bits per SPI frame (4 - 16) |
dudmuck | 336:1e18a06a987b | 73 | * @param mode Clock polarity and phase mode (0 - 3) |
dudmuck | 336:1e18a06a987b | 74 | * |
dudmuck | 336:1e18a06a987b | 75 | * @code |
dudmuck | 336:1e18a06a987b | 76 | * mode | POL PHA |
dudmuck | 336:1e18a06a987b | 77 | * -----+-------- |
dudmuck | 336:1e18a06a987b | 78 | * 0 | 0 0 |
dudmuck | 336:1e18a06a987b | 79 | * 1 | 0 1 |
dudmuck | 336:1e18a06a987b | 80 | * 2 | 1 0 |
dudmuck | 336:1e18a06a987b | 81 | * 3 | 1 1 |
dudmuck | 336:1e18a06a987b | 82 | * @endcode |
dudmuck | 336:1e18a06a987b | 83 | */ |
dudmuck | 336:1e18a06a987b | 84 | void format(int bits, int mode = 0); |
dudmuck | 336:1e18a06a987b | 85 | |
dudmuck | 336:1e18a06a987b | 86 | /** Set the spi bus clock frequency |
dudmuck | 336:1e18a06a987b | 87 | * |
dudmuck | 336:1e18a06a987b | 88 | * @param hz SCLK frequency in hz (default = 1MHz) |
dudmuck | 336:1e18a06a987b | 89 | */ |
dudmuck | 336:1e18a06a987b | 90 | void frequency(int hz = 1000000); |
dudmuck | 336:1e18a06a987b | 91 | |
dudmuck | 336:1e18a06a987b | 92 | /** Polls the SPI to see if data has been received |
dudmuck | 336:1e18a06a987b | 93 | * |
dudmuck | 336:1e18a06a987b | 94 | * @returns |
dudmuck | 336:1e18a06a987b | 95 | * 0 if no data, |
dudmuck | 336:1e18a06a987b | 96 | * 1 otherwise |
dudmuck | 336:1e18a06a987b | 97 | */ |
dudmuck | 336:1e18a06a987b | 98 | int receive(void); |
dudmuck | 336:1e18a06a987b | 99 | |
dudmuck | 336:1e18a06a987b | 100 | /** Retrieve data from receive buffer as slave |
dudmuck | 336:1e18a06a987b | 101 | * |
dudmuck | 336:1e18a06a987b | 102 | * @returns |
dudmuck | 336:1e18a06a987b | 103 | * the data in the receive buffer |
dudmuck | 336:1e18a06a987b | 104 | */ |
dudmuck | 336:1e18a06a987b | 105 | int read(void); |
dudmuck | 336:1e18a06a987b | 106 | |
dudmuck | 336:1e18a06a987b | 107 | /** Fill the transmission buffer with the value to be written out |
dudmuck | 336:1e18a06a987b | 108 | * as slave on the next received message from the master. |
dudmuck | 336:1e18a06a987b | 109 | * |
dudmuck | 336:1e18a06a987b | 110 | * @param value the data to be transmitted next |
dudmuck | 336:1e18a06a987b | 111 | */ |
dudmuck | 336:1e18a06a987b | 112 | void reply(int value); |
dudmuck | 336:1e18a06a987b | 113 | |
dudmuck | 336:1e18a06a987b | 114 | protected: |
dudmuck | 336:1e18a06a987b | 115 | spi_t _spi; |
dudmuck | 336:1e18a06a987b | 116 | |
dudmuck | 336:1e18a06a987b | 117 | int _bits; |
dudmuck | 336:1e18a06a987b | 118 | int _mode; |
dudmuck | 336:1e18a06a987b | 119 | int _hz; |
dudmuck | 336:1e18a06a987b | 120 | }; |
dudmuck | 336:1e18a06a987b | 121 | |
dudmuck | 336:1e18a06a987b | 122 | } // namespace mbed |
dudmuck | 336:1e18a06a987b | 123 | |
dudmuck | 336:1e18a06a987b | 124 | #endif |
dudmuck | 336:1e18a06a987b | 125 | |
dudmuck | 336:1e18a06a987b | 126 | #endif |