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