clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/PortOut.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 - PortOut
slowness 0:c03cffe402df 2 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 3 */
slowness 0:c03cffe402df 4
slowness 0:c03cffe402df 5 #ifndef MBED_PORTOUT_H
slowness 0:c03cffe402df 6 #define MBED_PORTOUT_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #include "device.h"
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 #if DEVICE_PORTOUT
slowness 0:c03cffe402df 11
slowness 0:c03cffe402df 12 #include "platform.h"
slowness 0:c03cffe402df 13 #include "PinNames.h"
slowness 0:c03cffe402df 14 #include "Base.h"
slowness 0:c03cffe402df 15
slowness 0:c03cffe402df 16 #include "PortNames.h"
slowness 0:c03cffe402df 17
slowness 0:c03cffe402df 18 namespace mbed {
slowness 0:c03cffe402df 19 /* Class: PortOut
slowness 0:c03cffe402df 20 * A multiple pin digital out
slowness 0:c03cffe402df 21 *
slowness 0:c03cffe402df 22 * Example:
slowness 0:c03cffe402df 23 * > // Toggle all four LEDs
slowness 0:c03cffe402df 24 * >
slowness 0:c03cffe402df 25 * > #include "mbed.h"
slowness 0:c03cffe402df 26 * >
slowness 0:c03cffe402df 27 * > // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
slowness 0:c03cffe402df 28 * > #define LED_MASK 0x00B40000
slowness 0:c03cffe402df 29 * >
slowness 0:c03cffe402df 30 * > PortOut ledport(Port1, LED_MASK);
slowness 0:c03cffe402df 31 * >
slowness 0:c03cffe402df 32 * > int main() {
slowness 0:c03cffe402df 33 * > while(1) {
slowness 0:c03cffe402df 34 * > ledport = LED_MASK;
slowness 0:c03cffe402df 35 * > wait(1);
slowness 0:c03cffe402df 36 * > ledport = 0;
slowness 0:c03cffe402df 37 * > wait(1);
slowness 0:c03cffe402df 38 * > }
slowness 0:c03cffe402df 39 * > }
slowness 0:c03cffe402df 40 */
slowness 0:c03cffe402df 41 class PortOut {
slowness 0:c03cffe402df 42 public:
slowness 0:c03cffe402df 43
slowness 0:c03cffe402df 44 /* Constructor: PortOut
slowness 0:c03cffe402df 45 * Create an PortOut, connected to the specified port
slowness 0:c03cffe402df 46 *
slowness 0:c03cffe402df 47 * Variables:
slowness 0:c03cffe402df 48 * port - Port to connect to (Port0-Port5)
slowness 0:c03cffe402df 49 * mask - A bitmask to identify which bits in the port should be included (0 - ignore)
slowness 0:c03cffe402df 50 */
slowness 0:c03cffe402df 51 PortOut(PortName port, int mask = 0xFFFFFFFF);
slowness 0:c03cffe402df 52
slowness 0:c03cffe402df 53 /* Function: write
slowness 0:c03cffe402df 54 * Write the value to the output port
slowness 0:c03cffe402df 55 *
slowness 0:c03cffe402df 56 * Variables:
slowness 0:c03cffe402df 57 * value - An integer specifying a bit to write for every corresponding PortOut pin
slowness 0:c03cffe402df 58 */
slowness 0:c03cffe402df 59 void write(int value);
slowness 0:c03cffe402df 60
slowness 0:c03cffe402df 61 /* Function: read
slowness 0:c03cffe402df 62 * Read the value currently output on the port
slowness 0:c03cffe402df 63 *
slowness 0:c03cffe402df 64 * Variables:
slowness 0:c03cffe402df 65 * returns - An integer with each bit corresponding to associated PortOut pin setting
slowness 0:c03cffe402df 66 */
slowness 0:c03cffe402df 67 int read();
slowness 0:c03cffe402df 68
slowness 0:c03cffe402df 69 /* Function: operator=
slowness 0:c03cffe402df 70 * A shorthand for <write>
slowness 0:c03cffe402df 71 */
slowness 0:c03cffe402df 72 PortOut& operator= (int value) {
slowness 0:c03cffe402df 73 write(value);
slowness 0:c03cffe402df 74 return *this;
slowness 0:c03cffe402df 75 }
slowness 0:c03cffe402df 76
slowness 0:c03cffe402df 77 PortOut& operator= (PortOut& rhs) {
slowness 0:c03cffe402df 78 write(rhs.read());
slowness 0:c03cffe402df 79 return *this;
slowness 0:c03cffe402df 80 }
slowness 0:c03cffe402df 81
slowness 0:c03cffe402df 82 /* Function: operator int()
slowness 0:c03cffe402df 83 * A shorthand for <read>
slowness 0:c03cffe402df 84 */
slowness 0:c03cffe402df 85 operator int() {
slowness 0:c03cffe402df 86 return read();
slowness 0:c03cffe402df 87 }
slowness 0:c03cffe402df 88
slowness 0:c03cffe402df 89 private:
slowness 0:c03cffe402df 90 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
slowness 0:c03cffe402df 91 LPC_GPIO_TypeDef *_gpio;
slowness 0:c03cffe402df 92 #endif
slowness 0:c03cffe402df 93 PortName _port;
slowness 0:c03cffe402df 94 uint32_t _mask;
slowness 0:c03cffe402df 95 };
slowness 0:c03cffe402df 96
slowness 0:c03cffe402df 97 } // namespace mbed
slowness 0:c03cffe402df 98
slowness 0:c03cffe402df 99 #endif
slowness 0:c03cffe402df 100
slowness 0:c03cffe402df 101 #endif