Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 | /* SPDX-License-Identifier: GPL-2.0 */ /* * Freescale Management Complex (MC) bus private declarations * * Copyright (C) 2016 Freescale Semiconductor, Inc. * */ #ifndef _FSL_MC_PRIVATE_H_ #define _FSL_MC_PRIVATE_H_ #include <linux/fsl/mc.h> #include <linux/mutex.h> #include <linux/ioctl.h> #include <linux/miscdevice.h> /* * Data Path Management Complex (DPMNG) General API */ /* DPMNG command versioning */ #define DPMNG_CMD_BASE_VERSION 1 #define DPMNG_CMD_ID_OFFSET 4 #define DPMNG_CMD(id) (((id) << DPMNG_CMD_ID_OFFSET) | DPMNG_CMD_BASE_VERSION) /* DPMNG command IDs */ #define DPMNG_CMDID_GET_VERSION DPMNG_CMD(0x831) struct dpmng_rsp_get_version { __le32 revision; __le32 version_major; __le32 version_minor; }; /* * Data Path Management Command Portal (DPMCP) API */ /* Minimal supported DPMCP Version */ #define DPMCP_MIN_VER_MAJOR 3 #define DPMCP_MIN_VER_MINOR 0 /* DPMCP command versioning */ #define DPMCP_CMD_BASE_VERSION 1 #define DPMCP_CMD_ID_OFFSET 4 #define DPMCP_CMD(id) (((id) << DPMCP_CMD_ID_OFFSET) | DPMCP_CMD_BASE_VERSION) /* DPMCP command IDs */ #define DPMCP_CMDID_CLOSE DPMCP_CMD(0x800) #define DPMCP_CMDID_RESET DPMCP_CMD(0x005) struct dpmcp_cmd_open { __le32 dpmcp_id; }; /* * Initialization and runtime control APIs for DPMCP */ int dpmcp_open(struct fsl_mc_io *mc_io, u32 cmd_flags, int dpmcp_id, u16 *token); int dpmcp_close(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); int dpmcp_reset(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); /* * Data Path Resource Container (DPRC) API */ /* Minimal supported DPRC Version */ #define DPRC_MIN_VER_MAJOR 6 #define DPRC_MIN_VER_MINOR 0 /* DPRC command versioning */ #define DPRC_CMD_BASE_VERSION 1 #define DPRC_CMD_2ND_VERSION 2 #define DPRC_CMD_3RD_VERSION 3 #define DPRC_CMD_ID_OFFSET 4 #define DPRC_CMD(id) (((id) << DPRC_CMD_ID_OFFSET) | DPRC_CMD_BASE_VERSION) #define DPRC_CMD_V2(id) (((id) << DPRC_CMD_ID_OFFSET) | DPRC_CMD_2ND_VERSION) #define DPRC_CMD_V3(id) (((id) << DPRC_CMD_ID_OFFSET) | DPRC_CMD_3RD_VERSION) /* DPRC command IDs */ #define DPRC_CMDID_CLOSE DPRC_CMD(0x800) #define DPRC_CMDID_GET_API_VERSION DPRC_CMD(0xa05) #define DPRC_CMDID_GET_ATTR DPRC_CMD(0x004) #define DPRC_CMDID_RESET_CONT DPRC_CMD(0x005) #define DPRC_CMDID_RESET_CONT_V2 DPRC_CMD_V2(0x005) #define DPRC_CMDID_SET_IRQ DPRC_CMD(0x010) #define DPRC_CMDID_SET_IRQ_ENABLE DPRC_CMD(0x012) #define DPRC_CMDID_SET_IRQ_MASK DPRC_CMD(0x014) #define DPRC_CMDID_GET_IRQ_STATUS DPRC_CMD(0x016) #define DPRC_CMDID_CLEAR_IRQ_STATUS DPRC_CMD(0x017) #define DPRC_CMDID_GET_CONT_ID DPRC_CMD(0x830) #define DPRC_CMDID_GET_OBJ_COUNT DPRC_CMD(0x159) #define DPRC_CMDID_GET_OBJ DPRC_CMD(0x15A) #define DPRC_CMDID_GET_OBJ_REG DPRC_CMD(0x15E) #define DPRC_CMDID_GET_OBJ_REG_V2 DPRC_CMD_V2(0x15E) #define DPRC_CMDID_GET_OBJ_REG_V3 DPRC_CMD_V3(0x15E) #define DPRC_CMDID_SET_OBJ_IRQ DPRC_CMD(0x15F) #define DPRC_CMDID_GET_CONNECTION DPRC_CMD(0x16C) struct dprc_cmd_open { __le32 container_id; }; struct dprc_cmd_reset_container { __le32 child_container_id; __le32 options; }; struct dprc_cmd_set_irq { /* cmd word 0 */ __le32 irq_val; u8 irq_index; u8 pad[3]; /* cmd word 1 */ __le64 irq_addr; /* cmd word 2 */ __le32 irq_num; }; #define DPRC_ENABLE 0x1 struct dprc_cmd_set_irq_enable { u8 enable; u8 pad[3]; u8 irq_index; }; struct dprc_cmd_set_irq_mask { __le32 mask; u8 irq_index; }; struct dprc_cmd_get_irq_status { __le32 status; u8 irq_index; }; struct dprc_rsp_get_irq_status { __le32 status; }; struct dprc_cmd_clear_irq_status { __le32 status; u8 irq_index; }; struct dprc_rsp_get_attributes { /* response word 0 */ __le32 container_id; __le32 icid; /* response word 1 */ __le32 options; __le32 portal_id; }; struct dprc_rsp_get_obj_count { __le32 pad; __le32 obj_count; }; struct dprc_cmd_get_obj { __le32 obj_index; }; struct dprc_rsp_get_obj { /* response word 0 */ __le32 pad0; __le32 id; /* response word 1 */ __le16 vendor; u8 irq_count; u8 region_count; __le32 state; /* response word 2 */ __le16 version_major; __le16 version_minor; __le16 flags; __le16 pad1; /* response word 3-4 */ u8 type[16]; /* response word 5-6 */ u8 label[16]; }; struct dprc_cmd_get_obj_region { /* cmd word 0 */ __le32 obj_id; __le16 pad0; u8 region_index; u8 pad1; /* cmd word 1-2 */ __le64 pad2[2]; /* cmd word 3-4 */ u8 obj_type[16]; }; struct dprc_rsp_get_obj_region { /* response word 0 */ __le64 pad0; /* response word 1 */ __le64 base_offset; /* response word 2 */ __le32 size; u8 type; u8 pad2[3]; /* response word 3 */ __le32 flags; __le32 pad3; /* response word 4 */ /* base_addr may be zero if older MC firmware is used */ __le64 base_addr; }; struct dprc_cmd_set_obj_irq { /* cmd word 0 */ __le32 irq_val; u8 irq_index; u8 pad[3]; /* cmd word 1 */ __le64 irq_addr; /* cmd word 2 */ __le32 irq_num; __le32 obj_id; /* cmd word 3-4 */ u8 obj_type[16]; }; struct dprc_cmd_get_connection { __le32 ep1_id; __le16 ep1_interface_id; u8 pad[2]; u8 ep1_type[16]; }; struct dprc_rsp_get_connection { __le64 pad[3]; __le32 ep2_id; __le16 ep2_interface_id; __le16 pad1; u8 ep2_type[16]; __le32 state; }; /* * DPRC API for managing and querying DPAA resources */ int dprc_open(struct fsl_mc_io *mc_io, u32 cmd_flags, int container_id, u16 *token); int dprc_close(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token); /* DPRC IRQ events */ /* IRQ event - Indicates that a new object added to the container */ #define DPRC_IRQ_EVENT_OBJ_ADDED 0x00000001 /* IRQ event - Indicates that an object was removed from the container */ #define DPRC_IRQ_EVENT_OBJ_REMOVED 0x00000002 /* * IRQ event - Indicates that one of the descendant containers that opened by * this container is destroyed */ #define DPRC_IRQ_EVENT_CONTAINER_DESTROYED 0x00000010 /* * IRQ event - Indicates that on one of the container's opened object is * destroyed */ #define DPRC_IRQ_EVENT_OBJ_DESTROYED 0x00000020 /* Irq event - Indicates that object is created at the container */ #define DPRC_IRQ_EVENT_OBJ_CREATED 0x00000040 /** * struct dprc_irq_cfg - IRQ configuration * @paddr: Address that must be written to signal a message-based interrupt * @val: Value to write into irq_addr address * @irq_num: A user defined number associated with this IRQ */ struct dprc_irq_cfg { phys_addr_t paddr; u32 val; int irq_num; }; int dprc_set_irq(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, struct dprc_irq_cfg *irq_cfg); int dprc_set_irq_enable(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u8 en); int dprc_set_irq_mask(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u32 mask); int dprc_get_irq_status(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u32 *status); int dprc_clear_irq_status(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, u8 irq_index, u32 status); /** * struct dprc_attributes - Container attributes * @container_id: Container's ID * @icid: Container's ICID * @portal_id: Container's portal ID * @options: Container's options as set at container's creation */ struct dprc_attributes { int container_id; u32 icid; int portal_id; u64 options; }; int dprc_get_attributes(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, struct dprc_attributes *attributes); int dprc_get_obj_count(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, int *obj_count); int dprc_get_obj(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, int obj_index, struct fsl_mc_obj_desc *obj_desc); int dprc_set_obj_irq(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, char *obj_type, int obj_id, u8 irq_index, struct dprc_irq_cfg *irq_cfg); /** * enum dprc_region_type - Region type * @DPRC_REGION_TYPE_MC_PORTAL: MC portal region * @DPRC_REGION_TYPE_QBMAN_PORTAL: Qbman portal region */ enum dprc_region_type { DPRC_REGION_TYPE_MC_PORTAL, DPRC_REGION_TYPE_QBMAN_PORTAL, DPRC_REGION_TYPE_QBMAN_MEM_BACKED_PORTAL }; /** * struct dprc_region_desc - Mappable region descriptor * @base_offset: Region offset from region's base address. * For DPMCP and DPRC objects, region base is offset from SoC MC portals * base address; For DPIO, region base is offset from SoC QMan portals * base address * @size: Region size (in bytes) * @flags: Region attributes * @type: Portal region type */ struct dprc_region_desc { u32 base_offset; u32 size; u32 flags; enum dprc_region_type type; u64 base_address; }; int dprc_get_obj_region(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, char *obj_type, int obj_id, u8 region_index, struct dprc_region_desc *region_desc); int dprc_get_api_version(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 *major_ver, u16 *minor_ver); int dprc_get_container_id(struct fsl_mc_io *mc_io, u32 cmd_flags, int *container_id); /** * struct dprc_endpoint - Endpoint description for link connect/disconnect * operations * @type: Endpoint object type: NULL terminated string * @id: Endpoint object ID * @if_id: Interface ID; should be set for endpoints with multiple * interfaces ("dpsw", "dpdmux"); for others, always set to 0 */ struct dprc_endpoint { char type[16]; int id; u16 if_id; }; int dprc_get_connection(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token, const struct dprc_endpoint *endpoint1, struct dprc_endpoint *endpoint2, int *state); /* * Data Path Buffer Pool (DPBP) API */ /* DPBP Version */ #define DPBP_VER_MAJOR 3 #define DPBP_VER_MINOR 2 /* Command versioning */ #define DPBP_CMD_BASE_VERSION 1 #define DPBP_CMD_ID_OFFSET 4 #define DPBP_CMD(id) (((id) << DPBP_CMD_ID_OFFSET) | DPBP_CMD_BASE_VERSION) /* Command IDs */ #define DPBP_CMDID_CLOSE DPBP_CMD(0x800) #define DPBP_CMDID_ENABLE DPBP_CMD(0x002) #define DPBP_CMDID_DISABLE DPBP_CMD(0x003) #define DPBP_CMDID_GET_ATTR DPBP_CMD(0x004) #define DPBP_CMDID_RESET DPBP_CMD(0x005) struct dpbp_cmd_open { __le32 dpbp_id; }; #define DPBP_ENABLE 0x1 struct dpbp_rsp_get_attributes { /* response word 0 */ __le16 pad; __le16 bpid; __le32 id; /* response word 1 */ __le16 version_major; __le16 version_minor; }; /* * Data Path Concentrator (DPCON) API */ /* DPCON Version */ #define DPCON_VER_MAJOR 3 #define DPCON_VER_MINOR 2 /* Command versioning */ #define DPCON_CMD_BASE_VERSION 1 #define DPCON_CMD_ID_OFFSET 4 #define DPCON_CMD(id) (((id) << DPCON_CMD_ID_OFFSET) | DPCON_CMD_BASE_VERSION) /* Command IDs */ #define DPCON_CMDID_CLOSE DPCON_CMD(0x800) #define DPCON_CMDID_ENABLE DPCON_CMD(0x002) #define DPCON_CMDID_DISABLE DPCON_CMD(0x003) #define DPCON_CMDID_GET_ATTR DPCON_CMD(0x004) #define DPCON_CMDID_RESET DPCON_CMD(0x005) #define DPCON_CMDID_SET_NOTIFICATION DPCON_CMD(0x100) struct dpcon_cmd_open { __le32 dpcon_id; }; #define DPCON_ENABLE 1 struct dpcon_rsp_get_attr { /* response word 0 */ __le32 id; __le16 qbman_ch_id; u8 num_priorities; u8 pad; }; struct dpcon_cmd_set_notification { /* cmd word 0 */ __le32 dpio_id; u8 priority; u8 pad[3]; /* cmd word 1 */ __le64 user_ctx; }; /* * Generic FSL MC API */ /* generic command versioning */ #define OBJ_CMD_BASE_VERSION 1 #define OBJ_CMD_ID_OFFSET 4 #define OBJ_CMD(id) (((id) << OBJ_CMD_ID_OFFSET) | OBJ_CMD_BASE_VERSION) /* open command codes */ #define DPRTC_CMDID_OPEN OBJ_CMD(0x810) #define DPNI_CMDID_OPEN OBJ_CMD(0x801) #define DPSW_CMDID_OPEN OBJ_CMD(0x802) #define DPIO_CMDID_OPEN OBJ_CMD(0x803) #define DPBP_CMDID_OPEN OBJ_CMD(0x804) #define DPRC_CMDID_OPEN OBJ_CMD(0x805) #define DPDMUX_CMDID_OPEN OBJ_CMD(0x806) #define DPCI_CMDID_OPEN OBJ_CMD(0x807) #define DPCON_CMDID_OPEN OBJ_CMD(0x808) #define DPSECI_CMDID_OPEN OBJ_CMD(0x809) #define DPAIOP_CMDID_OPEN OBJ_CMD(0x80a) #define DPMCP_CMDID_OPEN OBJ_CMD(0x80b) #define DPMAC_CMDID_OPEN OBJ_CMD(0x80c) #define DPDCEI_CMDID_OPEN OBJ_CMD(0x80d) #define DPDMAI_CMDID_OPEN OBJ_CMD(0x80e) #define DPDBG_CMDID_OPEN OBJ_CMD(0x80f) /* Generic object command IDs */ #define OBJ_CMDID_CLOSE OBJ_CMD(0x800) #define OBJ_CMDID_RESET OBJ_CMD(0x005) struct fsl_mc_obj_cmd_open { __le32 obj_id; }; /** * struct fsl_mc_resource_pool - Pool of MC resources of a given * type * @type: type of resources in the pool * @max_count: maximum number of resources in the pool * @free_count: number of free resources in the pool * @mutex: mutex to serialize access to the pool's free list * @free_list: anchor node of list of free resources in the pool * @mc_bus: pointer to the MC bus that owns this resource pool */ struct fsl_mc_resource_pool { enum fsl_mc_pool_type type; int max_count; int free_count; struct mutex mutex; /* serializes access to free_list */ struct list_head free_list; struct fsl_mc_bus *mc_bus; }; /** * struct fsl_mc_uapi - information associated with a device file * @misc: struct miscdevice linked to the root dprc * @device: newly created device in /dev * @mutex: mutex lock to serialize the open/release operations * @local_instance_in_use: local MC I/O instance in use or not * @static_mc_io: pointer to the static MC I/O object */ struct fsl_mc_uapi { struct miscdevice misc; struct device *device; struct mutex mutex; /* serialize open/release operations */ u32 local_instance_in_use; struct fsl_mc_io *static_mc_io; }; /** * struct fsl_mc_bus - logical bus that corresponds to a physical DPRC * @mc_dev: fsl-mc device for the bus device itself. * @resource_pools: array of resource pools (one pool per resource type) * for this MC bus. These resources represent allocatable entities * from the physical DPRC. * @irq_resources: Pointer to array of IRQ objects for the IRQ pool * @scan_mutex: Serializes bus scanning * @dprc_attr: DPRC attributes * @uapi_misc: struct that abstracts the interaction with userspace */ struct fsl_mc_bus { struct fsl_mc_device mc_dev; struct fsl_mc_resource_pool resource_pools[FSL_MC_NUM_POOL_TYPES]; struct fsl_mc_device_irq *irq_resources; struct mutex scan_mutex; /* serializes bus scanning */ struct dprc_attributes dprc_attr; struct fsl_mc_uapi uapi_misc; int irq_enabled; }; #define to_fsl_mc_bus(_mc_dev) \ container_of(_mc_dev, struct fsl_mc_bus, mc_dev) int __must_check fsl_mc_device_add(struct fsl_mc_obj_desc *obj_desc, struct fsl_mc_io *mc_io, struct device *parent_dev, struct fsl_mc_device **new_mc_dev); void fsl_mc_device_remove(struct fsl_mc_device *mc_dev); int __init dprc_driver_init(void); void dprc_driver_exit(void); int dprc_scan_objects(struct fsl_mc_device *mc_bus_dev, bool alloc_interrupts); int __init fsl_mc_allocator_driver_init(void); void fsl_mc_allocator_driver_exit(void); void fsl_mc_init_all_resource_pools(struct fsl_mc_device *mc_bus_dev); void fsl_mc_cleanup_all_resource_pools(struct fsl_mc_device *mc_bus_dev); int __must_check fsl_mc_resource_allocate(struct fsl_mc_bus *mc_bus, enum fsl_mc_pool_type pool_type, struct fsl_mc_resource **new_resource); void fsl_mc_resource_free(struct fsl_mc_resource *resource); int fsl_mc_msi_domain_alloc_irqs(struct device *dev, unsigned int irq_count); void fsl_mc_msi_domain_free_irqs(struct device *dev); struct irq_domain *fsl_mc_find_msi_domain(struct device *dev); int __must_check fsl_create_mc_io(struct device *dev, phys_addr_t mc_portal_phys_addr, u32 mc_portal_size, struct fsl_mc_device *dpmcp_dev, u32 flags, struct fsl_mc_io **new_mc_io); void fsl_destroy_mc_io(struct fsl_mc_io *mc_io); bool fsl_mc_is_root_dprc(struct device *dev); void fsl_mc_get_root_dprc(struct device *dev, struct device **root_dprc_dev); struct fsl_mc_device *fsl_mc_device_lookup(struct fsl_mc_obj_desc *obj_desc, struct fsl_mc_device *mc_bus_dev); u16 mc_cmd_hdr_read_cmdid(struct fsl_mc_command *cmd); #ifdef CONFIG_FSL_MC_UAPI_SUPPORT int fsl_mc_uapi_create_device_file(struct fsl_mc_bus *mc_bus); void fsl_mc_uapi_remove_device_file(struct fsl_mc_bus *mc_bus); #else static inline int fsl_mc_uapi_create_device_file(struct fsl_mc_bus *mc_bus) { return 0; } static inline void fsl_mc_uapi_remove_device_file(struct fsl_mc_bus *mc_bus) { } #endif int disable_dprc_irq(struct fsl_mc_device *mc_dev); int enable_dprc_irq(struct fsl_mc_device *mc_dev); int get_dprc_irq_state(struct fsl_mc_device *mc_dev); #endif /* _FSL_MC_PRIVATE_H_ */ |