Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

PortIn.h@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
18:b3c9f16cbb96
Child:
28:667d61c9177b
New Libraries 11.11

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_PORTIN_H
simon.ford@mbed.co.uk 18:b3c9f16cbb96 6 #define MBED_PORTIN_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_PORTIN
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: PortIn
simon.ford@mbed.co.uk 18:b3c9f16cbb96 18 * A multiple pin digital input
simon.ford@mbed.co.uk 18:b3c9f16cbb96 19 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 20 * Example:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 21 * > // Switch on an LED if any of mbed pins 21-26 is high
simon.ford@mbed.co.uk 18:b3c9f16cbb96 22 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 23 * > #include "mbed.h"
simon.ford@mbed.co.uk 18:b3c9f16cbb96 24 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 25 * > PortIn p(Port2, 0x0000003F); // p21-p26
simon.ford@mbed.co.uk 18:b3c9f16cbb96 26 * > DigitalOut ind(LED4);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 27 * >
simon.ford@mbed.co.uk 18:b3c9f16cbb96 28 * > int main() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 29 * > while(1) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 30 * > int pins = p.read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 31 * > if(pins) {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 32 * > ind = 1;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 33 * > } else {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 34 * > ind = 0;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 35 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 36 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 37 * > }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 38 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 39 class PortIn {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 40 public:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 41
simon.ford@mbed.co.uk 18:b3c9f16cbb96 42 /* Constructor: PortIn
simon.ford@mbed.co.uk 18:b3c9f16cbb96 43 * Create an PortIn, connected to the specified port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 44 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 45 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 46 * port - Port to connect to (Port0-Port5)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 47 * mask - A bitmask to identify which bits in the port should be included (0 - ignore)
simon.ford@mbed.co.uk 18:b3c9f16cbb96 48 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 49 PortIn(PortName port, int mask = 0xFFFFFFFF);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 50
simon.ford@mbed.co.uk 18:b3c9f16cbb96 51 /* Function: read
simon.ford@mbed.co.uk 18:b3c9f16cbb96 52 * Read the value currently output on the port
simon.ford@mbed.co.uk 18:b3c9f16cbb96 53 *
simon.ford@mbed.co.uk 18:b3c9f16cbb96 54 * Variables:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 55 * returns - An integer with each bit corresponding to associated port pin setting
simon.ford@mbed.co.uk 18:b3c9f16cbb96 56 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 57 int read() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 58 return _gpio->FIOPIN & _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 59 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 60
simon.ford@mbed.co.uk 18:b3c9f16cbb96 61 /* Function: mode
simon.ford@mbed.co.uk 18:b3c9f16cbb96 62 * Set the input pin mode
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 * mode - PullUp, PullDown, PullNone, OpenDrain
simon.ford@mbed.co.uk 18:b3c9f16cbb96 66 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 67 void mode(PinMode mode);
simon.ford@mbed.co.uk 18:b3c9f16cbb96 68
simon.ford@mbed.co.uk 18:b3c9f16cbb96 69 /* Function: operator int()
simon.ford@mbed.co.uk 18:b3c9f16cbb96 70 * A shorthand for <read>
simon.ford@mbed.co.uk 18:b3c9f16cbb96 71 */
simon.ford@mbed.co.uk 18:b3c9f16cbb96 72 operator int() {
simon.ford@mbed.co.uk 18:b3c9f16cbb96 73 return read();
simon.ford@mbed.co.uk 18:b3c9f16cbb96 74 }
simon.ford@mbed.co.uk 18:b3c9f16cbb96 75
simon.ford@mbed.co.uk 18:b3c9f16cbb96 76 private:
simon.ford@mbed.co.uk 18:b3c9f16cbb96 77 LPC_GPIO_TypeDef *_gpio;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 78 PortName _port;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 79 uint32_t _mask;
simon.ford@mbed.co.uk 18:b3c9f16cbb96 80 };
simon.ford@mbed.co.uk 18:b3c9f16cbb96 81
simon.ford@mbed.co.uk 18:b3c9f16cbb96 82 } // namespace mbed
simon.ford@mbed.co.uk 18:b3c9f16cbb96 83
simon.ford@mbed.co.uk 18:b3c9f16cbb96 84 #endif
emilmont 27:7110ebee3484 85
emilmont 27:7110ebee3484 86 #endif