clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/PortIn.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 - PortInOut
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_PORTIN_H
slowness 0:c03cffe402df 6 #define MBED_PORTIN_H
slowness 0:c03cffe402df 7
slowness 0:c03cffe402df 8 #include "device.h"
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 #if DEVICE_PORTIN
slowness 0:c03cffe402df 11
slowness 0:c03cffe402df 12 #include "PortNames.h"
slowness 0:c03cffe402df 13 #include "PinNames.h"
slowness 0:c03cffe402df 14
slowness 0:c03cffe402df 15 namespace mbed {
slowness 0:c03cffe402df 16
slowness 0:c03cffe402df 17 /* Class: PortIn
slowness 0:c03cffe402df 18 * A multiple pin digital input
slowness 0:c03cffe402df 19 *
slowness 0:c03cffe402df 20 * Example:
slowness 0:c03cffe402df 21 * > // Switch on an LED if any of mbed pins 21-26 is high
slowness 0:c03cffe402df 22 * >
slowness 0:c03cffe402df 23 * > #include "mbed.h"
slowness 0:c03cffe402df 24 * >
slowness 0:c03cffe402df 25 * > PortIn p(Port2, 0x0000003F); // p21-p26
slowness 0:c03cffe402df 26 * > DigitalOut ind(LED4);
slowness 0:c03cffe402df 27 * >
slowness 0:c03cffe402df 28 * > int main() {
slowness 0:c03cffe402df 29 * > while(1) {
slowness 0:c03cffe402df 30 * > int pins = p.read();
slowness 0:c03cffe402df 31 * > if(pins) {
slowness 0:c03cffe402df 32 * > ind = 1;
slowness 0:c03cffe402df 33 * > } else {
slowness 0:c03cffe402df 34 * > ind = 0;
slowness 0:c03cffe402df 35 * > }
slowness 0:c03cffe402df 36 * > }
slowness 0:c03cffe402df 37 * > }
slowness 0:c03cffe402df 38 */
slowness 0:c03cffe402df 39 class PortIn {
slowness 0:c03cffe402df 40 public:
slowness 0:c03cffe402df 41
slowness 0:c03cffe402df 42 /* Constructor: PortIn
slowness 0:c03cffe402df 43 * Create an PortIn, connected to the specified port
slowness 0:c03cffe402df 44 *
slowness 0:c03cffe402df 45 * Variables:
slowness 0:c03cffe402df 46 * port - Port to connect to (Port0-Port5)
slowness 0:c03cffe402df 47 * mask - A bitmask to identify which bits in the port should be included (0 - ignore)
slowness 0:c03cffe402df 48 */
slowness 0:c03cffe402df 49 PortIn(PortName port, int mask = 0xFFFFFFFF);
slowness 0:c03cffe402df 50
slowness 0:c03cffe402df 51 /* Function: read
slowness 0:c03cffe402df 52 * Read the value currently output on the port
slowness 0:c03cffe402df 53 *
slowness 0:c03cffe402df 54 * Variables:
slowness 0:c03cffe402df 55 * returns - An integer with each bit corresponding to associated port pin setting
slowness 0:c03cffe402df 56 */
slowness 0:c03cffe402df 57 int read();
slowness 0:c03cffe402df 58
slowness 0:c03cffe402df 59 /* Function: mode
slowness 0:c03cffe402df 60 * Set the input pin mode
slowness 0:c03cffe402df 61 *
slowness 0:c03cffe402df 62 * Variables:
slowness 0:c03cffe402df 63 * mode - PullUp, PullDown, PullNone, OpenDrain
slowness 0:c03cffe402df 64 */
slowness 0:c03cffe402df 65 void mode(PinMode mode);
slowness 0:c03cffe402df 66
slowness 0:c03cffe402df 67 /* Function: operator int()
slowness 0:c03cffe402df 68 * A shorthand for <read>
slowness 0:c03cffe402df 69 */
slowness 0:c03cffe402df 70 operator int() {
slowness 0:c03cffe402df 71 return read();
slowness 0:c03cffe402df 72 }
slowness 0:c03cffe402df 73
slowness 0:c03cffe402df 74 private:
slowness 0:c03cffe402df 75 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
slowness 0:c03cffe402df 76 LPC_GPIO_TypeDef *_gpio;
slowness 0:c03cffe402df 77 #endif
slowness 0:c03cffe402df 78 PortName _port;
slowness 0:c03cffe402df 79 uint32_t _mask;
slowness 0:c03cffe402df 80 };
slowness 0:c03cffe402df 81
slowness 0:c03cffe402df 82 } // namespace mbed
slowness 0:c03cffe402df 83
slowness 0:c03cffe402df 84 #endif
slowness 0:c03cffe402df 85
slowness 0:c03cffe402df 86 #endif