jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

SPISlave.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

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