Christopher Haster / mbed-hal

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.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/SPISlave.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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