Alessandro Angelino / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/BusInOut.h@4:473d4af53300, 2016-04-04 (annotated)

Committer:
Alessandro Angelino
Date:
Mon Apr 04 14:24:07 2016 +0100
Revision:
4:473d4af53300
Parent:
0:9c59db1fbc9e 
Fix function to get sp when in unprivileged mode

Who changed what in which revision?

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