Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

PortInOut.h@92:f7fcbaa5f1b5, 2016-06-12 (annotated)

Committer:
mrsoundhar
Date:
Sun Jun 12 16:45:04 2016 +0000
Revision:
92:f7fcbaa5f1b5
Parent:
28:667d61c9177b
Child:
43:e2ed12d17f06
Soundharrajan

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 18:b3c9f16cbb96 1 /* mbed Microcontroller Library - PortInOut
emilmont 27:7110ebee3484 2 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
simon.ford@mbed.co.uk 18:b3c9f16cbb96 3 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 4
simon.ford@mbed.co.uk 18:b3c9f16cbb96 5 #ifndef MBED_PORTINOUT_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 6 #define MBED_PORTINOUT_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 7
emilmont 27:7110ebee3484 8 #include "device.h"
emilmont 27:7110ebee3484 9
emilmont 27:7110ebee3484 10 #if DEVICE_PORTINOUT
emilmont 27:7110ebee3484 11
simon.ford@mbed.co.uk 18:b3c9f16cbb96 12 #include "PortNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 13 #include "PinNames.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 14
simon.ford@mbed.co.uk 18:b3c9f16cbb96 15 namespace mbed {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 16
simon.ford@mbed.co.uk 18:b3c9f16cbb96 17 /* Class: PortInOut
simon.ford@mbed.co.uk 18:b3c9f16cbb96 18 * A multiple pin digital in/out used to set/read multiple bi-directional pins
simon.ford@mbed.co.uk 18:b3c9f16cbb96 19 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 20 class PortInOut {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 21 public:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 22
simon.ford@mbed.co.uk 18:b3c9f16cbb96 23 /* Constructor: PortInOut
simon.ford@mbed.co.uk 18:b3c9f16cbb96 24 * Create an PortInOut, connected to the specified port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 25 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 26 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 27 * port - Port to connect to (Port0-Port5)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 28 * mask - A bitmask to identify which bits in the port should be included (0 - ignore)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 29 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 30 PortInOut(PortName port, int mask = 0xFFFFFFFF);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 31
simon.ford@mbed.co.uk 18:b3c9f16cbb96 32 /* Function: write
simon.ford@mbed.co.uk 18:b3c9f16cbb96 33 * Write the value to the output port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 34 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 35 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 36 * value - An integer specifying a bit to write for every corresponding port pin
simon.ford@mbed.co.uk 18:b3c9f16cbb96 37 */
emilmont 28:667d61c9177b 38 void write(int value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 39
simon.ford@mbed.co.uk 18:b3c9f16cbb96 40 /* Function: read
simon.ford@mbed.co.uk 18:b3c9f16cbb96 41 * Read the value currently output on the port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 42 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 43 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 44 * returns - An integer with each bit corresponding to associated port pin setting
simon.ford@mbed.co.uk 18:b3c9f16cbb96 45 */
emilmont 28:667d61c9177b 46 int read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 47
simon.ford@mbed.co.uk 18:b3c9f16cbb96 48 /* Function: output
simon.ford@mbed.co.uk 18:b3c9f16cbb96 49 * Set as an output
simon.ford@mbed.co.uk 18:b3c9f16cbb96 50 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51 void output();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 52
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 /* Function: input
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 * Set as an input
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 56 void input();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57
simon.ford@mbed.co.uk 18:b3c9f16cbb96 58 /* Function: mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 59 * Set the input pin mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 60 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 61 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62 * mode - PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 18:b3c9f16cbb96 63 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 64 void mode(PinMode mode);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 65
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 /* Function: operator=
simon.ford@mbed.co.uk 18:b3c9f16cbb96 67 * A shorthand for <write>
simon.ford@mbed.co.uk 18:b3c9f16cbb96 68 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 69 PortInOut& operator= (int value) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 70 write(value);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 71 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 73
simon.ford@mbed.co.uk 18:b3c9f16cbb96 74 PortInOut& operator= (PortInOut& rhs) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 75 write(rhs.read());
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76 return *this;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 77 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78
simon.ford@mbed.co.uk 18:b3c9f16cbb96 79 /* Function: operator int()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 80 * A shorthand for <read>
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 83 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 84 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 85
simon.ford@mbed.co.uk 18:b3c9f16cbb96 86 private:
emilmont 28:667d61c9177b 87 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 88 LPC_GPIO_TypeDef *_gpio;
emilmont 28:667d61c9177b 89 #endif
simon.ford@mbed.co.uk 18:b3c9f16cbb96 90 PortName _port;
emilmont 28:667d61c9177b 91 uint32_t _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 92 };
simon.ford@mbed.co.uk 18:b3c9f16cbb96 93
simon.ford@mbed.co.uk 18:b3c9f16cbb96 94 } // namespace mbed
simon.ford@mbed.co.uk 18:b3c9f16cbb96 95
simon.ford@mbed.co.uk 18:b3c9f16cbb96 96 #endif
emilmont 27:7110ebee3484 97
emilmont 27:7110ebee3484 98 #endif