drivers/slimbus/slimbus.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * Copyright (c) 2011-2017, The Linux Foundation
26  * BYTE 1: RSVD[7] MC[6:0]
35 #define SLIM_MSG_DT_MASK	GENMASK(1, 0)
66 #define SLIM_CLK_CONST_PHASE			1
71 #define SLIM_MSG_DEST_ENUMADDR		1
76 #define SLIM_MIN_CLK_GEAR		1
91  * struct slim_framer - Represents SLIMbus framer.
92  * Every controller may have multiple framers. There is 1 active framer device
94  * Manager is responsible for framer hand-over.
111  * struct slim_msg_txn - Message to be sent by the controller.
120  *	(relevant for message-codes involving read operation)
124  * @comp: completion if read/write is synchronous, used internally
241 	SLIM_CH_DATA_FMT_LPCM_AUDIO = 1,
255 	SLIM_CH_AUX_FMT_ZCUV_TUNNEL_IEC60958 = 1,
260  * struct slim_channel  - SLIMbus channel, used for state machine
279  * struct slim_port  - SLIMbus port
303  * @SLIM_PROTO_ASYNC_SMPLX: Asynchronous Protocol-Simplex
304  * @SLIM_PROTO_ASYNC_HALF_DUP: Asynchronous Protocol-Half-duplex
305  * @SLIM_PROTO_EXT_SMPLX: Extended Asynchronous Protocol-Simplex
306  * @SLIM_PROTO_EXT_HALF_DUP: Extended Asynchronous Protocol-Half-duplex
320  * struct slim_stream_runtime  - SLIMbus stream runtime instance
327  * @bps: bits per sample
339 	unsigned int bps;  member
347  * struct slim_controller  - Controls every instance of SLIMbus
350  * @id: Board-specific number identifier for this controller/bus
352  * @min_cg: Minimum clock gear supported by this controller (default value: 1)
364  *	like value element read/write.
372  * @wakeup: This function pointer implements controller-specific procedure
373  *	to wake it up from clock-pause. Framework will call this to bring
375  * @enable_stream: This function pointer implements controller-specific procedure
377  * @disable_stream: This function pointer implements controller-specific procedure
383  *	enumeration (report-present, report-absent) of a device.
385  *	channels on the bus, message-bandwidth requests made by SLIMbus devices.
387  *	the bus at (in steps of 'clock-gear', 1 through 10, each clock gear
389  *	Manager is also responsible for entering (and exiting) low-power-mode
393  *	previous framer being powered-on.
397  *	reporting information such as loss-of-synchronization, data
398  *	slot-collision.