1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Freescale Management Complex (MC) bus private declarations
5 * Copyright (C) 2016 Freescale Semiconductor, Inc.
8 #ifndef _FSL_MC_PRIVATE_H_
9 #define _FSL_MC_PRIVATE_H_
11 #include <linux/fsl/mc.h>
12 #include <linux/mutex.h>
13 #include <linux/ioctl.h>
14 #include <linux/miscdevice.h>
17 * Data Path Management Complex (DPMNG) General API
20 /* DPMNG command versioning */
21 #define DPMNG_CMD_BASE_VERSION 1
22 #define DPMNG_CMD_ID_OFFSET 4
24 #define DPMNG_CMD(id) (((id) << DPMNG_CMD_ID_OFFSET) | DPMNG_CMD_BASE_VERSION)
26 /* DPMNG command IDs */
27 #define DPMNG_CMDID_GET_VERSION DPMNG_CMD(0x831)
29 struct dpmng_rsp_get_version {
36 * Data Path Management Command Portal (DPMCP) API
39 /* Minimal supported DPMCP Version */
40 #define DPMCP_MIN_VER_MAJOR 3
41 #define DPMCP_MIN_VER_MINOR 0
43 /* DPMCP command versioning */
44 #define DPMCP_CMD_BASE_VERSION 1
45 #define DPMCP_CMD_ID_OFFSET 4
47 #define DPMCP_CMD(id) (((id) << DPMCP_CMD_ID_OFFSET) | DPMCP_CMD_BASE_VERSION)
49 /* DPMCP command IDs */
50 #define DPMCP_CMDID_CLOSE DPMCP_CMD(0x800)
51 #define DPMCP_CMDID_RESET DPMCP_CMD(0x005)
53 struct dpmcp_cmd_open {
58 * Initialization and runtime control APIs for DPMCP
60 int dpmcp_open(struct fsl_mc_io *mc_io,
65 int dpmcp_close(struct fsl_mc_io *mc_io,
69 int dpmcp_reset(struct fsl_mc_io *mc_io,
74 * Data Path Resource Container (DPRC) API
77 /* Minimal supported DPRC Version */
78 #define DPRC_MIN_VER_MAJOR 6
79 #define DPRC_MIN_VER_MINOR 0
81 /* DPRC command versioning */
82 #define DPRC_CMD_BASE_VERSION 1
83 #define DPRC_CMD_2ND_VERSION 2
84 #define DPRC_CMD_3RD_VERSION 3
85 #define DPRC_CMD_ID_OFFSET 4
87 #define DPRC_CMD(id) (((id) << DPRC_CMD_ID_OFFSET) | DPRC_CMD_BASE_VERSION)
88 #define DPRC_CMD_V2(id) (((id) << DPRC_CMD_ID_OFFSET) | DPRC_CMD_2ND_VERSION)
89 #define DPRC_CMD_V3(id) (((id) << DPRC_CMD_ID_OFFSET) | DPRC_CMD_3RD_VERSION)
91 /* DPRC command IDs */
92 #define DPRC_CMDID_CLOSE DPRC_CMD(0x800)
93 #define DPRC_CMDID_GET_API_VERSION DPRC_CMD(0xa05)
95 #define DPRC_CMDID_GET_ATTR DPRC_CMD(0x004)
96 #define DPRC_CMDID_RESET_CONT DPRC_CMD(0x005)
97 #define DPRC_CMDID_RESET_CONT_V2 DPRC_CMD_V2(0x005)
99 #define DPRC_CMDID_SET_IRQ DPRC_CMD(0x010)
100 #define DPRC_CMDID_SET_IRQ_ENABLE DPRC_CMD(0x012)
101 #define DPRC_CMDID_SET_IRQ_MASK DPRC_CMD(0x014)
102 #define DPRC_CMDID_GET_IRQ_STATUS DPRC_CMD(0x016)
103 #define DPRC_CMDID_CLEAR_IRQ_STATUS DPRC_CMD(0x017)
105 #define DPRC_CMDID_GET_CONT_ID DPRC_CMD(0x830)
106 #define DPRC_CMDID_GET_OBJ_COUNT DPRC_CMD(0x159)
107 #define DPRC_CMDID_GET_OBJ DPRC_CMD(0x15A)
108 #define DPRC_CMDID_GET_OBJ_REG DPRC_CMD(0x15E)
109 #define DPRC_CMDID_GET_OBJ_REG_V2 DPRC_CMD_V2(0x15E)
110 #define DPRC_CMDID_GET_OBJ_REG_V3 DPRC_CMD_V3(0x15E)
111 #define DPRC_CMDID_SET_OBJ_IRQ DPRC_CMD(0x15F)
113 #define DPRC_CMDID_GET_CONNECTION DPRC_CMD(0x16C)
115 struct dprc_cmd_open {
119 struct dprc_cmd_reset_container {
120 __le32 child_container_id;
124 struct dprc_cmd_set_irq {
135 #define DPRC_ENABLE 0x1
137 struct dprc_cmd_set_irq_enable {
143 struct dprc_cmd_set_irq_mask {
148 struct dprc_cmd_get_irq_status {
153 struct dprc_rsp_get_irq_status {
157 struct dprc_cmd_clear_irq_status {
162 struct dprc_rsp_get_attributes {
163 /* response word 0 */
166 /* response word 1 */
171 struct dprc_rsp_get_obj_count {
176 struct dprc_cmd_get_obj {
180 struct dprc_rsp_get_obj {
181 /* response word 0 */
184 /* response word 1 */
189 /* response word 2 */
190 __le16 version_major;
191 __le16 version_minor;
194 /* response word 3-4 */
196 /* response word 5-6 */
200 struct dprc_cmd_get_obj_region {
212 struct dprc_rsp_get_obj_region {
213 /* response word 0 */
215 /* response word 1 */
217 /* response word 2 */
221 /* response word 3 */
224 /* response word 4 */
225 /* base_addr may be zero if older MC firmware is used */
229 struct dprc_cmd_set_obj_irq {
243 struct dprc_cmd_get_connection {
245 __le16 ep1_interface_id;
250 struct dprc_rsp_get_connection {
253 __le16 ep2_interface_id;
260 * DPRC API for managing and querying DPAA resources
262 int dprc_open(struct fsl_mc_io *mc_io,
267 int dprc_close(struct fsl_mc_io *mc_io,
271 /* DPRC IRQ events */
273 /* IRQ event - Indicates that a new object added to the container */
274 #define DPRC_IRQ_EVENT_OBJ_ADDED 0x00000001
275 /* IRQ event - Indicates that an object was removed from the container */
276 #define DPRC_IRQ_EVENT_OBJ_REMOVED 0x00000002
278 * IRQ event - Indicates that one of the descendant containers that opened by
279 * this container is destroyed
281 #define DPRC_IRQ_EVENT_CONTAINER_DESTROYED 0x00000010
284 * IRQ event - Indicates that on one of the container's opened object is
287 #define DPRC_IRQ_EVENT_OBJ_DESTROYED 0x00000020
289 /* Irq event - Indicates that object is created at the container */
290 #define DPRC_IRQ_EVENT_OBJ_CREATED 0x00000040
293 * struct dprc_irq_cfg - IRQ configuration
294 * @paddr: Address that must be written to signal a message-based interrupt
295 * @val: Value to write into irq_addr address
296 * @irq_num: A user defined number associated with this IRQ
298 struct dprc_irq_cfg {
304 int dprc_set_irq(struct fsl_mc_io *mc_io,
308 struct dprc_irq_cfg *irq_cfg);
310 int dprc_set_irq_enable(struct fsl_mc_io *mc_io,
316 int dprc_set_irq_mask(struct fsl_mc_io *mc_io,
322 int dprc_get_irq_status(struct fsl_mc_io *mc_io,
328 int dprc_clear_irq_status(struct fsl_mc_io *mc_io,
335 * struct dprc_attributes - Container attributes
336 * @container_id: Container's ID
337 * @icid: Container's ICID
338 * @portal_id: Container's portal ID
339 * @options: Container's options as set at container's creation
341 struct dprc_attributes {
348 int dprc_get_attributes(struct fsl_mc_io *mc_io,
351 struct dprc_attributes *attributes);
353 int dprc_get_obj_count(struct fsl_mc_io *mc_io,
358 int dprc_get_obj(struct fsl_mc_io *mc_io,
362 struct fsl_mc_obj_desc *obj_desc);
364 int dprc_set_obj_irq(struct fsl_mc_io *mc_io,
370 struct dprc_irq_cfg *irq_cfg);
372 * enum dprc_region_type - Region type
373 * @DPRC_REGION_TYPE_MC_PORTAL: MC portal region
374 * @DPRC_REGION_TYPE_QBMAN_PORTAL: Qbman portal region
376 enum dprc_region_type {
377 DPRC_REGION_TYPE_MC_PORTAL,
378 DPRC_REGION_TYPE_QBMAN_PORTAL,
379 DPRC_REGION_TYPE_QBMAN_MEM_BACKED_PORTAL
383 * struct dprc_region_desc - Mappable region descriptor
384 * @base_offset: Region offset from region's base address.
385 * For DPMCP and DPRC objects, region base is offset from SoC MC portals
386 * base address; For DPIO, region base is offset from SoC QMan portals
388 * @size: Region size (in bytes)
389 * @flags: Region attributes
390 * @type: Portal region type
392 struct dprc_region_desc {
396 enum dprc_region_type type;
400 int dprc_get_obj_region(struct fsl_mc_io *mc_io,
406 struct dprc_region_desc *region_desc);
408 int dprc_get_api_version(struct fsl_mc_io *mc_io,
413 int dprc_get_container_id(struct fsl_mc_io *mc_io,
418 * struct dprc_endpoint - Endpoint description for link connect/disconnect
420 * @type: Endpoint object type: NULL terminated string
421 * @id: Endpoint object ID
422 * @if_id: Interface ID; should be set for endpoints with multiple
423 * interfaces ("dpsw", "dpdmux"); for others, always set to 0
425 struct dprc_endpoint {
431 int dprc_get_connection(struct fsl_mc_io *mc_io,
434 const struct dprc_endpoint *endpoint1,
435 struct dprc_endpoint *endpoint2,
439 * Data Path Buffer Pool (DPBP) API
443 #define DPBP_VER_MAJOR 3
444 #define DPBP_VER_MINOR 2
446 /* Command versioning */
447 #define DPBP_CMD_BASE_VERSION 1
448 #define DPBP_CMD_ID_OFFSET 4
450 #define DPBP_CMD(id) (((id) << DPBP_CMD_ID_OFFSET) | DPBP_CMD_BASE_VERSION)
453 #define DPBP_CMDID_CLOSE DPBP_CMD(0x800)
455 #define DPBP_CMDID_ENABLE DPBP_CMD(0x002)
456 #define DPBP_CMDID_DISABLE DPBP_CMD(0x003)
457 #define DPBP_CMDID_GET_ATTR DPBP_CMD(0x004)
458 #define DPBP_CMDID_RESET DPBP_CMD(0x005)
460 struct dpbp_cmd_open {
464 #define DPBP_ENABLE 0x1
466 struct dpbp_rsp_get_attributes {
467 /* response word 0 */
471 /* response word 1 */
472 __le16 version_major;
473 __le16 version_minor;
477 * Data Path Concentrator (DPCON) API
481 #define DPCON_VER_MAJOR 3
482 #define DPCON_VER_MINOR 2
484 /* Command versioning */
485 #define DPCON_CMD_BASE_VERSION 1
486 #define DPCON_CMD_ID_OFFSET 4
488 #define DPCON_CMD(id) (((id) << DPCON_CMD_ID_OFFSET) | DPCON_CMD_BASE_VERSION)
491 #define DPCON_CMDID_CLOSE DPCON_CMD(0x800)
493 #define DPCON_CMDID_ENABLE DPCON_CMD(0x002)
494 #define DPCON_CMDID_DISABLE DPCON_CMD(0x003)
495 #define DPCON_CMDID_GET_ATTR DPCON_CMD(0x004)
496 #define DPCON_CMDID_RESET DPCON_CMD(0x005)
498 #define DPCON_CMDID_SET_NOTIFICATION DPCON_CMD(0x100)
500 struct dpcon_cmd_open {
504 #define DPCON_ENABLE 1
506 struct dpcon_rsp_get_attr {
507 /* response word 0 */
514 struct dpcon_cmd_set_notification {
527 /* generic command versioning */
528 #define OBJ_CMD_BASE_VERSION 1
529 #define OBJ_CMD_ID_OFFSET 4
531 #define OBJ_CMD(id) (((id) << OBJ_CMD_ID_OFFSET) | OBJ_CMD_BASE_VERSION)
533 /* open command codes */
534 #define DPRTC_CMDID_OPEN OBJ_CMD(0x810)
535 #define DPNI_CMDID_OPEN OBJ_CMD(0x801)
536 #define DPSW_CMDID_OPEN OBJ_CMD(0x802)
537 #define DPIO_CMDID_OPEN OBJ_CMD(0x803)
538 #define DPBP_CMDID_OPEN OBJ_CMD(0x804)
539 #define DPRC_CMDID_OPEN OBJ_CMD(0x805)
540 #define DPDMUX_CMDID_OPEN OBJ_CMD(0x806)
541 #define DPCI_CMDID_OPEN OBJ_CMD(0x807)
542 #define DPCON_CMDID_OPEN OBJ_CMD(0x808)
543 #define DPSECI_CMDID_OPEN OBJ_CMD(0x809)
544 #define DPAIOP_CMDID_OPEN OBJ_CMD(0x80a)
545 #define DPMCP_CMDID_OPEN OBJ_CMD(0x80b)
546 #define DPMAC_CMDID_OPEN OBJ_CMD(0x80c)
547 #define DPDCEI_CMDID_OPEN OBJ_CMD(0x80d)
548 #define DPDMAI_CMDID_OPEN OBJ_CMD(0x80e)
549 #define DPDBG_CMDID_OPEN OBJ_CMD(0x80f)
551 /* Generic object command IDs */
552 #define OBJ_CMDID_CLOSE OBJ_CMD(0x800)
553 #define OBJ_CMDID_RESET OBJ_CMD(0x005)
555 struct fsl_mc_obj_cmd_open {
560 * struct fsl_mc_resource_pool - Pool of MC resources of a given
562 * @type: type of resources in the pool
563 * @max_count: maximum number of resources in the pool
564 * @free_count: number of free resources in the pool
565 * @mutex: mutex to serialize access to the pool's free list
566 * @free_list: anchor node of list of free resources in the pool
567 * @mc_bus: pointer to the MC bus that owns this resource pool
569 struct fsl_mc_resource_pool {
570 enum fsl_mc_pool_type type;
573 struct mutex mutex; /* serializes access to free_list */
574 struct list_head free_list;
575 struct fsl_mc_bus *mc_bus;
579 * struct fsl_mc_uapi - information associated with a device file
580 * @misc: struct miscdevice linked to the root dprc
581 * @device: newly created device in /dev
582 * @mutex: mutex lock to serialize the open/release operations
583 * @local_instance_in_use: local MC I/O instance in use or not
584 * @static_mc_io: pointer to the static MC I/O object
587 struct miscdevice misc;
588 struct device *device;
589 struct mutex mutex; /* serialize open/release operations */
590 u32 local_instance_in_use;
591 struct fsl_mc_io *static_mc_io;
595 * struct fsl_mc_bus - logical bus that corresponds to a physical DPRC
596 * @mc_dev: fsl-mc device for the bus device itself.
597 * @resource_pools: array of resource pools (one pool per resource type)
598 * for this MC bus. These resources represent allocatable entities
599 * from the physical DPRC.
600 * @irq_resources: Pointer to array of IRQ objects for the IRQ pool
601 * @scan_mutex: Serializes bus scanning
602 * @dprc_attr: DPRC attributes
603 * @uapi_misc: struct that abstracts the interaction with userspace
606 struct fsl_mc_device mc_dev;
607 struct fsl_mc_resource_pool resource_pools[FSL_MC_NUM_POOL_TYPES];
608 struct fsl_mc_device_irq *irq_resources;
609 struct mutex scan_mutex; /* serializes bus scanning */
610 struct dprc_attributes dprc_attr;
611 struct fsl_mc_uapi uapi_misc;
615 #define to_fsl_mc_bus(_mc_dev) \
616 container_of(_mc_dev, struct fsl_mc_bus, mc_dev)
618 int __must_check fsl_mc_device_add(struct fsl_mc_obj_desc *obj_desc,
619 struct fsl_mc_io *mc_io,
620 struct device *parent_dev,
621 struct fsl_mc_device **new_mc_dev);
623 void fsl_mc_device_remove(struct fsl_mc_device *mc_dev);
625 int __init dprc_driver_init(void);
627 void dprc_driver_exit(void);
629 int dprc_scan_objects(struct fsl_mc_device *mc_bus_dev,
630 bool alloc_interrupts);
632 int __init fsl_mc_allocator_driver_init(void);
634 void fsl_mc_allocator_driver_exit(void);
636 void fsl_mc_init_all_resource_pools(struct fsl_mc_device *mc_bus_dev);
638 void fsl_mc_cleanup_all_resource_pools(struct fsl_mc_device *mc_bus_dev);
640 int __must_check fsl_mc_resource_allocate(struct fsl_mc_bus *mc_bus,
641 enum fsl_mc_pool_type pool_type,
642 struct fsl_mc_resource
645 void fsl_mc_resource_free(struct fsl_mc_resource *resource);
647 int fsl_mc_msi_domain_alloc_irqs(struct device *dev,
648 unsigned int irq_count);
650 void fsl_mc_msi_domain_free_irqs(struct device *dev);
652 struct irq_domain *fsl_mc_find_msi_domain(struct device *dev);
654 int __must_check fsl_create_mc_io(struct device *dev,
655 phys_addr_t mc_portal_phys_addr,
657 struct fsl_mc_device *dpmcp_dev,
658 u32 flags, struct fsl_mc_io **new_mc_io);
660 void fsl_destroy_mc_io(struct fsl_mc_io *mc_io);
662 bool fsl_mc_is_root_dprc(struct device *dev);
664 void fsl_mc_get_root_dprc(struct device *dev,
665 struct device **root_dprc_dev);
667 struct fsl_mc_device *fsl_mc_device_lookup(struct fsl_mc_obj_desc *obj_desc,
668 struct fsl_mc_device *mc_bus_dev);
670 u16 mc_cmd_hdr_read_cmdid(struct fsl_mc_command *cmd);
672 #ifdef CONFIG_FSL_MC_UAPI_SUPPORT
674 int fsl_mc_uapi_create_device_file(struct fsl_mc_bus *mc_bus);
676 void fsl_mc_uapi_remove_device_file(struct fsl_mc_bus *mc_bus);
680 static inline int fsl_mc_uapi_create_device_file(struct fsl_mc_bus *mc_bus)
685 static inline void fsl_mc_uapi_remove_device_file(struct fsl_mc_bus *mc_bus)
691 int disable_dprc_irq(struct fsl_mc_device *mc_dev);
692 int enable_dprc_irq(struct fsl_mc_device *mc_dev);
693 int get_dprc_irq_state(struct fsl_mc_device *mc_dev);
695 #endif /* _FSL_MC_PRIVATE_H_ */