frederic blanc / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed by mbed official

PortOut.h@43:e2ed12d17f06, 2012-10-26 (annotated)

Committer:
emilmont
Date:
Fri Oct 26 17:40:46 2012 +0100
Revision:
43:e2ed12d17f06
Parent:
28:667d61c9177b
Child:
44:24d45a770a51
Update documentation

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