Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

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