Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/SPISlave.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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