mbed-dev | Mbed

Users » mbed_official » Code » mbed-dev

Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

api/BusIn.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:: <>
Date:: Fri Sep 02 15:07:44 2016 +0100
Revision:: 144:ef7eb2e8f9f7
Parent:: 0:9b334a45a8ff

This updates the lib to the mbed lib v125

Who changed what in which revision?

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