mbed | Mbed

Users » mbed_official » Code » mbed

Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more

BusOut.h@123:b0220dba8be7, 2016-08-12 (annotated)

Committer:: Kojto
Date:: Fri Aug 12 13:04:35 2016 +0200
Revision:: 123:b0220dba8be7
Parent:: 122:f9eeca106725

Release 123 of the mbed library



Changes:

- new targets: nucleo_f207zg, beetle, nrf51_dk, hexiwear,

 nuvoton nuc472, vk rz a1h

- ST - fix timer interrupt handler, sleep api fix

- NXP - lpc15xx us ticker fix

- Nordic - analogin fixes, LF clock init addition, enable i2c async

Who changed what in which revision?

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