1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Freescale Management Complex (MC) bus public interface
5 * Copyright (C) 2014-2016 Freescale Semiconductor, Inc.
12 #include <linux/device.h>
13 #include <linux/mod_devicetable.h>
14 #include <linux/interrupt.h>
16 #define FSL_MC_VENDOR_FREESCALE 0x1957
19 struct msi_domain_info;
25 * struct fsl_mc_driver - MC object device driver object
26 * @driver: Generic device driver
27 * @match_id_table: table of supported device matching Ids
28 * @probe: Function called when a device is added
29 * @remove: Function called when a device is removed
30 * @shutdown: Function called at shutdown time to quiesce the device
31 * @suspend: Function called when a device is stopped
32 * @resume: Function called when a device is resumed
34 * Generic DPAA device driver object for device drivers that are registered
35 * with a DPRC bus. This structure is to be embedded in each device-specific
38 struct fsl_mc_driver {
39 struct device_driver driver;
40 const struct fsl_mc_device_id *match_id_table;
41 int (*probe)(struct fsl_mc_device *dev);
42 int (*remove)(struct fsl_mc_device *dev);
43 void (*shutdown)(struct fsl_mc_device *dev);
44 int (*suspend)(struct fsl_mc_device *dev, pm_message_t state);
45 int (*resume)(struct fsl_mc_device *dev);
48 #define to_fsl_mc_driver(_drv) \
49 container_of(_drv, struct fsl_mc_driver, driver)
52 * enum fsl_mc_pool_type - Types of allocatable MC bus resources
54 * Entries in these enum are used as indices in the array of resource
55 * pools of an fsl_mc_bus object.
57 enum fsl_mc_pool_type {
58 FSL_MC_POOL_DPMCP = 0x0, /* corresponds to "dpmcp" in the MC */
59 FSL_MC_POOL_DPBP, /* corresponds to "dpbp" in the MC */
60 FSL_MC_POOL_DPCON, /* corresponds to "dpcon" in the MC */
64 * NOTE: New resource pool types must be added before this entry
70 * struct fsl_mc_resource - MC generic resource
71 * @type: type of resource
72 * @id: unique MC resource Id within the resources of the same type
73 * @data: pointer to resource-specific data if the resource is currently
74 * allocated, or NULL if the resource is not currently allocated.
75 * @parent_pool: pointer to the parent resource pool from which this
76 * resource is allocated from.
77 * @node: Node in the free list of the corresponding resource pool
79 * NOTE: This structure is to be embedded as a field of specific
80 * MC resource structures.
82 struct fsl_mc_resource {
83 enum fsl_mc_pool_type type;
86 struct fsl_mc_resource_pool *parent_pool;
87 struct list_head node;
91 * struct fsl_mc_device_irq - MC object device message-based interrupt
92 * @msi_desc: pointer to MSI descriptor allocated by fsl_mc_msi_alloc_descs()
93 * @mc_dev: MC object device that owns this interrupt
94 * @dev_irq_index: device-relative IRQ index
95 * @resource: MC generic resource associated with the interrupt
97 struct fsl_mc_device_irq {
98 struct msi_desc *msi_desc;
99 struct fsl_mc_device *mc_dev;
101 struct fsl_mc_resource resource;
104 #define to_fsl_mc_irq(_mc_resource) \
105 container_of(_mc_resource, struct fsl_mc_device_irq, resource)
107 /* Opened state - Indicates that an object is open by at least one owner */
108 #define FSL_MC_OBJ_STATE_OPEN 0x00000001
109 /* Plugged state - Indicates that the object is plugged */
110 #define FSL_MC_OBJ_STATE_PLUGGED 0x00000002
113 * Shareability flag - Object flag indicating no memory shareability.
114 * the object generates memory accesses that are non coherent with other
116 * user is responsible for proper memory handling through IOMMU configuration.
118 #define FSL_MC_OBJ_FLAG_NO_MEM_SHAREABILITY 0x0001
121 * struct fsl_mc_obj_desc - Object descriptor
122 * @type: Type of object: NULL terminated string
123 * @id: ID of logical object resource
124 * @vendor: Object vendor identifier
125 * @ver_major: Major version number
126 * @ver_minor: Minor version number
127 * @irq_count: Number of interrupts supported by the object
128 * @region_count: Number of mappable regions supported by the object
129 * @state: Object state: combination of FSL_MC_OBJ_STATE_ states
130 * @label: Object label: NULL terminated string
131 * @flags: Object's flags
133 struct fsl_mc_obj_desc {
147 * Bit masks for a MC object device (struct fsl_mc_device) flags
149 #define FSL_MC_IS_DPRC 0x0001
152 * struct fsl_mc_device - MC object device object
153 * @dev: Linux driver model device object
154 * @dma_mask: Default DMA mask
155 * @flags: MC object device flags
156 * @icid: Isolation context ID for the device
157 * @mc_handle: MC handle for the corresponding MC object opened
158 * @mc_io: Pointer to MC IO object assigned to this device or
160 * @obj_desc: MC description of the DPAA device
161 * @regions: pointer to array of MMIO region entries
162 * @irqs: pointer to array of pointers to interrupts allocated to this device
163 * @resource: generic resource associated with this MC object device, if any.
165 * Generic device object for MC object devices that are "attached" to a
169 * - For a non-DPRC object its icid is the same as its parent DPRC's icid.
170 * - The SMMU notifier callback gets invoked after device_add() has been
171 * called for an MC object device, but before the device-specific probe
172 * callback gets called.
173 * - DP_OBJ_DPRC objects are the only MC objects that have built-in MC
174 * portals. For all other MC objects, their device drivers are responsible for
175 * allocating MC portals for them by calling fsl_mc_portal_allocate().
176 * - Some types of MC objects (e.g., DP_OBJ_DPBP, DP_OBJ_DPCON) are
177 * treated as resources that can be allocated/deallocated from the
178 * corresponding resource pool in the object's parent DPRC, using the
179 * fsl_mc_object_allocate()/fsl_mc_object_free() functions. These MC objects
180 * are known as "allocatable" objects. For them, the corresponding
181 * fsl_mc_device's 'resource' points to the associated resource object.
182 * For MC objects that are not allocatable (e.g., DP_OBJ_DPRC, DP_OBJ_DPNI),
183 * 'resource' is NULL.
185 struct fsl_mc_device {
191 struct fsl_mc_io *mc_io;
192 struct fsl_mc_obj_desc obj_desc;
193 struct resource *regions;
194 struct fsl_mc_device_irq **irqs;
195 struct fsl_mc_resource *resource;
196 struct device_link *consumer_link;
199 #define to_fsl_mc_device(_dev) \
200 container_of(_dev, struct fsl_mc_device, dev)
202 #define MC_CMD_NUM_OF_PARAMS 7
204 struct mc_cmd_header {
213 struct fsl_mc_command {
215 __le64 params[MC_CMD_NUM_OF_PARAMS];
219 MC_CMD_STATUS_OK = 0x0, /* Completed successfully */
220 MC_CMD_STATUS_READY = 0x1, /* Ready to be processed */
221 MC_CMD_STATUS_AUTH_ERR = 0x3, /* Authentication error */
222 MC_CMD_STATUS_NO_PRIVILEGE = 0x4, /* No privilege */
223 MC_CMD_STATUS_DMA_ERR = 0x5, /* DMA or I/O error */
224 MC_CMD_STATUS_CONFIG_ERR = 0x6, /* Configuration error */
225 MC_CMD_STATUS_TIMEOUT = 0x7, /* Operation timed out */
226 MC_CMD_STATUS_NO_RESOURCE = 0x8, /* No resources */
227 MC_CMD_STATUS_NO_MEMORY = 0x9, /* No memory available */
228 MC_CMD_STATUS_BUSY = 0xA, /* Device is busy */
229 MC_CMD_STATUS_UNSUPPORTED_OP = 0xB, /* Unsupported operation */
230 MC_CMD_STATUS_INVALID_STATE = 0xC /* Invalid state */
237 /* High priority flag */
238 #define MC_CMD_FLAG_PRI 0x80
239 /* Command completion flag */
240 #define MC_CMD_FLAG_INTR_DIS 0x01
242 static inline __le64 mc_encode_cmd_header(u16 cmd_id,
247 struct mc_cmd_header *hdr = (struct mc_cmd_header *)&header;
249 hdr->cmd_id = cpu_to_le16(cmd_id);
250 hdr->token = cpu_to_le16(token);
251 hdr->status = MC_CMD_STATUS_READY;
252 if (cmd_flags & MC_CMD_FLAG_PRI)
253 hdr->flags_hw = MC_CMD_FLAG_PRI;
254 if (cmd_flags & MC_CMD_FLAG_INTR_DIS)
255 hdr->flags_sw = MC_CMD_FLAG_INTR_DIS;
260 static inline u16 mc_cmd_hdr_read_token(struct fsl_mc_command *cmd)
262 struct mc_cmd_header *hdr = (struct mc_cmd_header *)&cmd->header;
263 u16 token = le16_to_cpu(hdr->token);
268 struct mc_rsp_create {
272 struct mc_rsp_api_ver {
277 static inline u32 mc_cmd_read_object_id(struct fsl_mc_command *cmd)
279 struct mc_rsp_create *rsp_params;
281 rsp_params = (struct mc_rsp_create *)cmd->params;
282 return le32_to_cpu(rsp_params->object_id);
285 static inline void mc_cmd_read_api_version(struct fsl_mc_command *cmd,
289 struct mc_rsp_api_ver *rsp_params;
291 rsp_params = (struct mc_rsp_api_ver *)cmd->params;
292 *major_ver = le16_to_cpu(rsp_params->major_ver);
293 *minor_ver = le16_to_cpu(rsp_params->minor_ver);
297 * Bit masks for a MC I/O object (struct fsl_mc_io) flags
299 #define FSL_MC_IO_ATOMIC_CONTEXT_PORTAL 0x0001
302 * struct fsl_mc_io - MC I/O object to be passed-in to mc_send_command()
303 * @dev: device associated with this Mc I/O object
304 * @flags: flags for mc_send_command()
305 * @portal_size: MC command portal size in bytes
306 * @portal_phys_addr: MC command portal physical address
307 * @portal_virt_addr: MC command portal virtual address
308 * @dpmcp_dev: pointer to the DPMCP device associated with the MC portal.
310 * Fields are only meaningful if the FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is not
312 * @mutex: Mutex to serialize mc_send_command() calls that use the same MC
313 * portal, if the fsl_mc_io object was created with the
314 * FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag off. mc_send_command() calls for this
315 * fsl_mc_io object must be made only from non-atomic context.
317 * Fields are only meaningful if the FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is
319 * @spinlock: Spinlock to serialize mc_send_command() calls that use the same MC
320 * portal, if the fsl_mc_io object was created with the
321 * FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag on. mc_send_command() calls for this
322 * fsl_mc_io object can be made from atomic or non-atomic context.
328 phys_addr_t portal_phys_addr;
329 void __iomem *portal_virt_addr;
330 struct fsl_mc_device *dpmcp_dev;
333 * This field is only meaningful if the
334 * FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is not set
336 struct mutex mutex; /* serializes mc_send_command() */
339 * This field is only meaningful if the
340 * FSL_MC_IO_ATOMIC_CONTEXT_PORTAL flag is set
342 spinlock_t spinlock; /* serializes mc_send_command() */
346 int mc_send_command(struct fsl_mc_io *mc_io, struct fsl_mc_command *cmd);
348 #ifdef CONFIG_FSL_MC_BUS
349 #define dev_is_fsl_mc(_dev) ((_dev)->bus == &fsl_mc_bus_type)
351 /* If fsl-mc bus is not present device cannot belong to fsl-mc bus */
352 #define dev_is_fsl_mc(_dev) (0)
355 /* Macro to check if a device is a container device */
356 #define fsl_mc_is_cont_dev(_dev) (to_fsl_mc_device(_dev)->flags & \
359 /* Macro to get the container device of a MC device */
360 #define fsl_mc_cont_dev(_dev) (fsl_mc_is_cont_dev(_dev) ? \
361 (_dev) : (_dev)->parent)
364 * module_fsl_mc_driver() - Helper macro for drivers that don't do
365 * anything special in module init/exit. This eliminates a lot of
366 * boilerplate. Each module may only use this macro once, and
367 * calling it replaces module_init() and module_exit()
369 #define module_fsl_mc_driver(__fsl_mc_driver) \
370 module_driver(__fsl_mc_driver, fsl_mc_driver_register, \
371 fsl_mc_driver_unregister)
374 * Macro to avoid include chaining to get THIS_MODULE
376 #define fsl_mc_driver_register(drv) \
377 __fsl_mc_driver_register(drv, THIS_MODULE)
379 int __must_check __fsl_mc_driver_register(struct fsl_mc_driver *fsl_mc_driver,
380 struct module *owner);
382 void fsl_mc_driver_unregister(struct fsl_mc_driver *driver);
385 * struct fsl_mc_version
386 * @major: Major version number: incremented on API compatibility changes
387 * @minor: Minor version number: incremented on API additions (that are
388 * backward compatible); reset when major version is incremented
389 * @revision: Internal revision number: incremented on implementation changes
390 * and/or bug fixes that have no impact on API
392 struct fsl_mc_version {
398 struct fsl_mc_version *fsl_mc_get_version(void);
400 int __must_check fsl_mc_portal_allocate(struct fsl_mc_device *mc_dev,
402 struct fsl_mc_io **new_mc_io);
404 void fsl_mc_portal_free(struct fsl_mc_io *mc_io);
406 int fsl_mc_portal_reset(struct fsl_mc_io *mc_io);
408 int __must_check fsl_mc_object_allocate(struct fsl_mc_device *mc_dev,
409 enum fsl_mc_pool_type pool_type,
410 struct fsl_mc_device **new_mc_adev);
412 void fsl_mc_object_free(struct fsl_mc_device *mc_adev);
414 struct irq_domain *fsl_mc_msi_create_irq_domain(struct fwnode_handle *fwnode,
415 struct msi_domain_info *info,
416 struct irq_domain *parent);
418 int __must_check fsl_mc_allocate_irqs(struct fsl_mc_device *mc_dev);
420 void fsl_mc_free_irqs(struct fsl_mc_device *mc_dev);
422 struct fsl_mc_device *fsl_mc_get_endpoint(struct fsl_mc_device *mc_dev);
424 extern struct bus_type fsl_mc_bus_type;
426 extern struct device_type fsl_mc_bus_dprc_type;
427 extern struct device_type fsl_mc_bus_dpni_type;
428 extern struct device_type fsl_mc_bus_dpio_type;
429 extern struct device_type fsl_mc_bus_dpsw_type;
430 extern struct device_type fsl_mc_bus_dpbp_type;
431 extern struct device_type fsl_mc_bus_dpcon_type;
432 extern struct device_type fsl_mc_bus_dpmcp_type;
433 extern struct device_type fsl_mc_bus_dpmac_type;
434 extern struct device_type fsl_mc_bus_dprtc_type;
435 extern struct device_type fsl_mc_bus_dpseci_type;
437 static inline bool is_fsl_mc_bus_dprc(const struct fsl_mc_device *mc_dev)
439 return mc_dev->dev.type == &fsl_mc_bus_dprc_type;
442 static inline bool is_fsl_mc_bus_dpni(const struct fsl_mc_device *mc_dev)
444 return mc_dev->dev.type == &fsl_mc_bus_dpni_type;
447 static inline bool is_fsl_mc_bus_dpio(const struct fsl_mc_device *mc_dev)
449 return mc_dev->dev.type == &fsl_mc_bus_dpio_type;
452 static inline bool is_fsl_mc_bus_dpsw(const struct fsl_mc_device *mc_dev)
454 return mc_dev->dev.type == &fsl_mc_bus_dpsw_type;
457 static inline bool is_fsl_mc_bus_dpbp(const struct fsl_mc_device *mc_dev)
459 return mc_dev->dev.type == &fsl_mc_bus_dpbp_type;
462 static inline bool is_fsl_mc_bus_dpcon(const struct fsl_mc_device *mc_dev)
464 return mc_dev->dev.type == &fsl_mc_bus_dpcon_type;
467 static inline bool is_fsl_mc_bus_dpmcp(const struct fsl_mc_device *mc_dev)
469 return mc_dev->dev.type == &fsl_mc_bus_dpmcp_type;
472 static inline bool is_fsl_mc_bus_dpmac(const struct fsl_mc_device *mc_dev)
474 return mc_dev->dev.type == &fsl_mc_bus_dpmac_type;
477 static inline bool is_fsl_mc_bus_dprtc(const struct fsl_mc_device *mc_dev)
479 return mc_dev->dev.type == &fsl_mc_bus_dprtc_type;
482 static inline bool is_fsl_mc_bus_dpseci(const struct fsl_mc_device *mc_dev)
484 return mc_dev->dev.type == &fsl_mc_bus_dpseci_type;
488 * Data Path Buffer Pool (DPBP) API
489 * Contains initialization APIs and runtime control APIs for DPBP
492 int dpbp_open(struct fsl_mc_io *mc_io,
497 int dpbp_close(struct fsl_mc_io *mc_io,
501 int dpbp_enable(struct fsl_mc_io *mc_io,
505 int dpbp_disable(struct fsl_mc_io *mc_io,
509 int dpbp_reset(struct fsl_mc_io *mc_io,
514 * struct dpbp_attr - Structure representing DPBP attributes
515 * @id: DPBP object ID
516 * @bpid: Hardware buffer pool ID; should be used as an argument in
517 * acquire/release operations on buffers
524 int dpbp_get_attributes(struct fsl_mc_io *mc_io,
527 struct dpbp_attr *attr);
529 /* Data Path Concentrator (DPCON) API
530 * Contains initialization APIs and runtime control APIs for DPCON
534 * Use it to disable notifications; see dpcon_set_notification()
536 #define DPCON_INVALID_DPIO_ID (int)(-1)
538 int dpcon_open(struct fsl_mc_io *mc_io,
543 int dpcon_close(struct fsl_mc_io *mc_io,
547 int dpcon_enable(struct fsl_mc_io *mc_io,
551 int dpcon_disable(struct fsl_mc_io *mc_io,
555 int dpcon_reset(struct fsl_mc_io *mc_io,
560 * struct dpcon_attr - Structure representing DPCON attributes
561 * @id: DPCON object ID
562 * @qbman_ch_id: Channel ID to be used by dequeue operation
563 * @num_priorities: Number of priorities for the DPCON channel (1-8)
571 int dpcon_get_attributes(struct fsl_mc_io *mc_io,
574 struct dpcon_attr *attr);
577 * struct dpcon_notification_cfg - Structure representing notification params
578 * @dpio_id: DPIO object ID; must be configured with a notification channel;
579 * to disable notifications set it to 'DPCON_INVALID_DPIO_ID';
580 * @priority: Priority selection within the DPIO channel; valid values
581 * are 0-7, depending on the number of priorities in that channel
582 * @user_ctx: User context value provided with each CDAN message
584 struct dpcon_notification_cfg {
590 int dpcon_set_notification(struct fsl_mc_io *mc_io,
593 struct dpcon_notification_cfg *cfg);
595 #endif /* _FSL_MC_H_ */