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