Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/PortIn.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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