teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/PortIn.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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