clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/SPI.h@0:c03cffe402df, 2016-02-03 (annotated)

Committer:
slowness
Date:
Wed Feb 03 14:01:53 2016 +0000
Revision:
0:c03cffe402df
Pour configurer les AX12 avec la carte NXP1768 sur les Pin 9 et 10

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:c03cffe402df 1 /* mbed Microcontroller Library - SPI
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_SPI_H
slowness 0:c03cffe402df 6 #define MBED_SPI_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #include "device.h"
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 #if DEVICE_SPI
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: SPI
slowness 0:c03cffe402df 20 * A SPI Master, used for communicating with SPI slave devices
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 * Most SPI devices will also require Chip Select and Reset signals. These
slowness 0:c03cffe402df 25 * can be controlled using <DigitalOut> pins
slowness 0:c03cffe402df 26 *
slowness 0:c03cffe402df 27 * Example:
slowness 0:c03cffe402df 28 * > // Send a byte to a SPI slave, and record the response
slowness 0:c03cffe402df 29 * >
slowness 0:c03cffe402df 30 * > #include "mbed.h"
slowness 0:c03cffe402df 31 * >
slowness 0:c03cffe402df 32 * > SPI device(p5, p6, p7); // mosi, miso, sclk
slowness 0:c03cffe402df 33 * >
slowness 0:c03cffe402df 34 * > int main() {
slowness 0:c03cffe402df 35 * > int response = device.write(0xFF);
slowness 0:c03cffe402df 36 * > }
slowness 0:c03cffe402df 37 */
slowness 0:c03cffe402df 38 class SPI : public Base {
slowness 0:c03cffe402df 39
slowness 0:c03cffe402df 40 public:
slowness 0:c03cffe402df 41
slowness 0:c03cffe402df 42 /* Constructor: SPI
slowness 0:c03cffe402df 43 * Create a SPI master connected to the specified pins
slowness 0:c03cffe402df 44 *
slowness 0:c03cffe402df 45 * Variables:
slowness 0:c03cffe402df 46 * mosi - SPI Master Out, Slave In pin
slowness 0:c03cffe402df 47 * miso - SPI Master In, Slave Out pin
slowness 0:c03cffe402df 48 * sclk - SPI Clock pin
slowness 0:c03cffe402df 49 * name - (optional) A string to identify the object
slowness 0:c03cffe402df 50 *
slowness 0:c03cffe402df 51 * Pin Options:
slowness 0:c03cffe402df 52 * (5, 6, 7) or (11, 12, 13)
slowness 0:c03cffe402df 53 *
slowness 0:c03cffe402df 54 * mosi or miso can be specfied as NC if not used
slowness 0:c03cffe402df 55 */
slowness 0:c03cffe402df 56 SPI(PinName mosi, PinName miso, PinName sclk, const char *name = NULL);
slowness 0:c03cffe402df 57
slowness 0:c03cffe402df 58 /* Function: format
slowness 0:c03cffe402df 59 * Configure the data transmission format
slowness 0:c03cffe402df 60 *
slowness 0:c03cffe402df 61 * Variables:
slowness 0:c03cffe402df 62 * bits - Number of bits per SPI frame (4 - 16)
slowness 0:c03cffe402df 63 * mode - Clock polarity and phase mode (0 - 3)
slowness 0:c03cffe402df 64 *
slowness 0:c03cffe402df 65 * > mode | POL PHA
slowness 0:c03cffe402df 66 * > -----+--------
slowness 0:c03cffe402df 67 * > 0 | 0 0
slowness 0:c03cffe402df 68 * > 1 | 0 1
slowness 0:c03cffe402df 69 * > 2 | 1 0
slowness 0:c03cffe402df 70 * > 3 | 1 1
slowness 0:c03cffe402df 71 */
slowness 0:c03cffe402df 72 void format(int bits, int mode = 0);
slowness 0:c03cffe402df 73
slowness 0:c03cffe402df 74 /* Function: frequency
slowness 0:c03cffe402df 75 * Set the spi bus clock frequency
slowness 0:c03cffe402df 76 *
slowness 0:c03cffe402df 77 * Variables:
slowness 0:c03cffe402df 78 * hz - SCLK frequency in hz (default = 1MHz)
slowness 0:c03cffe402df 79 */
slowness 0:c03cffe402df 80 void frequency(int hz = 1000000);
slowness 0:c03cffe402df 81
slowness 0:c03cffe402df 82 /* Function: write
slowness 0:c03cffe402df 83 * Write to the SPI Slave and return the response
slowness 0:c03cffe402df 84 *
slowness 0:c03cffe402df 85 * Variables:
slowness 0:c03cffe402df 86 * value - Data to be sent to the SPI slave
slowness 0:c03cffe402df 87 * returns - Response from the SPI slave
slowness 0:c03cffe402df 88 */
slowness 0:c03cffe402df 89 virtual int write(int value);
slowness 0:c03cffe402df 90
slowness 0:c03cffe402df 91
slowness 0:c03cffe402df 92 #ifdef MBED_RPC
slowness 0:c03cffe402df 93 virtual const struct rpc_method *get_rpc_methods();
slowness 0:c03cffe402df 94 static struct rpc_class *get_rpc_class();
slowness 0:c03cffe402df 95 #endif
slowness 0:c03cffe402df 96
slowness 0:c03cffe402df 97 protected:
slowness 0:c03cffe402df 98
slowness 0:c03cffe402df 99 SPIName _spi;
slowness 0:c03cffe402df 100
slowness 0:c03cffe402df 101 void aquire(void);
slowness 0:c03cffe402df 102 static SPI *_owner;
slowness 0:c03cffe402df 103 int _bits;
slowness 0:c03cffe402df 104 int _mode;
slowness 0:c03cffe402df 105 int _hz;
slowness 0:c03cffe402df 106
slowness 0:c03cffe402df 107 };
slowness 0:c03cffe402df 108
slowness 0:c03cffe402df 109 } // namespace mbed
slowness 0:c03cffe402df 110
slowness 0:c03cffe402df 111 #endif
slowness 0:c03cffe402df 112
slowness 0:c03cffe402df 113 #endif