Kenji Arai / mbed-os_TYBLE16

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.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/SPISlave.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

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