Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/SPISlave.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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