Based on kernel version 6.3.13
. Page generated on 2023-08-29 08:35 EST
.
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 | ===================================================================== SEC 4 Device Tree Binding Copyright (C) 2008-2011 Freescale Semiconductor Inc. CONTENTS -Overview -SEC 4 Node -Job Ring Node -Run Time Integrity Check (RTIC) Node -Run Time Integrity Check (RTIC) Memory Node -Secure Non-Volatile Storage (SNVS) Node -Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node -Full Example NOTE: the SEC 4 is also known as Freescale's Cryptographic Accelerator Accelerator and Assurance Module (CAAM). ===================================================================== Overview DESCRIPTION SEC 4 h/w can process requests from 2 types of sources. 1. DPAA Queue Interface (HW interface between Queue Manager & SEC 4). 2. Job Rings (HW interface between cores & SEC 4 registers). High Speed Data Path Configuration: HW interface between QM & SEC 4 and also BM & SEC 4, on DPAA-enabled parts such as the P4080. The number of simultaneous dequeues the QI can make is equal to the number of Descriptor Controller (DECO) engines in a particular SEC version. E.g., the SEC 4.0 in the P4080 has 5 DECOs and can thus dequeue from 5 subportals simultaneously. Job Ring Data Path Configuration: Each JR is located on a separate 4k page, they may (or may not) be made visible in the memory partition devoted to a particular core. The P4080 has 4 JRs, so up to 4 JRs can be configured; and all 4 JRs process requests in parallel. ===================================================================== SEC 4 Node Description Node defines the base address of the SEC 4 block. This block specifies the address range of all global configuration registers for the SEC 4 block. It also receives interrupts from the Run Time Integrity Check (RTIC) function within the SEC 4 block. PROPERTIES - compatible Usage: required Value type: <string> Definition: Must include "fsl,sec-v4.0" - fsl,sec-era Usage: optional Value type: <u32> Definition: A standard property. Define the 'ERA' of the SEC device. - #address-cells Usage: required Value type: <u32> Definition: A standard property. Defines the number of cells for representing physical addresses in child nodes. - #size-cells Usage: required Value type: <u32> Definition: A standard property. Defines the number of cells for representing the size of physical addresses in child nodes. - reg Usage: required Value type: <prop-encoded-array> Definition: A standard property. Specifies the physical address and length of the SEC4 configuration registers. registers - ranges Usage: required Value type: <prop-encoded-array> Definition: A standard property. Specifies the physical address range of the SEC 4.0 register space (-SNVS not included). A triplet that includes the child address, parent address, & length. - interrupts Usage: required Value type: <prop_encoded-array> Definition: Specifies the interrupts generated by this device. The value of the interrupts property consists of one interrupt specifier. The format of the specifier is defined by the binding document describing the node's interrupt parent. - clocks Usage: required if SEC 4.0 requires explicit enablement of clocks Value type: <prop_encoded-array> Definition: A list of phandle and clock specifier pairs describing the clocks required for enabling and disabling SEC 4.0. - clock-names Usage: required if SEC 4.0 requires explicit enablement of clocks Value type: <string> Definition: A list of clock name strings in the same order as the clocks property. Note: All other standard properties (see the Devicetree Specification) are allowed but are optional. EXAMPLE iMX6QDL/SX requires four clocks crypto@300000 { compatible = "fsl,sec-v4.0"; fsl,sec-era = <2>; #address-cells = <1>; #size-cells = <1>; reg = <0x300000 0x10000>; ranges = <0 0x300000 0x10000>; interrupt-parent = <&mpic>; interrupts = <92 2>; clocks = <&clks IMX6QDL_CLK_CAAM_MEM>, <&clks IMX6QDL_CLK_CAAM_ACLK>, <&clks IMX6QDL_CLK_CAAM_IPG>, <&clks IMX6QDL_CLK_EIM_SLOW>; clock-names = "mem", "aclk", "ipg", "emi_slow"; }; iMX6UL does only require three clocks crypto: crypto@2140000 { compatible = "fsl,sec-v4.0"; #address-cells = <1>; #size-cells = <1>; reg = <0x2140000 0x3c000>; ranges = <0 0x2140000 0x3c000>; interrupts = <GIC_SPI 48 IRQ_TYPE_LEVEL_HIGH>; clocks = <&clks IMX6UL_CLK_CAAM_MEM>, <&clks IMX6UL_CLK_CAAM_ACLK>, <&clks IMX6UL_CLK_CAAM_IPG>; clock-names = "mem", "aclk", "ipg"; }; ===================================================================== Job Ring (JR) Node Child of the crypto node defines data processing interface to SEC 4 across the peripheral bus for purposes of processing cryptographic descriptors. The specified address range can be made visible to one (or more) cores. The interrupt defined for this node is controlled within the address range of this node. - compatible Usage: required Value type: <string> Definition: Must include "fsl,sec-v4.0-job-ring" - reg Usage: required Value type: <prop-encoded-array> Definition: Specifies a two JR parameters: an offset from the parent physical address and the length the JR registers. - fsl,liodn Usage: optional-but-recommended Value type: <prop-encoded-array> Definition: Specifies the LIODN to be used in conjunction with the ppid-to-liodn table that specifies the PPID to LIODN mapping. Needed if the PAMU is used. Value is a 12 bit value where value is a LIODN ID for this JR. This property is normally set by boot firmware. - interrupts Usage: required Value type: <prop_encoded-array> Definition: Specifies the interrupts generated by this device. The value of the interrupts property consists of one interrupt specifier. The format of the specifier is defined by the binding document describing the node's interrupt parent. EXAMPLE jr@1000 { compatible = "fsl,sec-v4.0-job-ring"; reg = <0x1000 0x1000>; fsl,liodn = <0x081>; interrupt-parent = <&mpic>; interrupts = <88 2>; }; ===================================================================== Run Time Integrity Check (RTIC) Node Child node of the crypto node. Defines a register space that contains up to 5 sets of addresses and their lengths (sizes) that will be checked at run time. After an initial hash result is calculated, these addresses are checked by HW to monitor any change. If any memory is modified, a Security Violation is triggered (see SNVS definition). - compatible Usage: required Value type: <string> Definition: Must include "fsl,sec-v4.0-rtic". - #address-cells Usage: required Value type: <u32> Definition: A standard property. Defines the number of cells for representing physical addresses in child nodes. Must have a value of 1. - #size-cells Usage: required Value type: <u32> Definition: A standard property. Defines the number of cells for representing the size of physical addresses in child nodes. Must have a value of 1. - reg Usage: required Value type: <prop-encoded-array> Definition: A standard property. Specifies a two parameters: an offset from the parent physical address and the length the SEC4 registers. - ranges Usage: required Value type: <prop-encoded-array> Definition: A standard property. Specifies the physical address range of the SEC 4 register space (-SNVS not included). A triplet that includes the child address, parent address, & length. EXAMPLE rtic@6000 { compatible = "fsl,sec-v4.0-rtic"; #address-cells = <1>; #size-cells = <1>; reg = <0x6000 0x100>; ranges = <0x0 0x6100 0xe00>; }; ===================================================================== Run Time Integrity Check (RTIC) Memory Node A child node that defines individual RTIC memory regions that are used to perform run-time integrity check of memory areas that should not modified. The node defines a register that contains the memory address & length (combined) and a second register that contains the hash result in big endian format. - compatible Usage: required Value type: <string> Definition: Must include "fsl,sec-v4.0-rtic-memory". - reg Usage: required Value type: <prop-encoded-array> Definition: A standard property. Specifies two parameters: an offset from the parent physical address and the length: 1. The location of the RTIC memory address & length registers. 2. The location RTIC hash result. - fsl,rtic-region Usage: optional-but-recommended Value type: <prop-encoded-array> Definition: Specifies the HW address (36 bit address) for this region followed by the length of the HW partition to be checked; the address is represented as a 64 bit quantity followed by a 32 bit length. - fsl,liodn Usage: optional-but-recommended Value type: <prop-encoded-array> Definition: Specifies the LIODN to be used in conjunction with the ppid-to-liodn table that specifies the PPID to LIODN mapping. Needed if the PAMU is used. Value is a 12 bit value where value is a LIODN ID for this RTIC memory region. This property is normally set by boot firmware. EXAMPLE rtic-a@0 { compatible = "fsl,sec-v4.0-rtic-memory"; reg = <0x00 0x20 0x100 0x80>; fsl,liodn = <0x03c>; fsl,rtic-region = <0x12345678 0x12345678 0x12345678>; }; ===================================================================== Secure Non-Volatile Storage (SNVS) Node Node defines address range and the associated interrupt for the SNVS function. This function monitors security state information & reports security violations. This also included rtc, system power off and ON/OFF key. - compatible Usage: required Value type: <string> Definition: Must include "fsl,sec-v4.0-mon" and "syscon". - reg Usage: required Value type: <prop-encoded-array> Definition: A standard property. Specifies the physical address and length of the SEC4 configuration registers. - #address-cells Usage: required Value type: <u32> Definition: A standard property. Defines the number of cells for representing physical addresses in child nodes. Must have a value of 1. - #size-cells Usage: required Value type: <u32> Definition: A standard property. Defines the number of cells for representing the size of physical addresses in child nodes. Must have a value of 1. - ranges Usage: required Value type: <prop-encoded-array> Definition: A standard property. Specifies the physical address range of the SNVS register space. A triplet that includes the child address, parent address, & length. - interrupts Usage: optional Value type: <prop_encoded-array> Definition: Specifies the interrupts generated by this device. The value of the interrupts property consists of one interrupt specifier. The format of the specifier is defined by the binding document describing the node's interrupt parent. EXAMPLE sec_mon@314000 { compatible = "fsl,sec-v4.0-mon", "syscon"; reg = <0x314000 0x1000>; ranges = <0 0x314000 0x1000>; interrupt-parent = <&mpic>; interrupts = <93 2>; }; ===================================================================== Secure Non-Volatile Storage (SNVS) Low Power (LP) RTC Node A SNVS child node that defines SNVS LP RTC. - compatible Usage: required Value type: <string> Definition: Must include "fsl,sec-v4.0-mon-rtc-lp". - interrupts Usage: required Value type: <prop_encoded-array> Definition: Specifies the interrupts generated by this device. The value of the interrupts property consists of one interrupt specifier. The format of the specifier is defined by the binding document describing the node's interrupt parent. - regmap Usage: required Value type: <phandle> Definition: this is phandle to the register map node. - offset Usage: option value type: <u32> Definition: LP register offset. default it is 0x34. - clocks Usage: optional, required if SNVS LP RTC requires explicit enablement of clocks Value type: <prop_encoded-array> Definition: a clock specifier describing the clock required for enabling and disabling SNVS LP RTC. - clock-names Usage: optional, required if SNVS LP RTC requires explicit enablement of clocks Value type: <string> Definition: clock name string should be "snvs-rtc". EXAMPLE sec_mon_rtc_lp@1 { compatible = "fsl,sec-v4.0-mon-rtc-lp"; interrupts = <93 2>; regmap = <&snvs>; offset = <0x34>; clocks = <&clks IMX7D_SNVS_CLK>; clock-names = "snvs-rtc"; }; ===================================================================== System ON/OFF key driver The snvs-pwrkey is designed to enable POWER key function which controlled by SNVS ONOFF, the driver can report the status of POWER key and wakeup system if pressed after system suspend. - compatible: Usage: required Value type: <string> Definition: Mush include "fsl,sec-v4.0-pwrkey". - interrupts: Usage: required Value type: <prop_encoded-array> Definition: The SNVS ON/OFF interrupt number to the CPU(s). - linux,keycode: Usage: option Value type: <int> Definition: Keycode to emit, KEY_POWER by default. - wakeup-source: Usage: option Value type: <boo> Definition: Button can wake-up the system. - regmap: Usage: required: Value type: <phandle> Definition: this is phandle to the register map node. EXAMPLE: snvs-pwrkey@020cc000 { compatible = "fsl,sec-v4.0-pwrkey"; regmap = <&snvs>; interrupts = <0 4 0x4> linux,keycode = <116>; /* KEY_POWER */ wakeup-source; }; ===================================================================== FULL EXAMPLE crypto: crypto@300000 { compatible = "fsl,sec-v4.0"; #address-cells = <1>; #size-cells = <1>; reg = <0x300000 0x10000>; ranges = <0 0x300000 0x10000>; interrupt-parent = <&mpic>; interrupts = <92 2>; sec_jr0: jr@1000 { compatible = "fsl,sec-v4.0-job-ring"; reg = <0x1000 0x1000>; interrupt-parent = <&mpic>; interrupts = <88 2>; }; sec_jr1: jr@2000 { compatible = "fsl,sec-v4.0-job-ring"; reg = <0x2000 0x1000>; interrupt-parent = <&mpic>; interrupts = <89 2>; }; sec_jr2: jr@3000 { compatible = "fsl,sec-v4.0-job-ring"; reg = <0x3000 0x1000>; interrupt-parent = <&mpic>; interrupts = <90 2>; }; sec_jr3: jr@4000 { compatible = "fsl,sec-v4.0-job-ring"; reg = <0x4000 0x1000>; interrupt-parent = <&mpic>; interrupts = <91 2>; }; rtic@6000 { compatible = "fsl,sec-v4.0-rtic"; #address-cells = <1>; #size-cells = <1>; reg = <0x6000 0x100>; ranges = <0x0 0x6100 0xe00>; rtic_a: rtic-a@0 { compatible = "fsl,sec-v4.0-rtic-memory"; reg = <0x00 0x20 0x100 0x80>; }; rtic_b: rtic-b@20 { compatible = "fsl,sec-v4.0-rtic-memory"; reg = <0x20 0x20 0x200 0x80>; }; rtic_c: rtic-c@40 { compatible = "fsl,sec-v4.0-rtic-memory"; reg = <0x40 0x20 0x300 0x80>; }; rtic_d: rtic-d@60 { compatible = "fsl,sec-v4.0-rtic-memory"; reg = <0x60 0x20 0x500 0x80>; }; }; }; sec_mon: sec_mon@314000 { compatible = "fsl,sec-v4.0-mon"; reg = <0x314000 0x1000>; ranges = <0 0x314000 0x1000>; sec_mon_rtc_lp@34 { compatible = "fsl,sec-v4.0-mon-rtc-lp"; regmap = <&sec_mon>; offset = <0x34>; interrupts = <93 2>; clocks = <&clks IMX7D_SNVS_CLK>; clock-names = "snvs-rtc"; }; snvs-pwrkey@020cc000 { compatible = "fsl,sec-v4.0-pwrkey"; regmap = <&sec_mon>; interrupts = <0 4 0x4>; linux,keycode = <116>; /* KEY_POWER */ wakeup-source; }; }; ===================================================================== |