cmd.h

 1/* SPDX-License-Identifier: BSD-3-Clause */
 2/*
 3 * Copyright (c) 2020, MIPI Alliance, Inc.
 4 *
 5 * Author: Nicolas Pitre <npitre@baylibre.com>
 6 *
 7 * Common command/response related stuff
 8 */
 9
10#ifndef CMD_H
11#define CMD_H
12
13/*
14 * Those bits are common to all descriptor formats and
15 * may be manipulated by the core code.
16 */
17#define CMD_0_TOC			W0_BIT_(31)
18#define CMD_0_ROC			W0_BIT_(30)
19#define CMD_0_ATTR			W0_MASK(2, 0)
20#define CMD_0_TID			W0_MASK(6, 3)
21
22/*
23 * Response Descriptor Structure
24 */
25#define RESP_STATUS(resp)		FIELD_GET(GENMASK(31, 28), resp)
26#define RESP_TID(resp)			FIELD_GET(GENMASK(27, 24), resp)
27#define RESP_DATA_LENGTH(resp)		FIELD_GET(GENMASK(21,  0), resp)
28
29#define RESP_ERR_FIELD			GENMASK(31, 28)
30
31enum hci_resp_err {
32	RESP_SUCCESS			= 0x0,
33	RESP_ERR_CRC			= 0x1,
34	RESP_ERR_PARITY			= 0x2,
35	RESP_ERR_FRAME			= 0x3,
36	RESP_ERR_ADDR_HEADER		= 0x4,
37	RESP_ERR_BCAST_NACK_7E		= 0x4,
38	RESP_ERR_NACK			= 0x5,
39	RESP_ERR_OVL			= 0x6,
40	RESP_ERR_I3C_SHORT_READ		= 0x7,
41	RESP_ERR_HC_TERMINATED		= 0x8,
42	RESP_ERR_I2C_WR_DATA_NACK	= 0x9,
43	RESP_ERR_BUS_XFER_ABORTED	= 0x9,
44	RESP_ERR_NOT_SUPPORTED		= 0xa,
45	RESP_ERR_ABORTED_WITH_CRC	= 0xb,
46	/* 0xc to 0xf are reserved for transfer specific errors */
47};
48
49/* TID generation (4 bits wide in all cases) */
50#define hci_get_tid(bits) \
51	(atomic_inc_return_relaxed(&hci->next_cmd_tid) % (1U << 4))
52
53/* This abstracts operations with our command descriptor formats */
54struct hci_cmd_ops {
55	int (*prep_ccc)(struct i3c_hci *hci, struct hci_xfer *xfer,
56			u8 ccc_addr, u8 ccc_cmd, bool raw);
57	void (*prep_i3c_xfer)(struct i3c_hci *hci, struct i3c_dev_desc *dev,
58			      struct hci_xfer *xfer);
59	void (*prep_i2c_xfer)(struct i3c_hci *hci, struct i2c_dev_desc *dev,
60			      struct hci_xfer *xfer);
61	int (*perform_daa)(struct i3c_hci *hci);
62};
63
64/* Our various instances */
65extern const struct hci_cmd_ops mipi_i3c_hci_cmd_v1;
66extern const struct hci_cmd_ops mipi_i3c_hci_cmd_v2;
67
68#endif