mbed library

Dependents:   Printf

Fork of mbed by mbed official

PortOut.h

Committer:
emilmont
Date:
2012-10-26
Revision:
43:e2ed12d17f06
Parent:
28:667d61c9177b
Child:
44:24d45a770a51

File content as of revision 43:e2ed12d17f06:

/* mbed Microcontroller Library - PortOut
 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
 */ 
 
#ifndef MBED_PORTOUT_H
#define MBED_PORTOUT_H

#include "device.h"

#if DEVICE_PORTOUT

#include "platform.h"
#include "PinNames.h"
#include "Base.h"

#include "PortNames.h"

namespace mbed {
/** A multiple pin digital out
 *
 * Example:
 * @code
 * // Toggle all four LEDs
 * 
 * #include "mbed.h"
 *
 * // LED1 = P1.18  LED2 = P1.20  LED3 = P1.21  LED4 = P1.23
 * #define LED_MASK 0x00B40000
 *
 * PortOut ledport(Port1, LED_MASK);
 *
 * int main() {
 *     while(1) {
 *         ledport = LED_MASK;
 *         wait(1);
 *         ledport = 0;
 *         wait(1);
 *     }
 * }
 * @endcode
 */  
class PortOut {
public:

    /** Create an PortOut, connected to the specified port
     *
     *  @param port Port to connect to (Port0-Port5)
     *  @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
     */ 
    PortOut(PortName port, int mask = 0xFFFFFFFF);

    /** Write the value to the output port
     *
     *  @param value An integer specifying a bit to write for every corresponding PortOut pin
     */    
    void write(int value);

    /** Read the value currently output on the port
     *
     *  @returns
     *    An integer with each bit corresponding to associated PortOut pin setting
     */
    int read();

    /** A shorthand for write()
     */    
    PortOut& operator= (int value) { 
        write(value);
        return *this;
    }
    
    PortOut& operator= (PortOut& rhs) { 
        write(rhs.read());
        return *this;
    }
    
    /** A shorthand for read()
     */
    operator int() { 
        return read();
    }

private:
#if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
    LPC_GPIO_TypeDef    *_gpio;
#endif
    PortName            _port;
    uint32_t            _mask;
};

} // namespace mbed

#endif

#endif