the do / gr-peach-opencv-project

Opencv 3.1 project on GR-PEACH board

Fork of gr-peach-opencv-project by the do

drivers/PortIn.h@167:1657b442184c, 2017-06-29 (annotated)

Committer:
thedo
Date:
Thu Jun 29 11:01:39 2017 +0000
Revision:
167:1657b442184c
Opencv 3.1 project on GR-PEACH board, 4 apps

Who changed what in which revision?

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