Erik Fountain / NorAmMote_PA_Test

mbed library sources

Dependents:   PA_Boost_test

Fork of mbed-src by mbed official

api/PortIn.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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