Bernhard Filzmaier / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/PortIn.h@13:0645d8841f51, 2013-08-05 (annotated)

Committer:
bogdanm
Date:
Mon Aug 05 14:12:34 2013 +0300
Revision:
13:0645d8841f51
Parent:
10:3bc89ef62ce7 
Update mbed sources to revision 64

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 13:0645d8841f51 1 /* mbed Microcontroller Library
bogdanm 13:0645d8841f51 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 13:0645d8841f51 3 *
bogdanm 13:0645d8841f51 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 13:0645d8841f51 5 * you may not use this file except in compliance with the License.
bogdanm 13:0645d8841f51 6 * You may obtain a copy of the License at
bogdanm 13:0645d8841f51 7 *
bogdanm 13:0645d8841f51 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 13:0645d8841f51 9 *
bogdanm 13:0645d8841f51 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 13:0645d8841f51 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 13:0645d8841f51 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 13:0645d8841f51 13 * See the License for the specific language governing permissions and
bogdanm 13:0645d8841f51 14 * limitations under the License.
bogdanm 13:0645d8841f51 15 */
bogdanm 13:0645d8841f51 16 #ifndef MBED_PORTIN_H
bogdanm 13:0645d8841f51 17 #define MBED_PORTIN_H
bogdanm 13:0645d8841f51 18
bogdanm 13:0645d8841f51 19 #include "platform.h"
bogdanm 13:0645d8841f51 20
bogdanm 13:0645d8841f51 21 #if DEVICE_PORTIN
bogdanm 13:0645d8841f51 22
bogdanm 13:0645d8841f51 23 #include "port_api.h"
bogdanm 13:0645d8841f51 24
bogdanm 13:0645d8841f51 25 namespace mbed {
bogdanm 13:0645d8841f51 26
bogdanm 13:0645d8841f51 27 /** A multiple pin digital input
bogdanm 13:0645d8841f51 28 *
bogdanm 13:0645d8841f51 29 * Example:
bogdanm 13:0645d8841f51 30 * @code
bogdanm 13:0645d8841f51 31 * // Switch on an LED if any of mbed pins 21-26 is high
bogdanm 13:0645d8841f51 32 *
bogdanm 13:0645d8841f51 33 * #include "mbed.h"
bogdanm 13:0645d8841f51 34 *
bogdanm 13:0645d8841f51 35 * PortIn p(Port2, 0x0000003F); // p21-p26
bogdanm 13:0645d8841f51 36 * DigitalOut ind(LED4);
bogdanm 13:0645d8841f51 37 *
bogdanm 13:0645d8841f51 38 * int main() {
bogdanm 13:0645d8841f51 39 * while(1) {
bogdanm 13:0645d8841f51 40 * int pins = p.read();
bogdanm 13:0645d8841f51 41 * if(pins) {
bogdanm 13:0645d8841f51 42 * ind = 1;
bogdanm 13:0645d8841f51 43 * } else {
bogdanm 13:0645d8841f51 44 * ind = 0;
bogdanm 13:0645d8841f51 45 * }
bogdanm 13:0645d8841f51 46 * }
bogdanm 13:0645d8841f51 47 * }
bogdanm 13:0645d8841f51 48 * @endcode
bogdanm 13:0645d8841f51 49 */
bogdanm 13:0645d8841f51 50 class PortIn {
bogdanm 13:0645d8841f51 51 public:
bogdanm 13:0645d8841f51 52
bogdanm 13:0645d8841f51 53 /** Create an PortIn, connected to the specified port
bogdanm 13:0645d8841f51 54 *
bogdanm 13:0645d8841f51 55 * @param port Port to connect to (Port0-Port5)
bogdanm 13:0645d8841f51 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
bogdanm 13:0645d8841f51 57 */
bogdanm 13:0645d8841f51 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
bogdanm 13:0645d8841f51 59 port_init(&_port, port, mask, PIN_INPUT);
bogdanm 13:0645d8841f51 60 }
bogdanm 13:0645d8841f51 61
bogdanm 13:0645d8841f51 62 /** Read the value currently output on the port
bogdanm 13:0645d8841f51 63 *
bogdanm 13:0645d8841f51 64 * @returns
bogdanm 13:0645d8841f51 65 * An integer with each bit corresponding to associated port pin setting
bogdanm 13:0645d8841f51 66 */
bogdanm 13:0645d8841f51 67 int read() {
bogdanm 13:0645d8841f51 68 return port_read(&_port);
bogdanm 13:0645d8841f51 69 }
bogdanm 13:0645d8841f51 70
bogdanm 13:0645d8841f51 71 /** Set the input pin mode
bogdanm 13:0645d8841f51 72 *
bogdanm 13:0645d8841f51 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
bogdanm 13:0645d8841f51 74 */
bogdanm 13:0645d8841f51 75 void mode(PinMode mode) {
bogdanm 13:0645d8841f51 76 port_mode(&_port, mode);
bogdanm 13:0645d8841f51 77 }
bogdanm 13:0645d8841f51 78
bogdanm 13:0645d8841f51 79 /** A shorthand for read()
bogdanm 13:0645d8841f51 80 */
bogdanm 13:0645d8841f51 81 operator int() {
bogdanm 13:0645d8841f51 82 return read();
bogdanm 13:0645d8841f51 83 }
bogdanm 13:0645d8841f51 84
bogdanm 13:0645d8841f51 85 private:
bogdanm 13:0645d8841f51 86 port_t _port;
bogdanm 13:0645d8841f51 87 };
bogdanm 13:0645d8841f51 88
bogdanm 13:0645d8841f51 89 } // namespace mbed
bogdanm 13:0645d8841f51 90
bogdanm 13:0645d8841f51 91 #endif
bogdanm 13:0645d8841f51 92
bogdanm 13:0645d8841f51 93 #endif