Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/SPISlave.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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