Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

PortIn.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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