clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/SPIHalfDuplex.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 - SPIHalfDuplex
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_SPIHALFDUPLEX_H
slowness 0:c03cffe402df 6 #define MBED_SPIHALFDUPLEX_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 "SPI.h"
slowness 0:c03cffe402df 13
slowness 0:c03cffe402df 14 namespace mbed {
slowness 0:c03cffe402df 15
slowness 0:c03cffe402df 16 /* Class: SPIHalfDuplex
slowness 0:c03cffe402df 17 * A SPI half-duplex master, used for communicating with SPI slave devices
slowness 0:c03cffe402df 18 * over a shared data line.
slowness 0:c03cffe402df 19 *
slowness 0:c03cffe402df 20 * The default format is set to 8-bits for both master and slave, and a
slowness 0:c03cffe402df 21 * clock frequency of 1MHz
slowness 0:c03cffe402df 22 *
slowness 0:c03cffe402df 23 * Most SPI devies will also require Chip Select and Reset signals. These
slowness 0:c03cffe402df 24 * can be controlled using <DigitalOut> pins.
slowness 0:c03cffe402df 25 *
slowness 0:c03cffe402df 26 * Although this is for a shared data line, both MISO and MOSI are defined,
slowness 0:c03cffe402df 27 * and should be tied together externally to the mbed. This class handles
slowness 0:c03cffe402df 28 * the tri-stating of the MOSI pin.
slowness 0:c03cffe402df 29 *
slowness 0:c03cffe402df 30 * Example:
slowness 0:c03cffe402df 31 * > // Send a byte to a SPI half-duplex slave, and record the response
slowness 0:c03cffe402df 32 * >
slowness 0:c03cffe402df 33 * > #include "mbed.h"
slowness 0:c03cffe402df 34 * >
slowness 0:c03cffe402df 35 * > SPIHalfDuplex device(p5, p6, p7) // mosi, miso, sclk
slowness 0:c03cffe402df 36 * >
slowness 0:c03cffe402df 37 * > int main() {
slowness 0:c03cffe402df 38 * > int respone = device.write(0xAA);
slowness 0:c03cffe402df 39 * > }
slowness 0:c03cffe402df 40 */
slowness 0:c03cffe402df 41
slowness 0:c03cffe402df 42 class SPIHalfDuplex : public SPI {
slowness 0:c03cffe402df 43
slowness 0:c03cffe402df 44 public:
slowness 0:c03cffe402df 45
slowness 0:c03cffe402df 46 /* Constructor: SPIHalfDuplex
slowness 0:c03cffe402df 47 * Create a SPI half-duplex master 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 * name - (optional) A string to identify the object
slowness 0:c03cffe402df 54 *
slowness 0:c03cffe402df 55 * Pin Options:
slowness 0:c03cffe402df 56 * (5, 6, 7) or (11, 12, 13)
slowness 0:c03cffe402df 57 *
slowness 0:c03cffe402df 58 * mosi or miso can be specfied as NC if not used
slowness 0:c03cffe402df 59 */
slowness 0:c03cffe402df 60 SPIHalfDuplex(PinName mosi, PinName miso, PinName sclk,
slowness 0:c03cffe402df 61 const char *name = NULL);
slowness 0:c03cffe402df 62
slowness 0:c03cffe402df 63 #if 0 // Inherited from SPI - documentation only
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 #endif
slowness 0:c03cffe402df 88
slowness 0:c03cffe402df 89 /* Function: write
slowness 0:c03cffe402df 90 * Write to the SPI Slave and return the response
slowness 0:c03cffe402df 91 *
slowness 0:c03cffe402df 92 * Variables:
slowness 0:c03cffe402df 93 * value - Data to be sent to the SPI slave
slowness 0:c03cffe402df 94 * returns - Response from the SPI slave
slowness 0:c03cffe402df 95 */
slowness 0:c03cffe402df 96 virtual int write(int value);
slowness 0:c03cffe402df 97
slowness 0:c03cffe402df 98 /* Function: slave_format
slowness 0:c03cffe402df 99 * Set the number of databits expected from the slave, from 4-16
slowness 0:c03cffe402df 100 *
slowness 0:c03cffe402df 101 * Variables:
slowness 0:c03cffe402df 102 * sbits - Number of expected bits in the slave response
slowness 0:c03cffe402df 103 */
slowness 0:c03cffe402df 104 void slave_format(int sbits);
slowness 0:c03cffe402df 105
slowness 0:c03cffe402df 106 protected:
slowness 0:c03cffe402df 107 PinName _mosi;
slowness 0:c03cffe402df 108 PinName _miso;
slowness 0:c03cffe402df 109 int _sbits;
slowness 0:c03cffe402df 110
slowness 0:c03cffe402df 111 }; // End of class
slowness 0:c03cffe402df 112
slowness 0:c03cffe402df 113 } // End of namespace mbed
slowness 0:c03cffe402df 114
slowness 0:c03cffe402df 115 #endif
slowness 0:c03cffe402df 116
slowness 0:c03cffe402df 117 #endif