1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (c) 2016-2018, 2020, The Linux Foundation. All rights reserved. */
4 #include <linux/debugfs.h>
5 #include <linux/kernel.h>
6 #include <linux/module.h>
8 #include <linux/of_address.h>
9 #include <linux/of_reserved_mem.h>
10 #include <linux/platform_device.h>
11 #include <linux/seq_file.h>
12 #include <linux/types.h>
14 #include <soc/qcom/cmd-db.h>
16 #define NUM_PRIORITY 2
18 #define SLAVE_ID_MASK 0x7
19 #define SLAVE_ID_SHIFT 16
22 * struct entry_header: header for each entry in cmddb
24 * @id: resource's identifier
26 * @addr: the address of the resource
27 * @len: length of the data
28 * @offset: offset from :@data_offset, start of the data
32 __le32 priority
[NUM_PRIORITY
];
39 * struct rsc_hdr: resource header information
41 * @slv_id: id for the resource
42 * @header_offset: entry's header at offset from the end of the cmd_db_header
43 * @data_offset: entry's data at offset from the end of the cmd_db_header
44 * @cnt: number of entries for HW type
45 * @version: MSB is major, LSB is minor
46 * @reserved: reserved for future use.
58 * struct cmd_db_header: The DB header information
60 * @version: The cmd db version
61 * @magic: constant expected in the database
62 * @header: array of resources
63 * @checksum: checksum for the header. Unused.
64 * @reserved: reserved memory
65 * @data: driver specific data
67 struct cmd_db_header
{
70 struct rsc_hdr header
[MAX_SLV_ID
];
77 * DOC: Description of the Command DB database.
79 * At the start of the command DB memory is the cmd_db_header structure.
80 * The cmd_db_header holds the version, checksum, magic key as well as an
81 * array for header for each slave (depicted by the rsc_header). Each h/w
82 * based accelerator is a 'slave' (shared resource) and has slave id indicating
83 * the type of accelerator. The rsc_header is the header for such individual
84 * slaves of a given type. The entries for each of these slaves begin at the
85 * rsc_hdr.header_offset. In addition each slave could have auxiliary data
86 * that may be needed by the driver. The data for the slave starts at the
87 * entry_header.offset to the location pointed to by the rsc_hdr.data_offset.
89 * Drivers have a stringified key to a slave/resource. They can query the slave
90 * information and get the slave id and the auxiliary data and the length of the
91 * data. Using this information, they can format the request to be sent to the
92 * h/w accelerator and request a resource state.
95 static const u8 CMD_DB_MAGIC
[] = { 0xdb, 0x30, 0x03, 0x0c };
97 static bool cmd_db_magic_matches(const struct cmd_db_header
*header
)
99 const u8
*magic
= header
->magic
;
101 return memcmp(magic
, CMD_DB_MAGIC
, ARRAY_SIZE(CMD_DB_MAGIC
)) == 0;
104 static struct cmd_db_header
*cmd_db_header
;
106 static inline const void *rsc_to_entry_header(const struct rsc_hdr
*hdr
)
108 u16 offset
= le16_to_cpu(hdr
->header_offset
);
110 return cmd_db_header
->data
+ offset
;
114 rsc_offset(const struct rsc_hdr
*hdr
, const struct entry_header
*ent
)
116 u16 offset
= le16_to_cpu(hdr
->data_offset
);
117 u16 loffset
= le16_to_cpu(ent
->offset
);
119 return cmd_db_header
->data
+ offset
+ loffset
;
123 * cmd_db_ready - Indicates if command DB is available
125 * Return: 0 on success, errno otherwise
127 int cmd_db_ready(void)
129 if (cmd_db_header
== NULL
)
130 return -EPROBE_DEFER
;
131 else if (!cmd_db_magic_matches(cmd_db_header
))
136 EXPORT_SYMBOL(cmd_db_ready
);
138 static int cmd_db_get_header(const char *id
, const struct entry_header
**eh
,
139 const struct rsc_hdr
**rh
)
141 const struct rsc_hdr
*rsc_hdr
;
142 const struct entry_header
*ent
;
146 ret
= cmd_db_ready();
150 /* Pad out query string to same length as in DB */
151 strncpy(query
, id
, sizeof(query
));
153 for (i
= 0; i
< MAX_SLV_ID
; i
++) {
154 rsc_hdr
= &cmd_db_header
->header
[i
];
155 if (!rsc_hdr
->slv_id
)
158 ent
= rsc_to_entry_header(rsc_hdr
);
159 for (j
= 0; j
< le16_to_cpu(rsc_hdr
->cnt
); j
++, ent
++) {
160 if (memcmp(ent
->id
, query
, sizeof(ent
->id
)) == 0) {
174 * cmd_db_read_addr() - Query command db for resource id address.
176 * @id: resource id to query for address
178 * Return: resource address on success, 0 on error
180 * This is used to retrieve resource address based on resource
183 u32
cmd_db_read_addr(const char *id
)
186 const struct entry_header
*ent
;
188 ret
= cmd_db_get_header(id
, &ent
, NULL
);
190 return ret
< 0 ? 0 : le32_to_cpu(ent
->addr
);
192 EXPORT_SYMBOL(cmd_db_read_addr
);
195 * cmd_db_read_aux_data() - Query command db for aux data.
197 * @id: Resource to retrieve AUX Data on
198 * @len: size of data buffer returned
200 * Return: pointer to data on success, error pointer otherwise
202 const void *cmd_db_read_aux_data(const char *id
, size_t *len
)
205 const struct entry_header
*ent
;
206 const struct rsc_hdr
*rsc_hdr
;
208 ret
= cmd_db_get_header(id
, &ent
, &rsc_hdr
);
213 *len
= le16_to_cpu(ent
->len
);
215 return rsc_offset(rsc_hdr
, ent
);
217 EXPORT_SYMBOL(cmd_db_read_aux_data
);
220 * cmd_db_read_slave_id - Get the slave ID for a given resource address
222 * @id: Resource id to query the DB for version
224 * Return: cmd_db_hw_type enum on success, CMD_DB_HW_INVALID on error
226 enum cmd_db_hw_type
cmd_db_read_slave_id(const char *id
)
229 const struct entry_header
*ent
;
232 ret
= cmd_db_get_header(id
, &ent
, NULL
);
234 return CMD_DB_HW_INVALID
;
236 addr
= le32_to_cpu(ent
->addr
);
237 return (addr
>> SLAVE_ID_SHIFT
) & SLAVE_ID_MASK
;
239 EXPORT_SYMBOL(cmd_db_read_slave_id
);
241 #ifdef CONFIG_DEBUG_FS
242 static int cmd_db_debugfs_dump(struct seq_file
*seq
, void *p
)
245 const struct rsc_hdr
*rsc
;
246 const struct entry_header
*ent
;
251 seq_puts(seq
, "Command DB DUMP\n");
253 for (i
= 0; i
< MAX_SLV_ID
; i
++) {
254 rsc
= &cmd_db_header
->header
[i
];
258 switch (le16_to_cpu(rsc
->slv_id
)) {
273 version
= le16_to_cpu(rsc
->version
);
274 major
= version
>> 8;
277 seq_printf(seq
, "Slave %s (v%u.%u)\n", name
, major
, minor
);
278 seq_puts(seq
, "-------------------------\n");
280 ent
= rsc_to_entry_header(rsc
);
281 for (j
= 0; j
< le16_to_cpu(rsc
->cnt
); j
++, ent
++) {
282 seq_printf(seq
, "0x%05x: %*pEp", le32_to_cpu(ent
->addr
),
283 (int)sizeof(ent
->id
), ent
->id
);
285 len
= le16_to_cpu(ent
->len
);
287 seq_printf(seq
, " [%*ph]",
288 len
, rsc_offset(rsc
, ent
));
297 static int open_cmd_db_debugfs(struct inode
*inode
, struct file
*file
)
299 return single_open(file
, cmd_db_debugfs_dump
, inode
->i_private
);
303 static const struct file_operations cmd_db_debugfs_ops
= {
304 #ifdef CONFIG_DEBUG_FS
305 .open
= open_cmd_db_debugfs
,
309 .release
= single_release
,
312 static int cmd_db_dev_probe(struct platform_device
*pdev
)
314 struct reserved_mem
*rmem
;
317 rmem
= of_reserved_mem_lookup(pdev
->dev
.of_node
);
319 dev_err(&pdev
->dev
, "failed to acquire memory region\n");
323 cmd_db_header
= memremap(rmem
->base
, rmem
->size
, MEMREMAP_WB
);
324 if (!cmd_db_header
) {
326 cmd_db_header
= NULL
;
330 if (!cmd_db_magic_matches(cmd_db_header
)) {
331 dev_err(&pdev
->dev
, "Invalid Command DB Magic\n");
335 debugfs_create_file("cmd-db", 0400, NULL
, NULL
, &cmd_db_debugfs_ops
);
340 static const struct of_device_id cmd_db_match_table
[] = {
341 { .compatible
= "qcom,cmd-db" },
344 MODULE_DEVICE_TABLE(of
, cmd_db_match_table
);
346 static struct platform_driver cmd_db_dev_driver
= {
347 .probe
= cmd_db_dev_probe
,
350 .of_match_table
= cmd_db_match_table
,
351 .suppress_bind_attrs
= true,
355 static int __init
cmd_db_device_init(void)
357 return platform_driver_register(&cmd_db_dev_driver
);
359 arch_initcall(cmd_db_device_init
);
361 MODULE_DESCRIPTION("Qualcomm Technologies, Inc. Command DB Driver");
362 MODULE_LICENSE("GPL v2");