joey shelton / LED_Demo2

dhgdh

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by joey shelton

mbd_os/hal/api/PortIn.h@9:6bb35cef007d, 2016-10-22 (annotated)

Committer:
cyberjoey
Date:
Sat Oct 22 01:31:58 2016 +0000
Revision:
9:6bb35cef007d
Parent:
1:55a6170b404f 
WORKING

Who changed what in which revision?

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