nguyen nam / SRC_STM32F7

SPKT

Dependents:   Player

api/BusIn.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:e87aa4c49e95 1 /* mbed Microcontroller Library
phungductung 0:e87aa4c49e95 2 * Copyright (c) 2006-2013 ARM Limited
phungductung 0:e87aa4c49e95 3 *
phungductung 0:e87aa4c49e95 4 * Licensed under the Apache License, Version 2.0 (the "License");
phungductung 0:e87aa4c49e95 5 * you may not use this file except in compliance with the License.
phungductung 0:e87aa4c49e95 6 * You may obtain a copy of the License at
phungductung 0:e87aa4c49e95 7 *
phungductung 0:e87aa4c49e95 8 * http://www.apache.org/licenses/LICENSE-2.0
phungductung 0:e87aa4c49e95 9 *
phungductung 0:e87aa4c49e95 10 * Unless required by applicable law or agreed to in writing, software
phungductung 0:e87aa4c49e95 11 * distributed under the License is distributed on an "AS IS" BASIS,
phungductung 0:e87aa4c49e95 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
phungductung 0:e87aa4c49e95 13 * See the License for the specific language governing permissions and
phungductung 0:e87aa4c49e95 14 * limitations under the License.
phungductung 0:e87aa4c49e95 15 */
phungductung 0:e87aa4c49e95 16 #ifndef MBED_BUSIN_H
phungductung 0:e87aa4c49e95 17 #define MBED_BUSIN_H
phungductung 0:e87aa4c49e95 18
phungductung 0:e87aa4c49e95 19 #include "platform.h"
phungductung 0:e87aa4c49e95 20 #include "DigitalIn.h"
phungductung 0:e87aa4c49e95 21
phungductung 0:e87aa4c49e95 22 namespace mbed {
phungductung 0:e87aa4c49e95 23
phungductung 0:e87aa4c49e95 24 /** A digital input bus, used for reading the state of a collection of pins
phungductung 0:e87aa4c49e95 25 */
phungductung 0:e87aa4c49e95 26 class BusIn {
phungductung 0:e87aa4c49e95 27
phungductung 0:e87aa4c49e95 28 public:
phungductung 0:e87aa4c49e95 29 /* Group: Configuration Methods */
phungductung 0:e87aa4c49e95 30
phungductung 0:e87aa4c49e95 31 /** Create an BusIn, connected to the specified pins
phungductung 0:e87aa4c49e95 32 *
phungductung 0:e87aa4c49e95 33 * @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
phungductung 0:e87aa4c49e95 34 *
phungductung 0:e87aa4c49e95 35 * @note
phungductung 0:e87aa4c49e95 36 * It is only required to specify as many pin variables as is required
phungductung 0:e87aa4c49e95 37 * for the bus; the rest will default to NC (not connected)
phungductung 0:e87aa4c49e95 38 */
phungductung 0:e87aa4c49e95 39 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
phungductung 0:e87aa4c49e95 40 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
phungductung 0:e87aa4c49e95 41 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
phungductung 0:e87aa4c49e95 42 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
phungductung 0:e87aa4c49e95 43
phungductung 0:e87aa4c49e95 44 BusIn(PinName pins[16]);
phungductung 0:e87aa4c49e95 45
phungductung 0:e87aa4c49e95 46 virtual ~BusIn();
phungductung 0:e87aa4c49e95 47
phungductung 0:e87aa4c49e95 48 /** Read the value of the input bus
phungductung 0:e87aa4c49e95 49 *
phungductung 0:e87aa4c49e95 50 * @returns
phungductung 0:e87aa4c49e95 51 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
phungductung 0:e87aa4c49e95 52 */
phungductung 0:e87aa4c49e95 53 int read();
phungductung 0:e87aa4c49e95 54
phungductung 0:e87aa4c49e95 55 /** Set the input pin mode
phungductung 0:e87aa4c49e95 56 *
phungductung 0:e87aa4c49e95 57 * @param mode PullUp, PullDown, PullNone
phungductung 0:e87aa4c49e95 58 */
phungductung 0:e87aa4c49e95 59 void mode(PinMode pull);
phungductung 0:e87aa4c49e95 60
phungductung 0:e87aa4c49e95 61 /** Binary mask of bus pins connected to actual pins (not NC pins)
phungductung 0:e87aa4c49e95 62 * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1
phungductung 0:e87aa4c49e95 63 *
phungductung 0:e87aa4c49e95 64 * @returns
phungductung 0:e87aa4c49e95 65 * Binary mask of connected pins
phungductung 0:e87aa4c49e95 66 */
phungductung 0:e87aa4c49e95 67 int mask() {
phungductung 0:e87aa4c49e95 68 return _nc_mask;
phungductung 0:e87aa4c49e95 69 }
phungductung 0:e87aa4c49e95 70
phungductung 0:e87aa4c49e95 71 #ifdef MBED_OPERATORS
phungductung 0:e87aa4c49e95 72 /** A shorthand for read()
phungductung 0:e87aa4c49e95 73 */
phungductung 0:e87aa4c49e95 74 operator int();
phungductung 0:e87aa4c49e95 75
phungductung 0:e87aa4c49e95 76 /** Access to particular bit in random-iterator fashion
phungductung 0:e87aa4c49e95 77 */
phungductung 0:e87aa4c49e95 78 DigitalIn & operator[] (int index);
phungductung 0:e87aa4c49e95 79 #endif
phungductung 0:e87aa4c49e95 80
phungductung 0:e87aa4c49e95 81 protected:
phungductung 0:e87aa4c49e95 82 DigitalIn* _pin[16];
phungductung 0:e87aa4c49e95 83
phungductung 0:e87aa4c49e95 84 /** Mask of bus's NC pins
phungductung 0:e87aa4c49e95 85 * If bit[n] is set to 1 - pin is connected
phungductung 0:e87aa4c49e95 86 * if bit[n] is cleared - pin is not connected (NC)
phungductung 0:e87aa4c49e95 87 */
phungductung 0:e87aa4c49e95 88 int _nc_mask;
phungductung 0:e87aa4c49e95 89
phungductung 0:e87aa4c49e95 90 /* disallow copy constructor and assignment operators */
phungductung 0:e87aa4c49e95 91 private:
phungductung 0:e87aa4c49e95 92 BusIn(const BusIn&);
phungductung 0:e87aa4c49e95 93 BusIn & operator = (const BusIn&);
phungductung 0:e87aa4c49e95 94 };
phungductung 0:e87aa4c49e95 95
phungductung 0:e87aa4c49e95 96 } // namespace mbed
phungductung 0:e87aa4c49e95 97
phungductung 0:e87aa4c49e95 98 #endif