ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

PortIn.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

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