Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

PortOut.h@2:e9a661555b58, 2012-10-10 (annotated)

Committer:
emilmont
Date:
Wed Oct 10 14:14:12 2012 +0000
Revision:
2:e9a661555b58
Parent:
0:8024c367e29f
Child:
7:73c5efe92a6c
Add PWM and I2C implementation;

Who changed what in which revision?

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