xref: /rk3399_ARM-atf/changelog.yaml (revision 56b741d3e41cd6b2f6863a372a9489c819e2b0e9)
1#
2# Copyright (c) 2021-2022, Arm Limited. All rights reserved.
3#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
7#
8# The following block describes the top-level sections of the changelog. Commits are categorized
9# into these top-level sections based on the commit message "type":
10#
11#     feat(xyz): add the xyz feature
12#     ^^^^
13#
14
15sections:
16  - title: New Features
17    description: A new feature
18    type: feat
19
20  - title: Resolved Issues
21    description: A bug fix
22    type: fix
23
24  - title: Build System
25    description: Changes that affect the build system or external dependencies
26    type: build
27    hidden: true
28
29  - title: Continuous Integration
30    description: Changes to our CI configuration files and scripts
31    type: ci
32    hidden: true
33
34  - title: Build System
35    description: Documentation-only changes
36    type: docs
37    hidden: true
38
39  - title: Performance Improvements
40    description: A code change that improves performance
41    type: perf
42    hidden: true
43
44  - title: Code Refactoring
45    description: A code change that neither fixes a bug nor adds a feature
46    type: refactor
47    hidden: true
48
49  - title: Reverted Changes
50    description: Changes that revert a previous change
51    type: revert
52    hidden: true
53
54  - title: Style
55    description: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
56    type: style
57    hidden: true
58
59  - title: Tests
60    description: Adding missing tests or correcting existing tests
61    type: test
62    hidden: true
63
64  - title: Miscellaneous
65    description: Any other change
66    type: chore
67    hidden: true
68
69#
70# The following block describes the sub-sections of the changelog. These sub-sections may appear in
71# any of the top-level sections, and describe the individual components that a change may relate to.
72#
73# Sub-sections have an optional associated commit message "scope":
74#
75#     feat(xyz): add the xyz feature
76#          ^^^
77#
78# This file also describes deprecated scopes, which are scopes that were used before we introduced
79# scope enforcement. These will not pass CI checks when used, but they will be used to generate the
80# changelog.
81#
82# Please note that new scopes should be kebab-case: https://en.wiktionary.org/wiki/kebab_case
83#
84
85subsections:
86  - title: Architecture
87
88    subsections:
89      - title: Activity Monitors Extension (FEAT_AMU)
90        scope: amu
91
92      - title: Confidential Compute Architecture (CCA)
93        scope: cca
94
95      - title: Support for the `HCRX_EL2` register (FEAT_HCX)
96        scope: hcx
97
98      - title: Memory Partitioning and Monitoring (MPAM) Extension (FEAT_MPAM)
99        scope: mpam
100
101      - title: Scalable Matrix Extension (FEAT_SME)
102        scope: sme
103
104      - title: Scalable Vector Extension (FEAT_SVE)
105        scope: sve
106
107      - title: System Register Trace Extensions (FEAT_ETMv4, FEAT_ETE and FEAT_ETEv1.1)
108        scope: sys-reg-trace
109
110        deprecated:
111          - sys_reg_trace
112
113      - title: Trace Buffer Extension (FEAT_TRBE)
114        scope: trbe
115
116      - title: Self-hosted Trace Extensions (FEAT_TRF)
117        scope: trf
118
119      - title: Statistical profiling Extension (FEAT_SPE)
120        scope: spe
121
122      - title: Branch Record Buffer Extension (FEAT_BRBE)
123        scope: brbe
124
125      - title: Extended Cache Index (FEAT_CCIDX)
126        scope: ccidx
127
128  - title: Platforms
129
130    subsections:
131      - title: Allwinner
132        scope: allwinner
133
134        deprecated:
135          - plat/allwinner
136
137      - title: Arm
138        scope: arm
139
140        deprecated:
141          - plat/arm
142
143        subsections:
144          - title: FPGA
145            scope: fpga
146
147            deprecated:
148              - arm_fgpa
149              - arm_fpga
150              - plat/arm_fpga
151
152          - title: FVP
153            scope: fvp
154
155            deprecated:
156              - plat/fvp
157
158          - title: FVP-R
159            scope: fvp-r
160
161            deprecated:
162              - fvp_r
163
164          - title: Juno
165            scope: juno
166
167          - title: Morello
168            scope: morello
169
170          - title: N1SDP
171            scope: n1sdp
172
173          - title: RD
174            scope: rd
175
176            subsections:
177              - title: RD-N2
178                scope: rdn2
179
180                deprecated:
181                  - board/rdn2
182
183          - title: SGI
184            scope: sgi
185
186            deprecated:
187              - plat/sgi
188              - plat/arm/sgi
189
190          - title: TC
191            scope: tc
192
193            subsections:
194              - title: TC0
195                scope: tc0
196
197                deprecated:
198                  - plat/tc0
199
200          - title: Corstone-1000
201            scope: corstone-1000
202
203      - title: Broadcom
204        scope: brcm
205
206      - title: Intel
207        scope: intel
208
209        subsections:
210          - title: SoC
211            scope: soc
212
213      - title: Marvell
214        scope: marvell
215
216        deprecated:
217          - plat/marvell
218
219        subsections:
220          - title: Armada
221            scope: armada
222
223            deprecated:
224              - plat/marvell/armada
225
226            subsections:
227              - title: A3K
228                scope: a3k
229
230                deprecated:
231                  - plat/marvell/a3k
232
233              - title: A8K
234                scope: a8k
235
236                deprecated:
237                  - plat/marvell/a8k
238
239      - title: MediaTek
240        scope: mediatek
241
242        deprecated:
243          - plat/mediatek/common
244          - plat/mediatek
245
246        subsections:
247          - title: MT8183
248            scope: mt8183
249
250            deprecated:
251              - plat/mediatek/mt8183
252
253          - title: MT8192
254            scope: mt8192
255
256            deprecated:
257              - plat/mdeiatek/mt8192
258
259          - title: MT8195
260            scope: mt8195
261
262            deprecated:
263              - plat/mediatek/me8195
264              - plat/mediatek/mt8195
265              - plat/mdeiatek/mt8195
266
267          - title: MT8186
268            scope: mt8186
269
270            deprecated:
271              - plat/mediatek/mt8186
272
273      - title: NVIDIA
274        scope: nvidia
275
276        subsections:
277          - title: Tegra
278            scope: tegra
279
280            deprecated:
281              - plat/tegra
282
283            subsections:
284              - title: Tegra 132
285                scope: tegra132
286
287              - title: Tegra 194
288                scope: tegra194
289
290      - title: NXP
291        scope: nxp
292
293        deprecated:
294          - plat/nxp
295          - plat/nxp/common
296
297        subsections:
298          - title: i.MX
299            scope: imx
300
301            deprecated:
302              - plat/imx
303              - plat/imx/imx
304
305            subsections:
306              - title: i.MX 8M
307                scope: imx8m
308
309                deprecated:
310                  - plat/imx8m
311                  - plat/imx/imx8m
312
313                subsections:
314                  - title: i.MX 8M Nano
315                    scope: imx8mn
316
317                    deprecated:
318                      - plat/imx/imx8m/imx8mn
319
320                  - title: i.MX 8M Mini
321                    scope: imx8mm
322
323                    deprecated:
324                      - plat/imx/imx8m/imx8mm
325
326                  - title: i.MX 8M Plus
327                    scope: imx8mp
328
329                    deprecated:
330                      - plat/imx/imx8m/imx8mp
331
332                  - title: i.MX 8Q
333                    scope: imx8mq
334
335                    deprecated:
336                      - plat/imx/imx8m/imx8mq
337
338          - title: Layerscape
339            scope: layerscape
340
341            deprecated:
342              - docs/nxp/layerscape
343
344            subsections:
345              - title: LS1028A
346                scope: ls1028a
347
348                deprecated:
349                  - plat/nxp/ls1028a
350
351                subsections:
352                  - title: LS1028ARDB
353                    scope: ls1028ardb
354
355                    deprecated:
356                      - plat/nxp/ls1028ardb
357
358              - title: LS1043A
359                scope: ls1043a
360
361                deprecated:
362                  - plat/nxp/ls1043a
363
364                subsections:
365                  - title: LS1043ARDB
366                    scope: ls1043ardb
367
368                    deprecated:
369                      - plat/nxp/ls1043ardb
370
371              - title: LX2
372                scope: lx2
373
374                deprecated:
375                  - plat/nxp/lx2
376
377                subsections:
378                  - title: LX216
379                    scope: lx216
380
381                    deprecated:
382                      - plat/nxp/lx216x
383
384                    subsections:
385                      - title: LX2160
386                        scope: lx2160
387
388                        deprecated:
389                          - plat/soc-lx2160
390
391              - title: LS1046A
392                scope: ls1046a
393
394                subsections:
395                  - title: LS1046ARDB
396                    scope: ls1046ardb
397
398                  - title: LS1046AFRWY
399                    scope: ls1046afrwy
400
401                  - title: LS1046AQDS
402                    scope: ls1046aqds
403
404              - title: LS1088A
405                scope: ls1088a
406
407                subsections:
408                  - title: LS1088ARDB
409                    scope: ls1088ardb
410
411                  - title: LS1088AQDS
412                    scope: ls1088aqds
413
414      - title: QEMU
415        scope: qemu
416
417        deprecated:
418          - plat/qemu
419
420      - title: QTI
421        scope: qti
422
423        subsections:
424          - title: SC1780
425            scope: sc7180
426
427            deprecated:
428              - plat/qti/sc7180
429
430          - title: SC7280
431            scope: sc7280
432
433            deprecated:
434              - plat/qti/sc7280
435
436          - title: MSM8916
437            scope: msm8916
438
439      - title: Raspberry Pi
440        scope: rpi
441
442        subsections:
443          - title: Raspberry Pi 4
444            scope: rpi4
445
446      - title: Renesas
447        scope: renesas
448
449        subsections:
450          - title: R-Car
451            scope: rcar
452
453            deprecated:
454              - plat/rcar
455
456            subsections:
457              - title: R-Car 3
458                scope: rcar3
459
460                deprecated:
461                  - plat/rcar3
462
463      - title: Rockchip
464        scope: rockchip
465
466        subsections:
467          - title: RK3399
468            scope: rk3399
469
470            deprecated:
471              - rockchip/rk3399
472              - rk3399/suspend
473
474      - title: Socionext
475        scope: socionext
476
477        subsections:
478          - title: Synquacer
479            scope: synquacer
480
481            deprecated:
482              - plat/synquacer
483
484      - title: ST
485        scope: st
486
487        deprecated:
488          - plat/st
489
490        subsections:
491          - title: ST32MP1
492            scope: stm32mp1
493
494            deprecated:
495              - plat/st/stm32mp1
496
497      - title: Texas Instruments
498        scope: ti
499
500        subsections:
501          - title: K3
502            scope: k3
503
504      - title: Xilinx
505        scope: xilinx
506
507        deprecated:
508          - plat/xilinx
509
510        subsections:
511          - title: Versal
512            scope: versal
513
514            deprecated:
515              - plat/xilinx/versal/include
516              - plat/xilinx/versal
517              - plat/versal
518
519          - title: ZynqMP
520            scope: zynqmp
521
522            deprecated:
523              - plat/zynqmp
524              - plat/xilinx/zynqmp
525
526  - title: Bootloader Images
527    scope: bl
528
529    deprecated:
530      - bl_common
531
532    subsections:
533      - title: BL1
534        scope: bl1
535
536      - title: BL2
537        scope: bl2
538
539      - title: BL31
540        scope: bl31
541
542  - title: Services
543    scope: services
544
545    subsections:
546      - title: FF-A
547        scope: ff-a
548
549        deprecated:
550          - ffa
551
552      - title: RME
553        scope: rme
554
555        subsections:
556          - title: TRP
557            scope: trp
558
559      - title: SPM
560        scope: spm
561
562        subsections:
563          - title: EL3 SPMC
564            scope: el3-spmc
565
566          - title: SPMD
567            scope: spmd
568
569          - title: SPM MM
570            scope: spm-mm
571
572  - title: Libraries
573
574    subsections:
575      - title: CPU Support
576        scope: cpus
577
578        deprecated:
579          - cpu
580          - errata
581          - errata_report
582
583      - title: EL3 Runtime
584        scope: el3-runtime
585
586        deprecated:
587          - el3_runtime
588
589        subsections:
590          - title: Context Management
591            scope: cm
592
593      - title: FCONF
594        scope: fconf
595
596      - title: MPMM
597        scope: mpmm
598
599      - title: OP-TEE
600        scope: optee
601
602        deprecated:
603          - lib/optee
604
605      - title: PSCI
606        scope: psci
607
608      - title: GPT
609        scope: gpt
610
611        deprecated:
612          - gpt_rme
613
614      - title: SMCCC
615        scope: smccc
616
617      - title: Translation Tables
618        scope: xlat
619
620      - title: C Standard Library
621        scope: libc
622
623      - title: Locks
624        scope: locks
625
626      - title: PSA
627        scope: psa
628
629  - title: Drivers
630
631    subsections:
632      - title: Authentication
633        scope: auth
634
635        deprecated:
636          - driver/auth
637
638        subsections:
639          - title: CryptoCell-713
640            scope: cc-713
641
642      - title: Generic Clock
643        scope: clk
644
645      - title: FWU
646        scope: fwu
647
648        deprecated:
649          - fwu_metadata
650
651      - title: I/O
652        scope: io
653
654        subsections:
655          - title: MTD
656            scope: mtd
657
658            deprecated:
659              - io_mtd
660
661      - title: Measured Boot
662        scope: measured-boot
663
664        deprecated:
665          - measured boot
666          - measured_boot
667
668      - title: MMC
669        scope: mmc
670
671        deprecated:
672          - drivers/mmc
673
674      - title: MTD
675        scope: mtd
676
677        deprecated:
678          - drivers/mtd
679
680        subsections:
681          - title: NAND
682            scope: nand
683
684            subsections:
685              - title: SPI NAND
686                scope: spi-nand
687
688                deprecated:
689                  - spi_nand
690
691      - title: GUID Partition Tables Support
692        scope: guid-partition
693
694      - title: SCMI
695        scope: scmi
696
697        deprecated:
698          - scmi_common
699          - drivers/scmi-msg
700
701      - title: UFS
702        scope: ufs
703
704      - title: Arm
705        scope: arm-drivers
706
707        subsections:
708          - title: Ethos-N
709            scope: ethos-n
710
711            deprecated:
712              - drivers/arm/ethosn
713
714          - title: GIC
715            scope: gic
716
717            subsections:
718              - title: GICv3
719                scope: gicv3
720
721                subsections:
722                  - title: GIC-600AE
723                    scope: gic600ae
724
725          - title: SMMU
726            scope: smmu
727
728          - title: MHU
729            scope: mhu
730
731            deprecated:
732              - drivers/arm/mhu
733
734          - title: RSS
735            scope: rss
736
737            deprecated:
738              - drivers/arm/rss
739
740          - title: TZC
741            scope: tzc
742
743            subsections:
744              - title: TZC-400
745                scope: tzc400
746
747                deprecated:
748                  - drivers/tzc400
749
750              - title: TZC-380
751                scope: tzc380
752
753                deprecated:
754                  - drivers/tzc380
755
756      - title: Marvell
757        scope: marvell-drivers
758
759        subsections:
760          - title: COMPHY
761            scope: marvell-comphy
762
763            deprecated:
764              - drivers/marvell/comphy
765
766            subsections:
767              - title: Armada 3700
768                scope: marvell-comphy-3700
769
770                deprecated:
771                  - drivers/marvell/comphy-3700
772
773              - title: CP110
774                scope: marvell-comphy-cp110
775
776                deprecated:
777                  - drivers/marvell/comphy-cp110
778
779          - title: UART
780            scope: marvell-uart
781
782            deprecated:
783              - plat/marvell/uart
784
785          - title: Armada
786            scope: armada-drivers
787
788            subsections:
789              - title: A3K
790                scope: a3k-drivers
791
792                subsections:
793                  - title: A3720
794                    scope: a3720-uart
795
796                    deprecated:
797                      - plat/marvell/a3720/uart
798
799      - title: MediaTek
800        scope: mediatek-drivers
801
802        subsections:
803          - title: APU
804            scope: mediatek-apu
805
806            deprecated:
807              - plat/mediatek/apu
808
809          - title: EMI MPU
810            scope: mediatek-emi-mpu
811
812            deprecated:
813              - plat/mediatek/mpu
814
815          - title: PMIC Wrapper
816            scope: mediatek-pmic-wrapper
817
818            deprecated:
819              - plat/mediatek/pmic_wrap
820
821          - title: MT8192
822            scope: mt8192-drivers
823
824            subsections:
825              - title: SPM
826                scope: mt8192-spm
827
828                deprecated:
829                  - mediatek/mt8192/spm
830
831      - title: NXP
832        scope: nxp-drivers
833
834        subsections:
835          - title: DCFG
836            scope: nxp-dcfg
837
838            deprecated:
839              - driver/nxp/dcfg
840
841          - title: FLEXSPI
842            scope: flexspi
843
844            deprecated:
845              - include/drivers/flexspi
846              - driver/nxp/xspi
847
848          - title: SCFG
849            scope: nxp-scfg
850
851            deprecated:
852              - nxp/scfg
853
854          - title: SFP
855            scope: nxp-sfp
856
857            deprecated:
858              - drivers/nxp/sfp
859
860          - title: QSPI
861            scope: nxp-qspi
862
863          - title: NXP Crypto
864            scope: nxp-crypto
865
866          - title: DDR
867            scope: nxp-ddr
868
869          - title: GIC
870            scope: nxp-gic
871
872          - title: CSU
873            scope: nxp-csu
874
875          - title: IFC NAND
876            scope: nxp-ifc-nand
877
878          - title: IFC NOR
879            scope: nxp-ifc-nor
880
881          - title: TZC-380
882            scope: nxp-tzc380
883
884      - title: Renesas
885        scope: renesas-drivers
886
887        subsections:
888          - title: R-Car3
889            scope: rcar3-drivers
890
891            deprecated:
892              - drivers/rcar3
893
894      - title: ST
895        scope: st-drivers
896
897        deprecated:
898          - drivers/st
899
900        subsections:
901          - title: BSEC
902            scope: st-bsec
903
904          - title: Clock
905            scope: st-clock
906
907            deprecated:
908              - stm32mp_clk
909              - drivers/st/clk
910              - stm32mp1_clk
911
912          - title: Crypto
913            scope: st-crypto
914
915          - title: DDR
916            scope: st-ddr
917
918          - title: I/O
919            scope: st-io-drivers
920
921            subsections:
922              - title: STM32 Image
923                scope: st-io-stm32image
924
925                deprecated:
926                  - io-stm32image
927                  - io_stm32image
928
929          - title: I2C
930            scope: st-i2c
931
932          - title: FMC
933            scope: st-fmc
934
935          - title: GPIO
936            scope: st-gpio
937
938          - title: SDMMC2
939            scope: st-sdmmc2
940
941            deprecated:
942              - stm32_sdmmc2
943
944          - title: ST PMIC
945            scope: st-pmic
946
947            deprecated:
948              - drivers/st/pmic
949
950          - title: STPMIC1
951            scope: stpmic1
952
953          - title: Regulator
954            scope: st-regulator
955
956          - title: Reset
957            scope: st-reset
958
959          - title: SPI
960            scope: st-spi
961
962          - title: UART
963            scope: st-uart
964
965            subsections:
966              - title: STM32 Console
967                scope: stm32-console
968
969                deprecated:
970                  - stm32_console
971
972          - title: USB
973            scope: st-usb
974
975            deprecated:
976              - drivers/st/usb
977
978          - title: Watchdog
979            scope: st-iwdg
980
981      - title: USB
982        scope: usb
983
984        deprecated:
985          - drivers/usb
986
987  - title: Miscellaneous
988
989    subsections:
990      - title: AArch64
991        scope: aarch64
992
993      - title: Debug
994        scope: debug
995
996        deprecated:
997          - common/debug
998
999      - title: CRC32
1000        scope: crc32
1001
1002        subsections:
1003          - title: Hardware CRC32
1004            scope: hw-crc32
1005
1006            deprecated:
1007              - hw_crc
1008              - hw_crc32
1009
1010          - title: Software CRC32
1011            scope: sw-crc32
1012
1013            deprecated:
1014              - sw_crc32
1015
1016      - title: DT Bindings
1017        scope: dt-bindings
1018
1019      - title: FDT Wrappers
1020        scope: fdt-wrappers
1021
1022      - title: FDTs
1023        scope: fdts
1024
1025        deprecated:
1026          - fdt
1027
1028        subsections:
1029          - title: Morello
1030            scope: morello-fdts
1031
1032            deprecated:
1033              - fdts/morello
1034
1035          - title: STM32MP1
1036            scope: stm32mp1-fdts
1037
1038            deprecated:
1039              - fdts stm32mp1
1040
1041      - title: PIE
1042        scope: pie
1043
1044      - title: Security
1045        scope: security
1046
1047      - title: SDEI
1048        scope: sdei
1049
1050      - title: TBBR
1051        scope: tbbr
1052
1053      - title: NXP
1054
1055        subsections:
1056          - title: OCRAM
1057            scope: nxp-ocram
1058
1059            deprecated:
1060              - nxp/common/ocram
1061
1062          - title: PSCI
1063            scope: nxp-psci
1064
1065            deprecated:
1066              - plat/nxp/common/psci
1067
1068  - title: Documentation
1069    scope: docs
1070
1071    deprecated:
1072      - doc
1073
1074    subsections:
1075      - title: Changelog
1076        scope: changelog
1077
1078      - title: Commit Style
1079        scope: commit-style
1080
1081      - title: Contribution Guidelines
1082        scope: contributing
1083
1084        deprecated:
1085          - contribution-guidelines
1086          - docs-contributing.rst
1087
1088      - title: Maintainers
1089        scope: maintainers
1090
1091      - title: Prerequisites
1092        scope: prerequisites
1093
1094      - title: Threat Model
1095        scope: threat-model
1096
1097  - title: Build System
1098    scope: build
1099
1100    deprecated:
1101      - makefile
1102      - Makefile
1103
1104    subsections:
1105      - title: Git Hooks
1106        scope: hooks
1107
1108  - title: Tools
1109
1110    subsections:
1111      - title: STM32 Image
1112        scope: stm32image
1113
1114        deprecated:
1115          - tools/stm32image
1116
1117      - title: NXP Tools
1118        scope: nxp-tools
1119
1120      - title: Firmware Image Package Tool
1121        scope: fiptool
1122
1123      - title: Secure Partition Tool
1124        scope: sptool
1125
1126      - title: Certificate Creation Tool
1127        scope: cert-create
1128
1129  - title: Dependencies
1130    scope: deps
1131
1132    subsections:
1133      - title: checkpatch
1134        scope: checkpatch
1135
1136      - title: commitlint
1137        scope: commitlint
1138
1139      - title: libfdt
1140        scope: libfdt
1141
1142      - title: Node Package Manager (NPM)
1143        scope: npm
1144