Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/drivers/PortIn.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

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