Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/PortIn.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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