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/SPI.h@336:1e18a06a987b, 2015-01-15 (annotated)
- Committer:
- dudmuck
- Date:
- Thu Jan 15 02:25:40 2015 +0000
- Revision:
- 336:1e18a06a987b
updated to rev443 of official mbed-src
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_SPI_H |
dudmuck | 336:1e18a06a987b | 17 | #define MBED_SPI_H |
dudmuck | 336:1e18a06a987b | 18 | |
dudmuck | 336:1e18a06a987b | 19 | #include "platform.h" |
dudmuck | 336:1e18a06a987b | 20 | |
dudmuck | 336:1e18a06a987b | 21 | #if DEVICE_SPI |
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 Master, used for communicating with SPI slave devices |
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 | * Most SPI devices will also require Chip Select and Reset signals. These |
dudmuck | 336:1e18a06a987b | 32 | * can be controlled using <DigitalOut> pins |
dudmuck | 336:1e18a06a987b | 33 | * |
dudmuck | 336:1e18a06a987b | 34 | * Example: |
dudmuck | 336:1e18a06a987b | 35 | * @code |
dudmuck | 336:1e18a06a987b | 36 | * // Send a byte to a SPI slave, and record the response |
dudmuck | 336:1e18a06a987b | 37 | * |
dudmuck | 336:1e18a06a987b | 38 | * #include "mbed.h" |
dudmuck | 336:1e18a06a987b | 39 | * |
dudmuck | 336:1e18a06a987b | 40 | * SPI device(p5, p6, p7); // mosi, miso, sclk |
dudmuck | 336:1e18a06a987b | 41 | * |
dudmuck | 336:1e18a06a987b | 42 | * int main() { |
dudmuck | 336:1e18a06a987b | 43 | * int response = device.write(0xFF); |
dudmuck | 336:1e18a06a987b | 44 | * } |
dudmuck | 336:1e18a06a987b | 45 | * @endcode |
dudmuck | 336:1e18a06a987b | 46 | */ |
dudmuck | 336:1e18a06a987b | 47 | class SPI { |
dudmuck | 336:1e18a06a987b | 48 | |
dudmuck | 336:1e18a06a987b | 49 | public: |
dudmuck | 336:1e18a06a987b | 50 | |
dudmuck | 336:1e18a06a987b | 51 | /** Create a SPI master connected to the specified pins |
dudmuck | 336:1e18a06a987b | 52 | * |
dudmuck | 336:1e18a06a987b | 53 | * Pin Options: |
dudmuck | 336:1e18a06a987b | 54 | * (5, 6, 7) or (11, 12, 13) |
dudmuck | 336:1e18a06a987b | 55 | * |
dudmuck | 336:1e18a06a987b | 56 | * mosi or miso can be specfied as NC if not used |
dudmuck | 336:1e18a06a987b | 57 | * |
dudmuck | 336:1e18a06a987b | 58 | * @param mosi SPI Master Out, Slave In pin |
dudmuck | 336:1e18a06a987b | 59 | * @param miso SPI Master In, Slave Out pin |
dudmuck | 336:1e18a06a987b | 60 | * @param sclk SPI Clock pin |
dudmuck | 336:1e18a06a987b | 61 | */ |
dudmuck | 336:1e18a06a987b | 62 | SPI(PinName mosi, PinName miso, PinName sclk, PinName _unused=NC); |
dudmuck | 336:1e18a06a987b | 63 | |
dudmuck | 336:1e18a06a987b | 64 | /** Configure the data transmission format |
dudmuck | 336:1e18a06a987b | 65 | * |
dudmuck | 336:1e18a06a987b | 66 | * @param bits Number of bits per SPI frame (4 - 16) |
dudmuck | 336:1e18a06a987b | 67 | * @param mode Clock polarity and phase mode (0 - 3) |
dudmuck | 336:1e18a06a987b | 68 | * |
dudmuck | 336:1e18a06a987b | 69 | * @code |
dudmuck | 336:1e18a06a987b | 70 | * mode | POL PHA |
dudmuck | 336:1e18a06a987b | 71 | * -----+-------- |
dudmuck | 336:1e18a06a987b | 72 | * 0 | 0 0 |
dudmuck | 336:1e18a06a987b | 73 | * 1 | 0 1 |
dudmuck | 336:1e18a06a987b | 74 | * 2 | 1 0 |
dudmuck | 336:1e18a06a987b | 75 | * 3 | 1 1 |
dudmuck | 336:1e18a06a987b | 76 | * @endcode |
dudmuck | 336:1e18a06a987b | 77 | */ |
dudmuck | 336:1e18a06a987b | 78 | void format(int bits, int mode = 0); |
dudmuck | 336:1e18a06a987b | 79 | |
dudmuck | 336:1e18a06a987b | 80 | /** Set the spi bus clock frequency |
dudmuck | 336:1e18a06a987b | 81 | * |
dudmuck | 336:1e18a06a987b | 82 | * @param hz SCLK frequency in hz (default = 1MHz) |
dudmuck | 336:1e18a06a987b | 83 | */ |
dudmuck | 336:1e18a06a987b | 84 | void frequency(int hz = 1000000); |
dudmuck | 336:1e18a06a987b | 85 | |
dudmuck | 336:1e18a06a987b | 86 | /** Write to the SPI Slave and return the response |
dudmuck | 336:1e18a06a987b | 87 | * |
dudmuck | 336:1e18a06a987b | 88 | * @param value Data to be sent to the SPI slave |
dudmuck | 336:1e18a06a987b | 89 | * |
dudmuck | 336:1e18a06a987b | 90 | * @returns |
dudmuck | 336:1e18a06a987b | 91 | * Response from the SPI slave |
dudmuck | 336:1e18a06a987b | 92 | */ |
dudmuck | 336:1e18a06a987b | 93 | virtual int write(int value); |
dudmuck | 336:1e18a06a987b | 94 | |
dudmuck | 336:1e18a06a987b | 95 | public: |
dudmuck | 336:1e18a06a987b | 96 | virtual ~SPI() { |
dudmuck | 336:1e18a06a987b | 97 | } |
dudmuck | 336:1e18a06a987b | 98 | |
dudmuck | 336:1e18a06a987b | 99 | protected: |
dudmuck | 336:1e18a06a987b | 100 | spi_t _spi; |
dudmuck | 336:1e18a06a987b | 101 | |
dudmuck | 336:1e18a06a987b | 102 | void aquire(void); |
dudmuck | 336:1e18a06a987b | 103 | static SPI *_owner; |
dudmuck | 336:1e18a06a987b | 104 | int _bits; |
dudmuck | 336:1e18a06a987b | 105 | int _mode; |
dudmuck | 336:1e18a06a987b | 106 | int _hz; |
dudmuck | 336:1e18a06a987b | 107 | }; |
dudmuck | 336:1e18a06a987b | 108 | |
dudmuck | 336:1e18a06a987b | 109 | } // namespace mbed |
dudmuck | 336:1e18a06a987b | 110 | |
dudmuck | 336:1e18a06a987b | 111 | #endif |
dudmuck | 336:1e18a06a987b | 112 | |
dudmuck | 336:1e18a06a987b | 113 | #endif |