1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2016-2019, Linaro Limited 4 */ 5 #ifndef __KERNEL_INTERRUPT_H 6 #define __KERNEL_INTERRUPT_H 7 8 #include <dt-bindings/interrupt-controller/irq.h> 9 #include <kernel/dt_driver.h> 10 #include <mm/core_memprot.h> 11 #include <sys/queue.h> 12 #include <tee_api_types.h> 13 #include <types_ext.h> 14 #include <util.h> 15 16 #define ITRF_TRIGGER_LEVEL BIT(0) 17 #define ITRF_SHARED BIT(1) 18 19 /* Forward the interrupt only to the current CPU */ 20 #define ITR_CPU_MASK_TO_THIS_CPU BIT(31) 21 /* Forward the interrupt to all CPUs except the current CPU */ 22 #define ITR_CPU_MASK_TO_OTHER_CPUS BIT(30) 23 24 struct itr_handler; 25 26 /* 27 * struct itr_chip - Interrupt controller 28 * 29 * @ops Operation callback functions 30 * @name Controller name, for debug purpose 31 * @handlers Registered handlers list head 32 * @dt_get_irq Device tree node parsing function 33 */ 34 struct itr_chip { 35 const struct itr_ops *ops; 36 const char *name; 37 SLIST_HEAD(, itr_handler) handlers; 38 /* 39 * dt_get_irq - parse a device tree interrupt property 40 * 41 * @properties raw interrupt property from device tree 42 * @count number of elements in @properties 43 * @type If not NULL, output interrupt type (IRQ_TYPE_* defines) 44 * or IRQ_TYPE_NONE if unknown 45 * @prio If not NULL, output interrupt priority value or 0 if unknown 46 */ 47 int (*dt_get_irq)(const uint32_t *properties, int count, uint32_t *type, 48 uint32_t *prio); 49 }; 50 51 /* 52 * struct itr_ops - Interrupt controller operations 53 * @add Register and configure an interrupt 54 * @enable Enable an interrupt 55 * @disable Disable an interrupt 56 * @mask Mask an interrupt, may be called from an interrupt context 57 * @unmask Unmask an interrupt, may be called from an interrupt context 58 * @raise_pi Raise per-cpu interrupt or NULL if not applicable 59 * @raise_sgi Raise a SGI or NULL if not applicable to that controller 60 * @set_affinity Set interrupt/cpu affinity or NULL if not applicable 61 * 62 * Handlers @enable, @disable, @mask, @unmask and @add are mandated. Handlers 63 * @mask and @unmask have unpaged memory contrainsts. See itr_chip_is_valid(). 64 */ 65 struct itr_ops { 66 void (*add)(struct itr_chip *chip, size_t it, uint32_t type, 67 uint32_t prio); 68 void (*enable)(struct itr_chip *chip, size_t it); 69 void (*disable)(struct itr_chip *chip, size_t it); 70 void (*mask)(struct itr_chip *chip, size_t it); 71 void (*unmask)(struct itr_chip *chip, size_t it); 72 void (*raise_pi)(struct itr_chip *chip, size_t it); 73 void (*raise_sgi)(struct itr_chip *chip, size_t it, 74 uint32_t cpu_mask); 75 void (*set_affinity)(struct itr_chip *chip, size_t it, 76 uint8_t cpu_mask); 77 }; 78 79 /* 80 * struct itr_desc - Interrupt description 81 * @chip Interrupt controller reference 82 * @itr_num Interrupt number 83 * 84 * This struct is used for binding interrupt device data between 85 * drivers when using DT_DRIVERS means. See itr_dt_get_func type 86 * definition. 87 */ 88 struct itr_desc { 89 struct itr_chip *chip; 90 size_t itr_num; 91 }; 92 93 /* Interrupt handler return value */ 94 enum itr_return { 95 ITRR_NONE, 96 ITRR_HANDLED, 97 }; 98 99 /* Interrupt handler signature */ 100 typedef enum itr_return (*itr_handler_t)(struct itr_handler *h); 101 102 /* 103 * struct itr_handler - Interrupt handler reference 104 * @it Interrupt number 105 * @flags Property bit flags (ITRF_*) or 0 106 * @data Private data for that interrupt handler 107 * @chip Interrupt controller chip device 108 * @link Reference in controller handler list 109 */ 110 struct itr_handler { 111 size_t it; 112 uint32_t flags; 113 itr_handler_t handler; 114 void *data; 115 struct itr_chip *chip; 116 SLIST_ENTRY(itr_handler) link; 117 }; 118 119 #define ITR_HANDLER(_chip, _itr_num, _flags, _fn, _priv) \ 120 ((struct itr_handler){ \ 121 .chip = (_chip), .it = (_itr_num), .flags = (_flags), \ 122 .handler = (_fn), .data = (_priv), \ 123 }) 124 125 /* 126 * Return true only if interrupt chip provides required handlers 127 * @chip: Interrupt controller reference 128 */ 129 static inline bool itr_chip_is_valid(struct itr_chip *chip) 130 { 131 return chip && is_unpaged(chip) && chip->ops && 132 is_unpaged((void *)chip->ops) && 133 chip->ops->mask && is_unpaged(chip->ops->mask) && 134 chip->ops->unmask && is_unpaged(chip->ops->unmask) && 135 chip->ops->enable && chip->ops->disable && 136 chip->ops->add; 137 } 138 139 /* 140 * Initialise an interrupt controller handle 141 * @chip Interrupt controller 142 */ 143 TEE_Result itr_chip_init(struct itr_chip *chip); 144 145 /* 146 * Initialise main interrupt controller driver 147 * @data Main controller main data reference to register 148 */ 149 void interrupt_main_init(struct itr_chip *data); 150 151 /* Retrieve main interrupt controller reference */ 152 struct itr_chip *interrupt_get_main_chip(void); 153 154 #ifdef CFG_DT 155 /* 156 * Get the DT interrupt property at @node. In the DT an interrupt property can 157 * specify additional information which can be retrieved with @type and @prio. 158 * 159 * @fdt reference to the Device Tree 160 * @node is the node offset to read the interrupt property from 161 * @type interrupt type (IRQ_TYPE_* defines) if specified by interrupt property 162 * or IRQ_TYPE_NONE if not. Can be NULL if not needed 163 * @prio interrupt priority if specified by interrupt property or 0 if not. Can 164 * be NULL if not needed 165 * 166 * Returns the interrupt number if value >= 0 167 * otherwise DT_INFO_INVALID_INTERRUPT 168 */ 169 int dt_get_irq_type_prio(const void *fdt, int node, uint32_t *type, 170 uint32_t *prio); 171 172 /* 173 * Get the DT interrupt property at @node 174 */ 175 static inline int dt_get_irq(const void *fdt, int node) 176 { 177 return dt_get_irq_type_prio(fdt, node, NULL, NULL); 178 } 179 #endif 180 181 /* 182 * __weak overridable function which is called when a secure interrupt is 183 * received. The default function calls panic() immediately, platforms which 184 * expects to receive secure interrupts should override this function. 185 */ 186 void interrupt_main_handler(void); 187 188 /* 189 * Interrupt controller chip API functions 190 */ 191 192 /* 193 * interrupt_call_handlers() - Call registered handlers for an interrupt 194 * @chip Interrupt controller 195 * @itr_num Interrupt number 196 * 197 * This function is called from an interrupt context by a primary interrupt 198 * handler. This function calls the handlers registered for that interrupt. 199 * If interrupt is not handled, it is masked. 200 */ 201 void interrupt_call_handlers(struct itr_chip *chip, size_t itr_num); 202 203 /* 204 * interrupt_mask() - Mask an interrupt 205 * @chip Interrupt controller 206 * @itr_num Interrupt number 207 * 208 * This function may be called in interrupt context 209 */ 210 static inline void interrupt_mask(struct itr_chip *chip, size_t itr_num) 211 { 212 chip->ops->mask(chip, itr_num); 213 } 214 215 /* 216 * interrupt_unmask() - Unmask an interrupt 217 * @chip Interrupt controller 218 * @itr_num Interrupt number 219 * 220 * This function may be called in interrupt context 221 */ 222 static inline void interrupt_unmask(struct itr_chip *chip, size_t itr_num) 223 { 224 chip->ops->unmask(chip, itr_num); 225 } 226 227 /* 228 * interrupt_enable() - Enable an interrupt 229 * @chip Interrupt controller 230 * @itr_num Interrupt number 231 */ 232 static inline void interrupt_enable(struct itr_chip *chip, size_t itr_num) 233 { 234 chip->ops->enable(chip, itr_num); 235 } 236 237 /* 238 * interrupt_disable() - Disable an interrupt 239 * @chip Interrupt controller 240 * @itr_num Interrupt number 241 */ 242 static inline void interrupt_disable(struct itr_chip *chip, size_t itr_num) 243 { 244 chip->ops->disable(chip, itr_num); 245 } 246 247 /* 248 * interrupt_can_raise_pi() - Return whether controller embeds raise_pi 249 * @chip Interrupt controller 250 */ 251 static inline bool interrupt_can_raise_pi(struct itr_chip *chip) 252 { 253 return chip->ops->raise_pi; 254 } 255 256 /* 257 * interrupt_can_raise_sgi() - Return whether controller embeds raise_sgi 258 * @chip Interrupt controller 259 */ 260 static inline bool interrupt_can_raise_sgi(struct itr_chip *chip) 261 { 262 return chip->ops->raise_sgi; 263 } 264 265 /* 266 * interrupt_can_set_affinity() - Return whether controller embeds set_affinity 267 * @chip Interrupt controller 268 */ 269 static inline bool interrupt_can_set_affinity(struct itr_chip *chip) 270 { 271 return chip->ops->set_affinity; 272 } 273 274 /* 275 * interrupt_raise_pi() - Raise a peripheral interrupt of a controller 276 * @chip Interrupt controller 277 * @itr_num Interrupt number to raise 278 */ 279 static inline void interrupt_raise_pi(struct itr_chip *chip, size_t itr_num) 280 { 281 assert(interrupt_can_raise_pi(chip)); 282 chip->ops->raise_pi(chip, itr_num); 283 } 284 285 /* 286 * interrupt_raise_sgi() - Raise a software generiated interrupt of a controller 287 * @chip Interrupt controller 288 * @itr_num Interrupt number to raise 289 * @cpu_mask: A bitfield of CPUs to forward the interrupt to, unless 290 * ITR_CPU_MASK_TO_THIS_CPU or ITR_CPU_MASK_TO_OTHER_CPUS 291 * (mutually exclusive) are set. 292 */ 293 static inline void interrupt_raise_sgi(struct itr_chip *chip, size_t itr_num, 294 uint32_t cpu_mask) 295 { 296 assert(interrupt_can_raise_sgi(chip)); 297 chip->ops->raise_sgi(chip, itr_num, cpu_mask); 298 } 299 300 /* 301 * interrupt_set_affinity() - Set CPU affinity for a controller interrupt 302 * @chip Interrupt controller 303 * @itr_num Interrupt number to raise 304 * @cpu_mask Mask of the CPUs targeted by the interrupt 305 */ 306 static inline void interrupt_set_affinity(struct itr_chip *chip, size_t itr_num, 307 uint8_t cpu_mask) 308 { 309 assert(interrupt_can_set_affinity(chip)); 310 chip->ops->set_affinity(chip, itr_num, cpu_mask); 311 } 312 313 /* 314 * interrupt_configure() - Configure an interrupt in an interrupt controller 315 * @chip Interrupt controller 316 * @itr_num Interrupt number 317 * @type Interrupt trigger type (IRQ_TYPE_* defines) or IRQ_TYPE_NONE 318 * @prio Interrupt priority or 0 319 * 320 * Interrupt consumers that get their interrupt from the DT do not need to 321 * call interrupt_configure() since the interrupt configuration has already 322 * been done by interrupt controller based on the DT bidings. 323 */ 324 TEE_Result interrupt_configure(struct itr_chip *chip, size_t itr_num, 325 uint32_t type, uint32_t prio); 326 327 /* 328 * interrupt_add_and_configure_handler() - Register and configure a handler 329 * @hdl Interrupt handler to register 330 * @type Interrupt trigger type (IRQ_TYPE_* defines) or IRQ_TYPE_NONE 331 * @prio Interrupt priority or 0 332 */ 333 TEE_Result interrupt_add_configure_handler(struct itr_handler *hdl, 334 uint32_t type, uint32_t prio); 335 336 /* 337 * interrupt_add_handler() - Register an interrupt handler 338 * @hdl Interrupt handler to register 339 * 340 * This helper function assumes interrupt type is set to IRQ_TYPE_NONE 341 * and interrupt priority to 0. 342 */ 343 static inline TEE_Result interrupt_add_handler(struct itr_handler *hdl) 344 { 345 return interrupt_add_configure_handler(hdl, IRQ_TYPE_NONE, 0); 346 } 347 348 /* 349 * interrupt_create_handler() - Allocate/register an interrupt callback handler 350 * @itr_chip Interrupt chip obtained from dt_get_interrupt_by_*() 351 * @itr_num Interrupt number obtained from dt_get_interrupt_by_*() 352 * @callback Callback handler function 353 * @priv Private dat to pssa to @callback 354 * @flags INTERRUPT_FLAGS_* or 0 355 * @out_hdl Output allocated and registered handler or NULL 356 * 357 * This function differs from interrupt_add_handler() in that the 358 * interrupt is not reconfigured. interrupt_create_handler() expects 359 * @itr_desc was obtained from a call to dt_get_interrupt_by_index() 360 * or dt_get_interrupt_by_name(). That call configured the interrupt. 361 */ 362 TEE_Result interrupt_create_handler(struct itr_chip *itr_chip, size_t itr_num, 363 itr_handler_t callback, void *priv, 364 uint32_t flags, 365 struct itr_handler **out_hdl); 366 367 /* 368 * interrupt_add_handler_with_chip() - Register an interrupt handler providing 369 * the interrupt chip reference in specific argument @chip. 370 * @chip Interrupt controller 371 * @h Interrupt handler to register 372 */ 373 static inline TEE_Result interrupt_add_handler_with_chip(struct itr_chip *chip, 374 struct itr_handler *h) 375 { 376 h->chip = chip; 377 return interrupt_add_handler(h); 378 } 379 380 /* 381 * interrupt_remove_handler() - Remove a registered interrupt handler 382 * @hdl Interrupt handler to remove 383 * 384 * This function is the counterpart of interrupt_add_handler(). 385 * This function may panic on non-NULL invalid @hdl reference. 386 */ 387 void interrupt_remove_handler(struct itr_handler *hdl); 388 389 /* 390 * interrupt_alloc_add_conf_handler() - Allocate, configure, register a handler 391 * @chip Interrupt controller 392 * @itr_num Interrupt number 393 * @handler Interrupt handler to register 394 * @flags Bitmask flag ITRF_* 395 * @data Private data reference passed to @handler 396 * @type Interrupt trigger type (IRQ_TYPE_* defines) or IRQ_TYPE_NONE 397 * @prio Interrupt priority or 0 398 * @out_hdl NULL or output pointer to allocated struct itr_handler 399 */ 400 TEE_Result interrupt_alloc_add_conf_handler(struct itr_chip *chip, 401 size_t it_num, 402 itr_handler_t handler, 403 uint32_t flags, void *data, 404 uint32_t type, uint32_t prio, 405 struct itr_handler **out_hdl); 406 407 /* 408 * interrupt_alloc_add_handler() - Allocate and register an interrupt handler 409 * @chip Interrupt controller 410 * @itr_num Interrupt number 411 * @handler Interrupt handler to register 412 * @flags Bitmask flag ITRF_* 413 * @data Private data reference passed to @handler 414 * @out_hdl NULL or output pointer to allocated struct itr_handler 415 */ 416 static inline TEE_Result interrupt_alloc_add_handler(struct itr_chip *chip, 417 size_t it_num, 418 itr_handler_t handler, 419 uint32_t flags, 420 void *data, 421 struct itr_handler **hdl) 422 { 423 return interrupt_alloc_add_conf_handler(chip, it_num, handler, flags, 424 data, IRQ_TYPE_NONE, 0, hdl); 425 } 426 427 /* 428 * interrupt_remove_free_handler() - Remove/free a registered interrupt handler 429 * @hdl Interrupt handler to remove and free 430 * 431 * This function is the counterpart of interrupt_alloc_add_handler() 432 * and interrupt_alloc_add_conf_handler(). 433 * This function may panic on non-NULL invalid @hdl reference. 434 */ 435 void interrupt_remove_free_handler(struct itr_handler *hdl); 436 437 /* 438 * itr_dt_get_func - Typedef of function to get an interrupt in DT node 439 * 440 * @args Reference to phandle arguments 441 * @data Pointer to data given at interrupt_register_provider() call 442 * @itr_desc_p Pointer to the struct itr_desc to fill 443 * Return TEE_SUCCESS in case of success. 444 * Return TEE_ERROR_DEFER_DRIVER_INIT if controller is not initialized. 445 * Return another TEE_Result code otherwise. 446 * 447 * Upon success, the interrupt is configured and consumer can add a handler 448 * function to the interrupt. Yet, the interrupt is not enabled until consumer 449 * calls interrupt_enable(). 450 */ 451 typedef TEE_Result (*itr_dt_get_func)(struct dt_pargs *args, void *data, 452 struct itr_desc *itr_desc_p); 453 454 #ifdef CFG_DT 455 /** 456 * interrupt_register_provider() - Register an interrupt provider 457 * 458 * @fdt Device tree to work on 459 * @node Node offset of the interrupt controller in the DT 460 * @dt_get_itr Callback to match the devicetree interrupt reference with 461 * @data Data which will be passed to the get_dt_its callback 462 */ 463 TEE_Result interrupt_register_provider(const void *fdt, int node, 464 itr_dt_get_func dt_get_itr, void *data); 465 466 /** 467 * interrupt_dt_get_by_index() - Get an interrupt from DT by interrupt index 468 * 469 * Interrupt index (@index) refers to the index of the target interrupt to be 470 * retrieved as DT binding property "interrupts" may define several 471 * interrupts. 472 * 473 * @fdt Device tree to work on 474 * @node Node offset of the subnode containing interrupt(s) references 475 * @index Index in "interrupts" or "extended-interrupts" property list 476 * @chip Output interrupt controller reference upon success 477 * @itr_num Output interrupt number upon success 478 * 479 * Return TEE_SUCCESS in case of success 480 * Return TEE_ERROR_DEFER_DRIVER_INIT if interrupt driver is not yet initialized 481 * Return TEE_ERROR_ITEM_NOT_FOUND if the DT does not reference target interrupt 482 * Return any other TEE_Result compliant code in case of error 483 */ 484 TEE_Result interrupt_dt_get_by_index(const void *fdt, int node, 485 unsigned int index, struct itr_chip **chip, 486 size_t *itr_num); 487 488 /** 489 * interrupt_dt_get_by_name() - Get an interrupt from DT by interrupt name 490 * 491 * @fdt Device tree to work on 492 * @node Node offset of the subnode containing interrupt(s) references 493 * @name Name identifier used in "interrupt-names" property 494 * @chip Output interrupt controller reference upon success 495 * @itr_num Output interrupt number upon success 496 * 497 * Return TEE_SUCCESS in case of success 498 * Return TEE_ERROR_DEFER_DRIVER_INIT if interrupt driver is not yet initialized 499 * Return TEE_ERROR_ITEM_NOT_FOUND if the DT does not reference target interrupt 500 * Return any other TEE_Result compliant code in case of error 501 */ 502 TEE_Result interrupt_dt_get_by_name(const void *fdt, int node, const char *name, 503 struct itr_chip **chip, size_t *itr_num); 504 #else 505 static inline TEE_Result interrupt_register_provider(const void *dt __unused, 506 int node __unused, 507 itr_dt_get_func f __unused, 508 void *data __unused) 509 { 510 return TEE_ERROR_NOT_IMPLEMENTED; 511 } 512 513 static inline TEE_Result interrupt_dt_get_by_index(const void *fdt __unused, 514 int node __unused, 515 unsigned int index __unused, 516 struct itr_chip **c __unused, 517 size_t *itr_num __unused) 518 { 519 return TEE_ERROR_NOT_IMPLEMENTED; 520 } 521 522 static inline TEE_Result interrupt_dt_get_by_name(const void *fdt __unused, 523 int node __unused, 524 const char *name __unused, 525 struct itr_chip **ch __unused, 526 size_t *itr_num __unused) 527 { 528 return TEE_ERROR_NOT_IMPLEMENTED; 529 } 530 #endif /*CFG_DT*/ 531 532 /* 533 * Helper function for when caller retrieves the first interrupt defined 534 * in "interrupts" or "extended-interrupts" DT binding property list. 535 */ 536 static inline TEE_Result interrupt_dt_get(const void *fdt, int node, 537 struct itr_chip **chip, 538 size_t *itr_num) 539 { 540 return interrupt_dt_get_by_index(fdt, node, 0, chip, itr_num); 541 } 542 #endif /*__KERNEL_INTERRUPT_H*/ 543