Rahul Dahiya / Mbed OS STM32F7 Ethernet

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/drivers/SPISlave.h@0:fb8047b156bb, 2020-01-15 (annotated)

Committer:
rahul_dahiya
Date:
Wed Jan 15 15:57:15 2020 +0530
Revision:
0:fb8047b156bb
STM32F7 LWIP

Who changed what in which revision?

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