Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/BusInOut.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_BUSINOUT_H
nexpaq 0:6c56fb4bc5f0 17 #define MBED_BUSINOUT_H
nexpaq 0:6c56fb4bc5f0 18
nexpaq 0:6c56fb4bc5f0 19 #include "DigitalInOut.h"
nexpaq 0:6c56fb4bc5f0 20 #include "PlatformMutex.h"
nexpaq 0:6c56fb4bc5f0 21
nexpaq 0:6c56fb4bc5f0 22 namespace mbed {
nexpaq 0:6c56fb4bc5f0 23
nexpaq 0:6c56fb4bc5f0 24 /** A digital input output bus, used for setting the state of a collection of pins
nexpaq 0:6c56fb4bc5f0 25 *
nexpaq 0:6c56fb4bc5f0 26 * @Note Synchronization level: Thread safe
nexpaq 0:6c56fb4bc5f0 27 */
nexpaq 0:6c56fb4bc5f0 28 class BusInOut {
nexpaq 0:6c56fb4bc5f0 29
nexpaq 0:6c56fb4bc5f0 30 public:
nexpaq 0:6c56fb4bc5f0 31
nexpaq 0:6c56fb4bc5f0 32 /** Create an BusInOut, connected to the specified pins
nexpaq 0:6c56fb4bc5f0 33 *
nexpaq 0:6c56fb4bc5f0 34 * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
nexpaq 0:6c56fb4bc5f0 35 *
nexpaq 0:6c56fb4bc5f0 36 * @note
nexpaq 0:6c56fb4bc5f0 37 * It is only required to specify as many pin variables as is required
nexpaq 0:6c56fb4bc5f0 38 * for the bus; the rest will default to NC (not connected)
nexpaq 0:6c56fb4bc5f0 39 */
nexpaq 0:6c56fb4bc5f0 40 BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
nexpaq 0:6c56fb4bc5f0 41 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
nexpaq 0:6c56fb4bc5f0 42 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
nexpaq 0:6c56fb4bc5f0 43 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC);
nexpaq 0:6c56fb4bc5f0 44
nexpaq 0:6c56fb4bc5f0 45 BusInOut(PinName pins[16]);
nexpaq 0:6c56fb4bc5f0 46
nexpaq 0:6c56fb4bc5f0 47 virtual ~BusInOut();
nexpaq 0:6c56fb4bc5f0 48
nexpaq 0:6c56fb4bc5f0 49 /* Group: Access Methods */
nexpaq 0:6c56fb4bc5f0 50
nexpaq 0:6c56fb4bc5f0 51 /** Write the value to the output bus
nexpaq 0:6c56fb4bc5f0 52 *
nexpaq 0:6c56fb4bc5f0 53 * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
nexpaq 0:6c56fb4bc5f0 54 */
nexpaq 0:6c56fb4bc5f0 55 void write(int value);
nexpaq 0:6c56fb4bc5f0 56
nexpaq 0:6c56fb4bc5f0 57 /** Read the value currently output on the bus
nexpaq 0:6c56fb4bc5f0 58 *
nexpaq 0:6c56fb4bc5f0 59 * @returns
nexpaq 0:6c56fb4bc5f0 60 * An integer with each bit corresponding to associated DigitalInOut pin setting
nexpaq 0:6c56fb4bc5f0 61 */
nexpaq 0:6c56fb4bc5f0 62 int read();
nexpaq 0:6c56fb4bc5f0 63
nexpaq 0:6c56fb4bc5f0 64 /** Set as an output
nexpaq 0:6c56fb4bc5f0 65 */
nexpaq 0:6c56fb4bc5f0 66 void output();
nexpaq 0:6c56fb4bc5f0 67
nexpaq 0:6c56fb4bc5f0 68 /** Set as an input
nexpaq 0:6c56fb4bc5f0 69 */
nexpaq 0:6c56fb4bc5f0 70 void input();
nexpaq 0:6c56fb4bc5f0 71
nexpaq 0:6c56fb4bc5f0 72 /** Set the input pin mode
nexpaq 0:6c56fb4bc5f0 73 *
nexpaq 0:6c56fb4bc5f0 74 * @param mode PullUp, PullDown, PullNone
nexpaq 0:6c56fb4bc5f0 75 */
nexpaq 0:6c56fb4bc5f0 76 void mode(PinMode pull);
nexpaq 0:6c56fb4bc5f0 77
nexpaq 0:6c56fb4bc5f0 78 /** Binary mask of bus pins connected to actual pins (not NC pins)
nexpaq 0:6c56fb4bc5f0 79 * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1
nexpaq 0:6c56fb4bc5f0 80 *
nexpaq 0:6c56fb4bc5f0 81 * @returns
nexpaq 0:6c56fb4bc5f0 82 * Binary mask of connected pins
nexpaq 0:6c56fb4bc5f0 83 */
nexpaq 0:6c56fb4bc5f0 84 int mask() {
nexpaq 0:6c56fb4bc5f0 85 // No lock needed since _nc_mask is not modified outside the constructor
nexpaq 0:6c56fb4bc5f0 86 return _nc_mask;
nexpaq 0:6c56fb4bc5f0 87 }
nexpaq 0:6c56fb4bc5f0 88
nexpaq 0:6c56fb4bc5f0 89 /** A shorthand for write()
nexpaq 0:6c56fb4bc5f0 90 */
nexpaq 0:6c56fb4bc5f0 91 BusInOut& operator= (int v);
nexpaq 0:6c56fb4bc5f0 92 BusInOut& operator= (BusInOut& rhs);
nexpaq 0:6c56fb4bc5f0 93
nexpaq 0:6c56fb4bc5f0 94 /** Access to particular bit in random-iterator fashion
nexpaq 0:6c56fb4bc5f0 95 */
nexpaq 0:6c56fb4bc5f0 96 DigitalInOut& operator[] (int index);
nexpaq 0:6c56fb4bc5f0 97
nexpaq 0:6c56fb4bc5f0 98 /** A shorthand for read()
nexpaq 0:6c56fb4bc5f0 99 */
nexpaq 0:6c56fb4bc5f0 100 operator int();
nexpaq 0:6c56fb4bc5f0 101
nexpaq 0:6c56fb4bc5f0 102 protected:
nexpaq 0:6c56fb4bc5f0 103 virtual void lock();
nexpaq 0:6c56fb4bc5f0 104 virtual void unlock();
nexpaq 0:6c56fb4bc5f0 105 DigitalInOut* _pin[16];
nexpaq 0:6c56fb4bc5f0 106
nexpaq 0:6c56fb4bc5f0 107 /** Mask of bus's NC pins
nexpaq 0:6c56fb4bc5f0 108 * If bit[n] is set to 1 - pin is connected
nexpaq 0:6c56fb4bc5f0 109 * if bit[n] is cleared - pin is not connected (NC)
nexpaq 0:6c56fb4bc5f0 110 */
nexpaq 0:6c56fb4bc5f0 111 int _nc_mask;
nexpaq 0:6c56fb4bc5f0 112
nexpaq 0:6c56fb4bc5f0 113 PlatformMutex _mutex;
nexpaq 0:6c56fb4bc5f0 114
nexpaq 0:6c56fb4bc5f0 115 /* disallow copy constructor and assignment operators */
nexpaq 0:6c56fb4bc5f0 116 private:
nexpaq 0:6c56fb4bc5f0 117 BusInOut(const BusInOut&);
nexpaq 0:6c56fb4bc5f0 118 BusInOut & operator = (const BusInOut&);
nexpaq 0:6c56fb4bc5f0 119 };
nexpaq 0:6c56fb4bc5f0 120
nexpaq 0:6c56fb4bc5f0 121 } // namespace mbed
nexpaq 0:6c56fb4bc5f0 122
nexpaq 0:6c56fb4bc5f0 123 #endif