Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/PortIn.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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