Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/drivers/PortIn.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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