xref: /rk3399_ARM-atf/changelog.yaml (revision 8a6a9560b5dcccfb68064c0c8c9b4b47981c6ac7)
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: Documentation
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: Trapping support for RNDR/RNDRRS (FEAT_RNG_TRAP)
129        scope: rng-trap
130
131      - title: Performance Monitors Extension (FEAT_PMUv3)
132        scope: pmu
133
134  - title: Platforms
135
136    subsections:
137      - title: Allwinner
138        scope: allwinner
139
140        deprecated:
141          - plat/allwinner
142
143      - title: Arm
144        scope: arm
145
146        deprecated:
147          - plat/arm
148
149        subsections:
150          - title: FPGA
151            scope: fpga
152
153            deprecated:
154              - arm_fgpa
155              - arm_fpga
156              - plat/arm_fpga
157
158          - title: FVP
159            scope: fvp
160
161            deprecated:
162              - plat/fvp
163
164          - title: FVP-R
165            scope: fvp-r
166
167            deprecated:
168              - fvp_r
169
170          - title: Juno
171            scope: juno
172
173          - title: Morello
174            scope: morello
175
176          - title: N1SDP
177            scope: n1sdp
178
179          - title: RD
180            scope: rd
181
182            subsections:
183              - title: RD-N2
184                scope: rdn2
185
186                deprecated:
187                  - board/rdn2
188
189          - title: SGI
190            scope: sgi
191
192            deprecated:
193              - plat/sgi
194              - plat/arm/sgi
195
196          - title: TC
197            scope: tc
198
199            subsections:
200              - title: TC0
201                scope: tc0
202
203                deprecated:
204                  - plat/tc0
205
206          - title: Corstone-1000
207            scope: corstone-1000
208
209      - title: Broadcom
210        scope: brcm
211
212      - title: Intel
213        scope: intel
214
215        subsections:
216          - title: SoC
217            scope: soc
218
219      - title: Marvell
220        scope: marvell
221
222        deprecated:
223          - plat/marvell
224
225        subsections:
226          - title: Armada
227            scope: armada
228
229            deprecated:
230              - plat/marvell/armada
231
232            subsections:
233              - title: A3K
234                scope: a3k
235
236                deprecated:
237                  - plat/marvell/a3k
238
239              - title: A8K
240                scope: a8k
241
242                deprecated:
243                  - plat/marvell/a8k
244
245      - title: MediaTek
246        scope: mediatek
247
248        deprecated:
249          - plat/mediatek/common
250          - plat/mediatek
251
252        subsections:
253          - title: MT8183
254            scope: mt8183
255
256            deprecated:
257              - plat/mediatek/mt8183
258
259          - title: MT8192
260            scope: mt8192
261
262            deprecated:
263              - plat/mdeiatek/mt8192
264
265          - title: MT8195
266            scope: mt8195
267
268            deprecated:
269              - plat/mediatek/me8195
270              - plat/mediatek/mt8195
271              - plat/mdeiatek/mt8195
272
273          - title: MT8186
274            scope: mt8186
275
276            deprecated:
277              - plat/mediatek/mt8186
278
279      - title: NVIDIA
280        scope: nvidia
281
282        subsections:
283          - title: Tegra
284            scope: tegra
285
286            deprecated:
287              - plat/tegra
288
289            subsections:
290              - title: Tegra 132
291                scope: tegra132
292
293              - title: Tegra 194
294                scope: tegra194
295
296      - title: NXP
297        scope: nxp
298
299        deprecated:
300          - plat/nxp
301          - plat/nxp/common
302
303        subsections:
304          - title: i.MX
305            scope: imx
306
307            deprecated:
308              - plat/imx
309              - plat/imx/imx
310
311            subsections:
312              - title: i.MX 8M
313                scope: imx8m
314
315                deprecated:
316                  - plat/imx8m
317                  - plat/imx/imx8m
318
319                subsections:
320                  - title: i.MX 8M Nano
321                    scope: imx8mn
322
323                    deprecated:
324                      - plat/imx/imx8m/imx8mn
325
326                  - title: i.MX 8M Mini
327                    scope: imx8mm
328
329                    deprecated:
330                      - plat/imx/imx8m/imx8mm
331
332                  - title: i.MX 8M Plus
333                    scope: imx8mp
334
335                    deprecated:
336                      - plat/imx/imx8m/imx8mp
337
338                  - title: i.MX 8Q
339                    scope: imx8mq
340
341                    deprecated:
342                      - plat/imx/imx8m/imx8mq
343
344          - title: Layerscape
345            scope: layerscape
346
347            deprecated:
348              - docs/nxp/layerscape
349
350            subsections:
351              - title: LS1028A
352                scope: ls1028a
353
354                deprecated:
355                  - plat/nxp/ls1028a
356
357                subsections:
358                  - title: LS1028ARDB
359                    scope: ls1028ardb
360
361                    deprecated:
362                      - plat/nxp/ls1028ardb
363
364              - title: LS1043A
365                scope: ls1043a
366
367                deprecated:
368                  - plat/nxp/ls1043a
369
370                subsections:
371                  - title: LS1043ARDB
372                    scope: ls1043ardb
373
374                    deprecated:
375                      - plat/nxp/ls1043ardb
376
377              - title: LX2
378                scope: lx2
379
380                deprecated:
381                  - plat/nxp/lx2
382
383                subsections:
384                  - title: LX216
385                    scope: lx216
386
387                    deprecated:
388                      - plat/nxp/lx216x
389
390                    subsections:
391                      - title: LX2160
392                        scope: lx2160
393
394                        deprecated:
395                          - plat/soc-lx2160
396
397              - title: LS1046A
398                scope: ls1046a
399
400                subsections:
401                  - title: LS1046ARDB
402                    scope: ls1046ardb
403
404                  - title: LS1046AFRWY
405                    scope: ls1046afrwy
406
407                  - title: LS1046AQDS
408                    scope: ls1046aqds
409
410              - title: LS1088A
411                scope: ls1088a
412
413                subsections:
414                  - title: LS1088ARDB
415                    scope: ls1088ardb
416
417                  - title: LS1088AQDS
418                    scope: ls1088aqds
419
420      - title: QEMU
421        scope: qemu
422
423        deprecated:
424          - plat/qemu
425
426      - title: QTI
427        scope: qti
428
429        subsections:
430          - title: SC1780
431            scope: sc7180
432
433            deprecated:
434              - plat/qti/sc7180
435
436          - title: SC7280
437            scope: sc7280
438
439            deprecated:
440              - plat/qti/sc7280
441
442          - title: MSM8916
443            scope: msm8916
444
445      - title: Raspberry Pi
446        scope: rpi
447
448        subsections:
449          - title: Raspberry Pi 4
450            scope: rpi4
451
452      - title: Renesas
453        scope: renesas
454
455        subsections:
456          - title: R-Car
457            scope: rcar
458
459            deprecated:
460              - plat/rcar
461
462            subsections:
463              - title: R-Car 3
464                scope: rcar3
465
466                deprecated:
467                  - plat/rcar3
468
469      - title: Rockchip
470        scope: rockchip
471
472        subsections:
473          - title: RK3399
474            scope: rk3399
475
476            deprecated:
477              - rockchip/rk3399
478              - rk3399/suspend
479
480      - title: Socionext
481        scope: socionext
482
483        subsections:
484          - title: Synquacer
485            scope: synquacer
486
487            deprecated:
488              - plat/synquacer
489
490      - title: ST
491        scope: st
492
493        deprecated:
494          - plat/st
495
496        subsections:
497          - title: STM32MP1
498            scope: stm32mp1
499
500            deprecated:
501              - plat/st/stm32mp1
502
503            subsections:
504              - title: STM32MP13
505                scope: stm32mp13
506
507              - title: STM32MP15
508                scope: stm32mp15
509
510      - title: Texas Instruments
511        scope: ti
512
513        subsections:
514          - title: K3
515            scope: k3
516
517      - title: Xilinx
518        scope: xilinx
519
520        deprecated:
521          - plat/xilinx
522
523        subsections:
524          - title: Versal
525            scope: versal
526
527            deprecated:
528              - plat/xilinx/versal/include
529              - plat/xilinx/versal
530              - plat/versal
531
532          - title: ZynqMP
533            scope: zynqmp
534
535            deprecated:
536              - plat/zynqmp
537              - plat/xilinx/zynqmp
538
539  - title: Bootloader Images
540    scope: bl
541
542    deprecated:
543      - bl_common
544
545    subsections:
546      - title: BL1
547        scope: bl1
548
549      - title: BL2
550        scope: bl2
551
552      - title: BL31
553        scope: bl31
554
555      - title: BL32
556        scope: bl32
557
558        subsections:
559          - title: TSP
560            scope: tsp
561
562  - title: Services
563    scope: services
564
565    subsections:
566      - title: FF-A
567        scope: ff-a
568
569        deprecated:
570          - ffa
571
572      - title: RME
573        scope: rme
574
575        subsections:
576          - title: TRP
577            scope: trp
578
579          - title: RMMD
580            scope: rmmd
581
582      - title: SPM
583        scope: spm
584
585        subsections:
586          - title: EL3 SPMC
587            scope: el3-spmc
588
589          - title: SPMD
590            scope: spmd
591
592          - title: SPM MM
593            scope: spm-mm
594
595      - title: DRTM
596        scope: drtm
597
598  - title: Libraries
599
600    subsections:
601      - title: CPU Support
602        scope: cpus
603
604        deprecated:
605          - cpu
606          - errata
607          - errata_report
608
609      - title: EL3 Runtime
610        scope: el3-runtime
611
612        deprecated:
613          - el3_runtime
614
615        subsections:
616          - title: Context Management
617            scope: cm
618
619      - title: FCONF
620        scope: fconf
621
622      - title: MPMM
623        scope: mpmm
624
625      - title: OP-TEE
626        scope: optee
627
628        deprecated:
629          - lib/optee
630
631      - title: PSCI
632        scope: psci
633
634      - title: GPT
635        scope: gpt
636
637        deprecated:
638          - gpt_rme
639
640      - title: SMCCC
641        scope: smccc
642
643      - title: Translation Tables
644        scope: xlat
645
646      - title: C Standard Library
647        scope: libc
648
649      - title: Locks
650        scope: locks
651
652      - title: PSA
653        scope: psa
654
655      - title: Context Management
656        scope: context mgmt
657
658      - title: Semihosting
659        scope: semihosting
660
661  - title: Drivers
662
663    subsections:
664      - title: Authentication
665        scope: auth
666
667        deprecated:
668          - driver/auth
669
670        subsections:
671          - title: CryptoCell-713
672            scope: cc-713
673
674          - title: Crypto
675            scope: crypto
676
677          - title: mbedTLS
678            scope: mbedtls
679
680      - title: Generic Clock
681        scope: clk
682
683      - title: FWU
684        scope: fwu
685
686        deprecated:
687          - fwu_metadata
688
689      - title: I/O
690        scope: io
691
692        subsections:
693          - title: MTD
694            scope: mtd
695
696            deprecated:
697              - io_mtd
698
699      - title: Measured Boot
700        scope: measured-boot
701
702        deprecated:
703          - measured boot
704          - measured_boot
705
706      - title: MMC
707        scope: mmc
708
709        deprecated:
710          - drivers/mmc
711
712      - title: MTD
713        scope: mtd
714
715        deprecated:
716          - drivers/mtd
717
718        subsections:
719          - title: NAND
720            scope: nand
721
722            subsections:
723              - title: SPI NAND
724                scope: spi-nand
725
726                deprecated:
727                  - spi_nand
728
729      - title: GUID Partition Tables Support
730        scope: guid-partition
731
732      - title: SCMI
733        scope: scmi
734
735        deprecated:
736          - scmi_common
737          - drivers/scmi-msg
738
739      - title: UFS
740        scope: ufs
741
742      - title: Arm
743        scope: arm-drivers
744
745        subsections:
746          - title: Ethos-N
747            scope: ethos-n
748
749            deprecated:
750              - drivers/arm/ethosn
751
752          - title: GIC
753            scope: gic
754
755            subsections:
756              - title: GICv3
757                scope: gicv3
758
759                subsections:
760                  - title: GIC-600AE
761                    scope: gic600ae
762
763          - title: SMMU
764            scope: smmu
765
766          - title: MHU
767            scope: mhu
768
769            deprecated:
770              - drivers/arm/mhu
771
772          - title: RSS
773            scope: rss
774
775            deprecated:
776              - drivers/arm/rss
777
778          - title: TZC
779            scope: tzc
780
781            subsections:
782              - title: TZC-400
783                scope: tzc400
784
785                deprecated:
786                  - drivers/tzc400
787
788              - title: TZC-380
789                scope: tzc380
790
791                deprecated:
792                  - drivers/tzc380
793
794      - title: Marvell
795        scope: marvell-drivers
796
797        subsections:
798          - title: COMPHY
799            scope: marvell-comphy
800
801            deprecated:
802              - drivers/marvell/comphy
803
804            subsections:
805              - title: Armada 3700
806                scope: marvell-comphy-3700
807
808                deprecated:
809                  - drivers/marvell/comphy-3700
810
811              - title: CP110
812                scope: marvell-comphy-cp110
813
814                deprecated:
815                  - drivers/marvell/comphy-cp110
816
817          - title: UART
818            scope: marvell-uart
819
820            deprecated:
821              - plat/marvell/uart
822
823          - title: Armada
824            scope: armada-drivers
825
826            subsections:
827              - title: A3K
828                scope: a3k-drivers
829
830                subsections:
831                  - title: A3720
832                    scope: a3720-uart
833
834                    deprecated:
835                      - plat/marvell/a3720/uart
836
837      - title: MediaTek
838        scope: mediatek-drivers
839
840        subsections:
841          - title: APU
842            scope: mediatek-apu
843
844            deprecated:
845              - plat/mediatek/apu
846
847          - title: EMI MPU
848            scope: mediatek-emi-mpu
849
850            deprecated:
851              - plat/mediatek/mpu
852
853          - title: PMIC Wrapper
854            scope: mediatek-pmic-wrapper
855
856            deprecated:
857              - plat/mediatek/pmic_wrap
858
859          - title: MT8192
860            scope: mt8192-drivers
861
862            subsections:
863              - title: SPM
864                scope: mt8192-spm
865
866                deprecated:
867                  - mediatek/mt8192/spm
868
869      - title: NXP
870        scope: nxp-drivers
871
872        subsections:
873          - title: DCFG
874            scope: nxp-dcfg
875
876            deprecated:
877              - driver/nxp/dcfg
878
879          - title: FLEXSPI
880            scope: flexspi
881
882            deprecated:
883              - include/drivers/flexspi
884              - driver/nxp/xspi
885
886          - title: SCFG
887            scope: nxp-scfg
888
889            deprecated:
890              - nxp/scfg
891
892          - title: SFP
893            scope: nxp-sfp
894
895            deprecated:
896              - drivers/nxp/sfp
897
898          - title: QSPI
899            scope: nxp-qspi
900
901          - title: NXP Crypto
902            scope: nxp-crypto
903
904          - title: DDR
905            scope: nxp-ddr
906
907          - title: GIC
908            scope: nxp-gic
909
910          - title: CSU
911            scope: nxp-csu
912
913          - title: IFC NAND
914            scope: nxp-ifc-nand
915
916          - title: IFC NOR
917            scope: nxp-ifc-nor
918
919          - title: TZC-380
920            scope: nxp-tzc380
921
922      - title: Renesas
923        scope: renesas-drivers
924
925        subsections:
926          - title: R-Car3
927            scope: rcar3-drivers
928
929            deprecated:
930              - drivers/rcar3
931
932      - title: ST
933        scope: st-drivers
934
935        deprecated:
936          - drivers/st
937
938        subsections:
939          - title: BSEC
940            scope: st-bsec
941
942          - title: Clock
943            scope: st-clock
944
945            deprecated:
946              - stm32mp_clk
947              - drivers/st/clk
948              - stm32mp1_clk
949
950          - title: Crypto
951            scope: st-crypto
952
953          - title: DDR
954            scope: st-ddr
955
956          - title: I/O
957            scope: st-io-drivers
958
959            subsections:
960              - title: STM32 Image
961                scope: st-io-stm32image
962
963                deprecated:
964                  - io-stm32image
965                  - io_stm32image
966
967          - title: I2C
968            scope: st-i2c
969
970          - title: FMC
971            scope: st-fmc
972
973          - title: GPIO
974            scope: st-gpio
975
976          - title: SDMMC2
977            scope: st-sdmmc2
978
979            deprecated:
980              - stm32_sdmmc2
981
982          - title: ST PMIC
983            scope: st-pmic
984
985            deprecated:
986              - drivers/st/pmic
987
988          - title: STPMIC1
989            scope: stpmic1
990
991          - title: Regulator
992            scope: st-regulator
993
994          - title: Reset
995            scope: st-reset
996
997          - title: SPI
998            scope: st-spi
999
1000          - title: UART
1001            scope: st-uart
1002
1003            subsections:
1004              - title: STM32 Console
1005                scope: stm32-console
1006
1007                deprecated:
1008                  - stm32_console
1009
1010          - title: USB
1011            scope: st-usb
1012
1013            deprecated:
1014              - drivers/st/usb
1015
1016          - title: Watchdog
1017            scope: st-iwdg
1018
1019      - title: USB
1020        scope: usb
1021
1022        deprecated:
1023          - drivers/usb
1024
1025  - title: Miscellaneous
1026
1027    subsections:
1028      - title: AArch64
1029        scope: aarch64
1030
1031      - title: Debug
1032        scope: debug
1033
1034        deprecated:
1035          - common/debug
1036
1037      - title: CRC32
1038        scope: crc32
1039
1040        subsections:
1041          - title: Hardware CRC32
1042            scope: hw-crc32
1043
1044            deprecated:
1045              - hw_crc
1046              - hw_crc32
1047
1048          - title: Software CRC32
1049            scope: sw-crc32
1050
1051            deprecated:
1052              - sw_crc32
1053
1054      - title: DT Bindings
1055        scope: dt-bindings
1056
1057      - title: FDT Wrappers
1058        scope: fdt-wrappers
1059
1060      - title: FDTs
1061        scope: fdts
1062
1063        deprecated:
1064          - fdt
1065
1066        subsections:
1067          - title: Morello
1068            scope: morello-fdts
1069
1070            deprecated:
1071              - fdts/morello
1072
1073          - title: STM32MP1
1074            scope: stm32mp1-fdts
1075
1076            deprecated:
1077              - fdts stm32mp1
1078
1079            subsections:
1080              - title: STM32MP13
1081                scope: stm32mp13-fdts
1082
1083              - title: STM32MP15
1084                scope: stm32mp15-fdts
1085
1086      - title: PIE
1087        scope: pie
1088
1089      - title: Security
1090        scope: security
1091
1092      - title: SDEI
1093        scope: sdei
1094
1095      - title: TBBR
1096        scope: tbbr
1097
1098      - title: NXP
1099
1100        subsections:
1101          - title: OCRAM
1102            scope: nxp-ocram
1103
1104            deprecated:
1105              - nxp/common/ocram
1106
1107          - title: PSCI
1108            scope: nxp-psci
1109
1110            deprecated:
1111              - plat/nxp/common/psci
1112
1113  - title: Documentation
1114    scope: docs
1115
1116    deprecated:
1117      - doc
1118
1119    subsections:
1120      - title: Changelog
1121        scope: changelog
1122
1123      - title: Commit Style
1124        scope: commit-style
1125
1126      - title: Contribution Guidelines
1127        scope: contributing
1128
1129        deprecated:
1130          - contribution-guidelines
1131          - docs-contributing.rst
1132
1133      - title: Maintainers
1134        scope: maintainers
1135
1136      - title: Prerequisites
1137        scope: prerequisites
1138
1139      - title: Threat Model
1140        scope: threat-model
1141
1142  - title: Build System
1143    scope: build
1144
1145    deprecated:
1146      - makefile
1147      - Makefile
1148
1149    subsections:
1150      - title: Git Hooks
1151        scope: hooks
1152
1153  - title: Tools
1154
1155    subsections:
1156      - title: STM32 Image
1157        scope: stm32image
1158
1159        deprecated:
1160          - tools/stm32image
1161
1162      - title: NXP Tools
1163        scope: nxp-tools
1164
1165      - title: Firmware Image Package Tool
1166        scope: fiptool
1167
1168      - title: Secure Partition Tool
1169        scope: sptool
1170
1171      - title: Certificate Creation Tool
1172        scope: cert-create
1173
1174  - title: Dependencies
1175    scope: deps
1176
1177    subsections:
1178      - title: checkpatch
1179        scope: checkpatch
1180
1181      - title: commitlint
1182        scope: commitlint
1183
1184      - title: Compiler runtime libraries
1185        scope: compiler-rt
1186
1187      - title: libfdt
1188        scope: libfdt
1189
1190      - title: Node Package Manager (NPM)
1191        scope: npm
1192
1193      - title: zlib
1194        scope: zlib
1195
1196