fix LPC812 PWM
Fork of mbed-dev by
api/BusInOut.h@0:9b334a45a8ff, 2015-10-01 (annotated)
- Committer:
- bogdanm
- Date:
- Thu Oct 01 15:25:22 2015 +0300
- Revision:
- 0:9b334a45a8ff
Initial commit on mbed-dev
Replaces mbed-src (now inactive)
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
bogdanm | 0:9b334a45a8ff | 1 | /* mbed Microcontroller Library |
bogdanm | 0:9b334a45a8ff | 2 | * Copyright (c) 2006-2013 ARM Limited |
bogdanm | 0:9b334a45a8ff | 3 | * |
bogdanm | 0:9b334a45a8ff | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
bogdanm | 0:9b334a45a8ff | 5 | * you may not use this file except in compliance with the License. |
bogdanm | 0:9b334a45a8ff | 6 | * You may obtain a copy of the License at |
bogdanm | 0:9b334a45a8ff | 7 | * |
bogdanm | 0:9b334a45a8ff | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
bogdanm | 0:9b334a45a8ff | 9 | * |
bogdanm | 0:9b334a45a8ff | 10 | * Unless required by applicable law or agreed to in writing, software |
bogdanm | 0:9b334a45a8ff | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
bogdanm | 0:9b334a45a8ff | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
bogdanm | 0:9b334a45a8ff | 13 | * See the License for the specific language governing permissions and |
bogdanm | 0:9b334a45a8ff | 14 | * limitations under the License. |
bogdanm | 0:9b334a45a8ff | 15 | */ |
bogdanm | 0:9b334a45a8ff | 16 | #ifndef MBED_BUSINOUT_H |
bogdanm | 0:9b334a45a8ff | 17 | #define MBED_BUSINOUT_H |
bogdanm | 0:9b334a45a8ff | 18 | |
bogdanm | 0:9b334a45a8ff | 19 | #include "DigitalInOut.h" |
bogdanm | 0:9b334a45a8ff | 20 | |
bogdanm | 0:9b334a45a8ff | 21 | namespace mbed { |
bogdanm | 0:9b334a45a8ff | 22 | |
bogdanm | 0:9b334a45a8ff | 23 | /** A digital input output bus, used for setting the state of a collection of pins |
bogdanm | 0:9b334a45a8ff | 24 | */ |
bogdanm | 0:9b334a45a8ff | 25 | class BusInOut { |
bogdanm | 0:9b334a45a8ff | 26 | |
bogdanm | 0:9b334a45a8ff | 27 | public: |
bogdanm | 0:9b334a45a8ff | 28 | |
bogdanm | 0:9b334a45a8ff | 29 | /** Create an BusInOut, connected to the specified pins |
bogdanm | 0:9b334a45a8ff | 30 | * |
bogdanm | 0:9b334a45a8ff | 31 | * @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC) |
bogdanm | 0:9b334a45a8ff | 32 | * |
bogdanm | 0:9b334a45a8ff | 33 | * @note |
bogdanm | 0:9b334a45a8ff | 34 | * It is only required to specify as many pin variables as is required |
bogdanm | 0:9b334a45a8ff | 35 | * for the bus; the rest will default to NC (not connected) |
bogdanm | 0:9b334a45a8ff | 36 | */ |
bogdanm | 0:9b334a45a8ff | 37 | BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC, |
bogdanm | 0:9b334a45a8ff | 38 | PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC, |
bogdanm | 0:9b334a45a8ff | 39 | PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC, |
bogdanm | 0:9b334a45a8ff | 40 | PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC); |
bogdanm | 0:9b334a45a8ff | 41 | |
bogdanm | 0:9b334a45a8ff | 42 | BusInOut(PinName pins[16]); |
bogdanm | 0:9b334a45a8ff | 43 | |
bogdanm | 0:9b334a45a8ff | 44 | virtual ~BusInOut(); |
bogdanm | 0:9b334a45a8ff | 45 | |
bogdanm | 0:9b334a45a8ff | 46 | /* Group: Access Methods */ |
bogdanm | 0:9b334a45a8ff | 47 | |
bogdanm | 0:9b334a45a8ff | 48 | /** Write the value to the output bus |
bogdanm | 0:9b334a45a8ff | 49 | * |
bogdanm | 0:9b334a45a8ff | 50 | * @param value An integer specifying a bit to write for every corresponding DigitalInOut pin |
bogdanm | 0:9b334a45a8ff | 51 | */ |
bogdanm | 0:9b334a45a8ff | 52 | void write(int value); |
bogdanm | 0:9b334a45a8ff | 53 | |
bogdanm | 0:9b334a45a8ff | 54 | /** Read the value currently output on the bus |
bogdanm | 0:9b334a45a8ff | 55 | * |
bogdanm | 0:9b334a45a8ff | 56 | * @returns |
bogdanm | 0:9b334a45a8ff | 57 | * An integer with each bit corresponding to associated DigitalInOut pin setting |
bogdanm | 0:9b334a45a8ff | 58 | */ |
bogdanm | 0:9b334a45a8ff | 59 | int read(); |
bogdanm | 0:9b334a45a8ff | 60 | |
bogdanm | 0:9b334a45a8ff | 61 | /** Set as an output |
bogdanm | 0:9b334a45a8ff | 62 | */ |
bogdanm | 0:9b334a45a8ff | 63 | void output(); |
bogdanm | 0:9b334a45a8ff | 64 | |
bogdanm | 0:9b334a45a8ff | 65 | /** Set as an input |
bogdanm | 0:9b334a45a8ff | 66 | */ |
bogdanm | 0:9b334a45a8ff | 67 | void input(); |
bogdanm | 0:9b334a45a8ff | 68 | |
bogdanm | 0:9b334a45a8ff | 69 | /** Set the input pin mode |
bogdanm | 0:9b334a45a8ff | 70 | * |
bogdanm | 0:9b334a45a8ff | 71 | * @param mode PullUp, PullDown, PullNone |
bogdanm | 0:9b334a45a8ff | 72 | */ |
bogdanm | 0:9b334a45a8ff | 73 | void mode(PinMode pull); |
bogdanm | 0:9b334a45a8ff | 74 | |
bogdanm | 0:9b334a45a8ff | 75 | /** Binary mask of bus pins connected to actual pins (not NC pins) |
bogdanm | 0:9b334a45a8ff | 76 | * If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1 |
bogdanm | 0:9b334a45a8ff | 77 | * |
bogdanm | 0:9b334a45a8ff | 78 | * @returns |
bogdanm | 0:9b334a45a8ff | 79 | * Binary mask of connected pins |
bogdanm | 0:9b334a45a8ff | 80 | */ |
bogdanm | 0:9b334a45a8ff | 81 | int mask() { |
bogdanm | 0:9b334a45a8ff | 82 | return _nc_mask; |
bogdanm | 0:9b334a45a8ff | 83 | } |
bogdanm | 0:9b334a45a8ff | 84 | |
bogdanm | 0:9b334a45a8ff | 85 | #ifdef MBED_OPERATORS |
bogdanm | 0:9b334a45a8ff | 86 | /** A shorthand for write() |
bogdanm | 0:9b334a45a8ff | 87 | */ |
bogdanm | 0:9b334a45a8ff | 88 | BusInOut& operator= (int v); |
bogdanm | 0:9b334a45a8ff | 89 | BusInOut& operator= (BusInOut& rhs); |
bogdanm | 0:9b334a45a8ff | 90 | |
bogdanm | 0:9b334a45a8ff | 91 | /** Access to particular bit in random-iterator fashion |
bogdanm | 0:9b334a45a8ff | 92 | */ |
bogdanm | 0:9b334a45a8ff | 93 | DigitalInOut& operator[] (int index); |
bogdanm | 0:9b334a45a8ff | 94 | |
bogdanm | 0:9b334a45a8ff | 95 | /** A shorthand for read() |
bogdanm | 0:9b334a45a8ff | 96 | */ |
bogdanm | 0:9b334a45a8ff | 97 | operator int(); |
bogdanm | 0:9b334a45a8ff | 98 | #endif |
bogdanm | 0:9b334a45a8ff | 99 | |
bogdanm | 0:9b334a45a8ff | 100 | protected: |
bogdanm | 0:9b334a45a8ff | 101 | DigitalInOut* _pin[16]; |
bogdanm | 0:9b334a45a8ff | 102 | |
bogdanm | 0:9b334a45a8ff | 103 | /** Mask of bus's NC pins |
bogdanm | 0:9b334a45a8ff | 104 | * If bit[n] is set to 1 - pin is connected |
bogdanm | 0:9b334a45a8ff | 105 | * if bit[n] is cleared - pin is not connected (NC) |
bogdanm | 0:9b334a45a8ff | 106 | */ |
bogdanm | 0:9b334a45a8ff | 107 | int _nc_mask; |
bogdanm | 0:9b334a45a8ff | 108 | |
bogdanm | 0:9b334a45a8ff | 109 | /* disallow copy constructor and assignment operators */ |
bogdanm | 0:9b334a45a8ff | 110 | private: |
bogdanm | 0:9b334a45a8ff | 111 | BusInOut(const BusInOut&); |
bogdanm | 0:9b334a45a8ff | 112 | BusInOut & operator = (const BusInOut&); |
bogdanm | 0:9b334a45a8ff | 113 | }; |
bogdanm | 0:9b334a45a8ff | 114 | |
bogdanm | 0:9b334a45a8ff | 115 | } // namespace mbed |
bogdanm | 0:9b334a45a8ff | 116 | |
bogdanm | 0:9b334a45a8ff | 117 | #endif |