The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
drivers/SPISlave.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- 165:d1b4690b3f8b
- Child:
- 172:65be27845400
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 156:ff21514d8981 | 1 | /* mbed Microcontroller Library |
AnnaBridge | 156:ff21514d8981 | 2 | * Copyright (c) 2006-2013 ARM Limited |
AnnaBridge | 156:ff21514d8981 | 3 | * |
AnnaBridge | 156:ff21514d8981 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
AnnaBridge | 156:ff21514d8981 | 5 | * you may not use this file except in compliance with the License. |
AnnaBridge | 156:ff21514d8981 | 6 | * You may obtain a copy of the License at |
AnnaBridge | 156:ff21514d8981 | 7 | * |
AnnaBridge | 156:ff21514d8981 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
AnnaBridge | 156:ff21514d8981 | 9 | * |
AnnaBridge | 156:ff21514d8981 | 10 | * Unless required by applicable law or agreed to in writing, software |
AnnaBridge | 156:ff21514d8981 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
AnnaBridge | 156:ff21514d8981 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
AnnaBridge | 156:ff21514d8981 | 13 | * See the License for the specific language governing permissions and |
AnnaBridge | 156:ff21514d8981 | 14 | * limitations under the License. |
AnnaBridge | 156:ff21514d8981 | 15 | */ |
AnnaBridge | 156:ff21514d8981 | 16 | #ifndef MBED_SPISLAVE_H |
AnnaBridge | 156:ff21514d8981 | 17 | #define MBED_SPISLAVE_H |
AnnaBridge | 156:ff21514d8981 | 18 | |
AnnaBridge | 156:ff21514d8981 | 19 | #include "platform/platform.h" |
AnnaBridge | 156:ff21514d8981 | 20 | #include "platform/NonCopyable.h" |
AnnaBridge | 156:ff21514d8981 | 21 | |
AnnaBridge | 156:ff21514d8981 | 22 | #if defined (DEVICE_SPISLAVE) || defined(DOXYGEN_ONLY) |
AnnaBridge | 156:ff21514d8981 | 23 | |
AnnaBridge | 156:ff21514d8981 | 24 | #include "hal/spi_api.h" |
AnnaBridge | 156:ff21514d8981 | 25 | |
AnnaBridge | 156:ff21514d8981 | 26 | namespace mbed { |
AnnaBridge | 156:ff21514d8981 | 27 | /** \addtogroup drivers */ |
AnnaBridge | 156:ff21514d8981 | 28 | |
AnnaBridge | 171:3a7713b1edbc | 29 | /** A SPI slave, used for communicating with a SPI master device. |
AnnaBridge | 156:ff21514d8981 | 30 | * |
AnnaBridge | 171:3a7713b1edbc | 31 | * The default format is set to 8 bits, mode 0 and a clock frequency of 1MHz. |
AnnaBridge | 156:ff21514d8981 | 32 | * |
AnnaBridge | 156:ff21514d8981 | 33 | * @note Synchronization level: Not protected |
AnnaBridge | 156:ff21514d8981 | 34 | * |
AnnaBridge | 171:3a7713b1edbc | 35 | * Example of how to reply to a SPI master as slave: |
AnnaBridge | 156:ff21514d8981 | 36 | * @code |
AnnaBridge | 156:ff21514d8981 | 37 | * |
AnnaBridge | 156:ff21514d8981 | 38 | * #include "mbed.h" |
AnnaBridge | 156:ff21514d8981 | 39 | * |
AnnaBridge | 171:3a7713b1edbc | 40 | * SPISlave device(SPI_MOSI, SPI_MISO, SPI_SCLK, SPI_CS); |
AnnaBridge | 156:ff21514d8981 | 41 | * |
AnnaBridge | 156:ff21514d8981 | 42 | * int main() { |
AnnaBridge | 156:ff21514d8981 | 43 | * device.reply(0x00); // Prime SPI with first reply |
AnnaBridge | 156:ff21514d8981 | 44 | * while(1) { |
AnnaBridge | 156:ff21514d8981 | 45 | * if(device.receive()) { |
AnnaBridge | 156:ff21514d8981 | 46 | * int v = device.read(); // Read byte from master |
AnnaBridge | 156:ff21514d8981 | 47 | * v = (v + 1) % 0x100; // Add one to it, modulo 256 |
AnnaBridge | 156:ff21514d8981 | 48 | * device.reply(v); // Make this the next reply |
AnnaBridge | 156:ff21514d8981 | 49 | * } |
AnnaBridge | 156:ff21514d8981 | 50 | * } |
AnnaBridge | 156:ff21514d8981 | 51 | * } |
AnnaBridge | 156:ff21514d8981 | 52 | * @endcode |
AnnaBridge | 156:ff21514d8981 | 53 | * @ingroup drivers |
AnnaBridge | 156:ff21514d8981 | 54 | */ |
AnnaBridge | 156:ff21514d8981 | 55 | class SPISlave : private NonCopyable<SPISlave> { |
AnnaBridge | 156:ff21514d8981 | 56 | |
AnnaBridge | 156:ff21514d8981 | 57 | public: |
AnnaBridge | 156:ff21514d8981 | 58 | |
AnnaBridge | 171:3a7713b1edbc | 59 | /** Create a SPI slave connected to the specified pins. |
AnnaBridge | 156:ff21514d8981 | 60 | * |
AnnaBridge | 171:3a7713b1edbc | 61 | * @note Either mosi or miso can be specified as NC if not used. |
AnnaBridge | 156:ff21514d8981 | 62 | * |
AnnaBridge | 171:3a7713b1edbc | 63 | * @param mosi SPI Master Out, Slave In pin. |
AnnaBridge | 171:3a7713b1edbc | 64 | * @param miso SPI Master In, Slave Out pin. |
AnnaBridge | 171:3a7713b1edbc | 65 | * @param sclk SPI Clock pin. |
AnnaBridge | 171:3a7713b1edbc | 66 | * @param ssel SPI Chip Select pin. |
AnnaBridge | 156:ff21514d8981 | 67 | */ |
AnnaBridge | 156:ff21514d8981 | 68 | SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel); |
AnnaBridge | 156:ff21514d8981 | 69 | |
AnnaBridge | 171:3a7713b1edbc | 70 | /** Configure the data transmission format. |
AnnaBridge | 156:ff21514d8981 | 71 | * |
AnnaBridge | 171:3a7713b1edbc | 72 | * @param bits Number of bits per SPI frame (4 - 16). |
AnnaBridge | 171:3a7713b1edbc | 73 | * @param mode Clock polarity and phase mode (0 - 3). |
AnnaBridge | 156:ff21514d8981 | 74 | * |
AnnaBridge | 156:ff21514d8981 | 75 | * @code |
AnnaBridge | 156:ff21514d8981 | 76 | * mode | POL PHA |
AnnaBridge | 156:ff21514d8981 | 77 | * -----+-------- |
AnnaBridge | 156:ff21514d8981 | 78 | * 0 | 0 0 |
AnnaBridge | 156:ff21514d8981 | 79 | * 1 | 0 1 |
AnnaBridge | 156:ff21514d8981 | 80 | * 2 | 1 0 |
AnnaBridge | 156:ff21514d8981 | 81 | * 3 | 1 1 |
AnnaBridge | 156:ff21514d8981 | 82 | * @endcode |
AnnaBridge | 156:ff21514d8981 | 83 | */ |
AnnaBridge | 156:ff21514d8981 | 84 | void format(int bits, int mode = 0); |
AnnaBridge | 156:ff21514d8981 | 85 | |
AnnaBridge | 171:3a7713b1edbc | 86 | /** Set the SPI bus clock frequency. |
AnnaBridge | 156:ff21514d8981 | 87 | * |
AnnaBridge | 171:3a7713b1edbc | 88 | * @param hz Clock frequency in hz (default = 1MHz). |
AnnaBridge | 156:ff21514d8981 | 89 | */ |
AnnaBridge | 156:ff21514d8981 | 90 | void frequency(int hz = 1000000); |
AnnaBridge | 156:ff21514d8981 | 91 | |
AnnaBridge | 171:3a7713b1edbc | 92 | /** Polls the SPI to see if data has been received. |
AnnaBridge | 156:ff21514d8981 | 93 | * |
AnnaBridge | 171:3a7713b1edbc | 94 | * @return Presence of received data. |
AnnaBridge | 171:3a7713b1edbc | 95 | * @retval 0 No data waiting. |
AnnaBridge | 171:3a7713b1edbc | 96 | * @retval 1 Data waiting. |
AnnaBridge | 156:ff21514d8981 | 97 | */ |
AnnaBridge | 156:ff21514d8981 | 98 | int receive(void); |
AnnaBridge | 156:ff21514d8981 | 99 | |
AnnaBridge | 171:3a7713b1edbc | 100 | /** Retrieve data from receive buffer as slave. |
AnnaBridge | 156:ff21514d8981 | 101 | * |
AnnaBridge | 171:3a7713b1edbc | 102 | * @return The data in the receive buffer. |
AnnaBridge | 156:ff21514d8981 | 103 | */ |
AnnaBridge | 156:ff21514d8981 | 104 | int read(void); |
AnnaBridge | 156:ff21514d8981 | 105 | |
AnnaBridge | 156:ff21514d8981 | 106 | /** Fill the transmission buffer with the value to be written out |
AnnaBridge | 156:ff21514d8981 | 107 | * as slave on the next received message from the master. |
AnnaBridge | 156:ff21514d8981 | 108 | * |
AnnaBridge | 171:3a7713b1edbc | 109 | * @param value The data to be transmitted next. |
AnnaBridge | 156:ff21514d8981 | 110 | */ |
AnnaBridge | 156:ff21514d8981 | 111 | void reply(int value); |
AnnaBridge | 156:ff21514d8981 | 112 | |
AnnaBridge | 171:3a7713b1edbc | 113 | #if !defined(DOXYGEN_ONLY) |
AnnaBridge | 171:3a7713b1edbc | 114 | |
AnnaBridge | 156:ff21514d8981 | 115 | protected: |
AnnaBridge | 171:3a7713b1edbc | 116 | /* Internal SPI object identifying the resources */ |
AnnaBridge | 156:ff21514d8981 | 117 | spi_t _spi; |
AnnaBridge | 156:ff21514d8981 | 118 | |
AnnaBridge | 171:3a7713b1edbc | 119 | /* How many bits in an SPI frame */ |
AnnaBridge | 156:ff21514d8981 | 120 | int _bits; |
AnnaBridge | 171:3a7713b1edbc | 121 | /* Clock phase and polarity */ |
AnnaBridge | 156:ff21514d8981 | 122 | int _mode; |
AnnaBridge | 171:3a7713b1edbc | 123 | /* Clock frequency */ |
AnnaBridge | 156:ff21514d8981 | 124 | int _hz; |
AnnaBridge | 171:3a7713b1edbc | 125 | |
AnnaBridge | 171:3a7713b1edbc | 126 | #endif //!defined(DOXYGEN_ONLY) |
AnnaBridge | 156:ff21514d8981 | 127 | }; |
AnnaBridge | 156:ff21514d8981 | 128 | |
AnnaBridge | 156:ff21514d8981 | 129 | } // namespace mbed |
AnnaBridge | 156:ff21514d8981 | 130 | |
AnnaBridge | 156:ff21514d8981 | 131 | #endif |
AnnaBridge | 156:ff21514d8981 | 132 | |
AnnaBridge | 156:ff21514d8981 | 133 | #endif |