clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/SPISlave.h@2:91b6646ea994, 2017-02-01 (annotated)

Committer:
clementlignie
Date:
Wed Feb 01 13:42:30 2017 +0000
Revision:
2:91b6646ea994
Parent:
0:c03cffe402df 
config AX12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:c03cffe402df 1 /* mbed Microcontroller Library - SPISlave
slowness 0:c03cffe402df 2 * Copyright (c) 2010-2011 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 3 */
slowness 0:c03cffe402df 4
slowness 0:c03cffe402df 5 #ifndef MBED_SPISLAVE_H
slowness 0:c03cffe402df 6 #define MBED_SPISLAVE_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #include "device.h"
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 #if DEVICE_SPISLAVE
slowness 0:c03cffe402df 11
slowness 0:c03cffe402df 12 #include "platform.h"
slowness 0:c03cffe402df 13 #include "PinNames.h"
slowness 0:c03cffe402df 14 #include "PeripheralNames.h"
slowness 0:c03cffe402df 15 #include "Base.h"
slowness 0:c03cffe402df 16
slowness 0:c03cffe402df 17 namespace mbed {
slowness 0:c03cffe402df 18
slowness 0:c03cffe402df 19 /* Class: SPISlave
slowness 0:c03cffe402df 20 * A SPI slave, used for communicating with a SPI Master device
slowness 0:c03cffe402df 21 *
slowness 0:c03cffe402df 22 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
slowness 0:c03cffe402df 23 *
slowness 0:c03cffe402df 24 * Example:
slowness 0:c03cffe402df 25 * > // Reply to a SPI master as slave
slowness 0:c03cffe402df 26 * >
slowness 0:c03cffe402df 27 * > #include "mbed.h"
slowness 0:c03cffe402df 28 * >
slowness 0:c03cffe402df 29 * > SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
slowness 0:c03cffe402df 30 * >
slowness 0:c03cffe402df 31 * > int main() {
slowness 0:c03cffe402df 32 * > device.reply(0x00); // Prime SPI with first reply
slowness 0:c03cffe402df 33 * > while(1) {
slowness 0:c03cffe402df 34 * > if(device.receive()) {
slowness 0:c03cffe402df 35 * > int v = device.read(); // Read byte from master
slowness 0:c03cffe402df 36 * > v = (v + 1) % 0x100; // Add one to it, modulo 256
slowness 0:c03cffe402df 37 * > device.reply(v); // Make this the next reply
slowness 0:c03cffe402df 38 * > }
slowness 0:c03cffe402df 39 * > }
slowness 0:c03cffe402df 40 * > }
slowness 0:c03cffe402df 41 */
slowness 0:c03cffe402df 42 class SPISlave : public Base {
slowness 0:c03cffe402df 43
slowness 0:c03cffe402df 44 public:
slowness 0:c03cffe402df 45
slowness 0:c03cffe402df 46 /* Constructor: SPI
slowness 0:c03cffe402df 47 * Create a SPI slave connected to the specified pins
slowness 0:c03cffe402df 48 *
slowness 0:c03cffe402df 49 * Variables:
slowness 0:c03cffe402df 50 * mosi - SPI Master Out, Slave In pin
slowness 0:c03cffe402df 51 * miso - SPI Master In, Slave Out pin
slowness 0:c03cffe402df 52 * sclk - SPI Clock pin
slowness 0:c03cffe402df 53 * ssel - SPI chip select pin
slowness 0:c03cffe402df 54 * name - (optional) A string to identify the object
slowness 0:c03cffe402df 55 *
slowness 0:c03cffe402df 56 * Pin Options:
slowness 0:c03cffe402df 57 * (5, 6, 7i, 8) or (11, 12, 13, 14)
slowness 0:c03cffe402df 58 *
slowness 0:c03cffe402df 59 * mosi or miso can be specfied as NC if not used
slowness 0:c03cffe402df 60 */
slowness 0:c03cffe402df 61 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel,
slowness 0:c03cffe402df 62 const char *name = NULL);
slowness 0:c03cffe402df 63
slowness 0:c03cffe402df 64 /* Function: format
slowness 0:c03cffe402df 65 * Configure the data transmission format
slowness 0:c03cffe402df 66 *
slowness 0:c03cffe402df 67 * Variables:
slowness 0:c03cffe402df 68 * bits - Number of bits per SPI frame (4 - 16)
slowness 0:c03cffe402df 69 * mode - Clock polarity and phase mode (0 - 3)
slowness 0:c03cffe402df 70 *
slowness 0:c03cffe402df 71 * > mode | POL PHA
slowness 0:c03cffe402df 72 * > -----+--------
slowness 0:c03cffe402df 73 * > 0 | 0 0
slowness 0:c03cffe402df 74 * > 1 | 0 1
slowness 0:c03cffe402df 75 * > 2 | 1 0
slowness 0:c03cffe402df 76 * > 3 | 1 1
slowness 0:c03cffe402df 77 */
slowness 0:c03cffe402df 78 void format(int bits, int mode = 0);
slowness 0:c03cffe402df 79
slowness 0:c03cffe402df 80 /* Function: frequency
slowness 0:c03cffe402df 81 * Set the spi bus clock frequency
slowness 0:c03cffe402df 82 *
slowness 0:c03cffe402df 83 * Variables:
slowness 0:c03cffe402df 84 * hz - SCLK frequency in hz (default = 1MHz)
slowness 0:c03cffe402df 85 */
slowness 0:c03cffe402df 86 void frequency(int hz = 1000000);
slowness 0:c03cffe402df 87
slowness 0:c03cffe402df 88 /* Function: receive
slowness 0:c03cffe402df 89 * Polls the SPI to see if data has been received
slowness 0:c03cffe402df 90 *
slowness 0:c03cffe402df 91 * Variables:
slowness 0:c03cffe402df 92 * returns - zero if no data, 1 otherwise
slowness 0:c03cffe402df 93 */
slowness 0:c03cffe402df 94 int receive(void);
slowness 0:c03cffe402df 95
slowness 0:c03cffe402df 96 /* Function: read
slowness 0:c03cffe402df 97 * Retrieve data from receive buffer as slave
slowness 0:c03cffe402df 98 *
slowness 0:c03cffe402df 99 * Variables:
slowness 0:c03cffe402df 100 * returns - the data in the receive buffer
slowness 0:c03cffe402df 101 */
slowness 0:c03cffe402df 102 int read(void);
slowness 0:c03cffe402df 103
slowness 0:c03cffe402df 104 /* Function: reply
slowness 0:c03cffe402df 105 * Fill the transmission buffer with the value to be written out
slowness 0:c03cffe402df 106 * as slave on the next received message from the master.
slowness 0:c03cffe402df 107 *
slowness 0:c03cffe402df 108 * Variables:
slowness 0:c03cffe402df 109 * value - the data to be transmitted next
slowness 0:c03cffe402df 110 */
slowness 0:c03cffe402df 111 void reply(int value);
slowness 0:c03cffe402df 112
slowness 0:c03cffe402df 113 protected:
slowness 0:c03cffe402df 114
slowness 0:c03cffe402df 115 SPIName _spi;
slowness 0:c03cffe402df 116
slowness 0:c03cffe402df 117 int _bits;
slowness 0:c03cffe402df 118 int _mode;
slowness 0:c03cffe402df 119 int _hz;
slowness 0:c03cffe402df 120
slowness 0:c03cffe402df 121 };
slowness 0:c03cffe402df 122
slowness 0:c03cffe402df 123 } // namespace mbed
slowness 0:c03cffe402df 124
slowness 0:c03cffe402df 125 #endif
slowness 0:c03cffe402df 126
slowness 0:c03cffe402df 127 #endif