clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/BusOut.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 - BusOut
slowness 0:c03cffe402df 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 3 */
slowness 0:c03cffe402df 4
slowness 0:c03cffe402df 5 #ifndef MBED_BUSOUT_H
slowness 0:c03cffe402df 6 #define MBED_BUSOUT_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #include "platform.h"
slowness 0:c03cffe402df 9 #include "PinNames.h"
slowness 0:c03cffe402df 10 #include "PeripheralNames.h"
slowness 0:c03cffe402df 11 #include "Base.h"
slowness 0:c03cffe402df 12 #include "DigitalOut.h"
slowness 0:c03cffe402df 13
slowness 0:c03cffe402df 14 namespace mbed {
slowness 0:c03cffe402df 15
slowness 0:c03cffe402df 16 /* Class: BusOut
slowness 0:c03cffe402df 17 * A digital output bus, used for setting the state of a collection of pins
slowness 0:c03cffe402df 18 */
slowness 0:c03cffe402df 19 class BusOut : public Base {
slowness 0:c03cffe402df 20
slowness 0:c03cffe402df 21 public:
slowness 0:c03cffe402df 22
slowness 0:c03cffe402df 23 /* Group: Configuration Methods */
slowness 0:c03cffe402df 24
slowness 0:c03cffe402df 25 /* Constructor: BusOut
slowness 0:c03cffe402df 26 * Create an BusOut, connected to the specified pins
slowness 0:c03cffe402df 27 *
slowness 0:c03cffe402df 28 * Variables:
slowness 0:c03cffe402df 29 * p<n> - DigitalOut pin to connect to bus bit <n> (p5-p30, NC)
slowness 0:c03cffe402df 30 *
slowness 0:c03cffe402df 31 * Note:
slowness 0:c03cffe402df 32 * It is only required to specify as many pin variables as is required
slowness 0:c03cffe402df 33 * for the bus; the rest will default to NC (not connected)
slowness 0:c03cffe402df 34 */
slowness 0:c03cffe402df 35 BusOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
slowness 0:c03cffe402df 36 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
slowness 0:c03cffe402df 37 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
slowness 0:c03cffe402df 38 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC,
slowness 0:c03cffe402df 39 const char *name = NULL);
slowness 0:c03cffe402df 40
slowness 0:c03cffe402df 41 BusOut(PinName pins[16], const char *name = NULL);
slowness 0:c03cffe402df 42
slowness 0:c03cffe402df 43 virtual ~BusOut();
slowness 0:c03cffe402df 44
slowness 0:c03cffe402df 45 /* Group: Access Methods */
slowness 0:c03cffe402df 46
slowness 0:c03cffe402df 47 /* Function: write
slowness 0:c03cffe402df 48 * Write the value to the output bus
slowness 0:c03cffe402df 49 *
slowness 0:c03cffe402df 50 * Variables:
slowness 0:c03cffe402df 51 * value - An integer specifying a bit to write for every corresponding DigitalOut pin
slowness 0:c03cffe402df 52 */
slowness 0:c03cffe402df 53 void write(int value);
slowness 0:c03cffe402df 54
slowness 0:c03cffe402df 55
slowness 0:c03cffe402df 56 /* Function: read
slowness 0:c03cffe402df 57 * Read the value currently output on the bus
slowness 0:c03cffe402df 58 *
slowness 0:c03cffe402df 59 * Variables:
slowness 0:c03cffe402df 60 * returns - An integer with each bit corresponding to associated DigitalOut pin setting
slowness 0:c03cffe402df 61 */
slowness 0:c03cffe402df 62 int read();
slowness 0:c03cffe402df 63
slowness 0:c03cffe402df 64 #ifdef MBED_OPERATORS
slowness 0:c03cffe402df 65 /* Group: Access Method Shorthand */
slowness 0:c03cffe402df 66
slowness 0:c03cffe402df 67 /* Function: operator=
slowness 0:c03cffe402df 68 * A shorthand for <write>
slowness 0:c03cffe402df 69 */
slowness 0:c03cffe402df 70 BusOut& operator= (int v);
slowness 0:c03cffe402df 71 BusOut& operator= (BusOut& rhs);
slowness 0:c03cffe402df 72
slowness 0:c03cffe402df 73 /* Function: operator int()
slowness 0:c03cffe402df 74 * A shorthand for <read>
slowness 0:c03cffe402df 75 */
slowness 0:c03cffe402df 76 operator int();
slowness 0:c03cffe402df 77 #endif
slowness 0:c03cffe402df 78
slowness 0:c03cffe402df 79 #ifdef MBED_RPC
slowness 0:c03cffe402df 80 virtual const struct rpc_method *get_rpc_methods();
slowness 0:c03cffe402df 81 static struct rpc_class *get_rpc_class();
slowness 0:c03cffe402df 82 #endif
slowness 0:c03cffe402df 83
slowness 0:c03cffe402df 84 protected:
slowness 0:c03cffe402df 85
slowness 0:c03cffe402df 86 DigitalOut* _pin[16];
slowness 0:c03cffe402df 87
slowness 0:c03cffe402df 88 #ifdef MBED_RPC
slowness 0:c03cffe402df 89 static void construct(const char *arguments, char *res);
slowness 0:c03cffe402df 90 #endif
slowness 0:c03cffe402df 91
slowness 0:c03cffe402df 92 };
slowness 0:c03cffe402df 93
slowness 0:c03cffe402df 94 } // namespace mbed
slowness 0:c03cffe402df 95
slowness 0:c03cffe402df 96 #endif
slowness 0:c03cffe402df 97