Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

drivers/PortIn.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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