EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

drivers/SPISlave.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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