BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

mbed-os/drivers/SPISlave.h@1:9c5af431a1f1, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:47:08 2018 +0000
Revision:
1:9c5af431a1f1
sdf

Who changed what in which revision?

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