CRAC Team / CRAC-Strat_2017-19-05-2017

strat des robots

Fork of CRAC-Strat_2017 by CRAC Team

mbed/PortOut.h@17:d1594579eec6, 2017-05-19 (annotated)

Committer:
ClementBreteau
Date:
Fri May 19 17:14:07 2017 +0000
Revision:
17:d1594579eec6
Parent:
0:ad97421fb1fb 
strat du robot, 19-05-2017, 19h

Who changed what in which revision?

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