xref: /rk3399_ARM-atf/changelog.yaml (revision d64bfef5a184aa6951a7bc641f80b0d629cc46b4)
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: 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: Libraries
596
597    subsections:
598      - title: CPU Support
599        scope: cpus
600
601        deprecated:
602          - cpu
603          - errata
604          - errata_report
605
606      - title: EL3 Runtime
607        scope: el3-runtime
608
609        deprecated:
610          - el3_runtime
611
612        subsections:
613          - title: Context Management
614            scope: cm
615
616      - title: FCONF
617        scope: fconf
618
619      - title: MPMM
620        scope: mpmm
621
622      - title: OP-TEE
623        scope: optee
624
625        deprecated:
626          - lib/optee
627
628      - title: PSCI
629        scope: psci
630
631      - title: GPT
632        scope: gpt
633
634        deprecated:
635          - gpt_rme
636
637      - title: SMCCC
638        scope: smccc
639
640      - title: Translation Tables
641        scope: xlat
642
643      - title: C Standard Library
644        scope: libc
645
646      - title: Locks
647        scope: locks
648
649      - title: PSA
650        scope: psa
651
652      - title: Context Management
653        scope: context mgmt
654
655  - title: Drivers
656
657    subsections:
658      - title: Authentication
659        scope: auth
660
661        deprecated:
662          - driver/auth
663
664        subsections:
665          - title: CryptoCell-713
666            scope: cc-713
667
668      - title: Generic Clock
669        scope: clk
670
671      - title: FWU
672        scope: fwu
673
674        deprecated:
675          - fwu_metadata
676
677      - title: I/O
678        scope: io
679
680        subsections:
681          - title: MTD
682            scope: mtd
683
684            deprecated:
685              - io_mtd
686
687      - title: Measured Boot
688        scope: measured-boot
689
690        deprecated:
691          - measured boot
692          - measured_boot
693
694      - title: MMC
695        scope: mmc
696
697        deprecated:
698          - drivers/mmc
699
700      - title: MTD
701        scope: mtd
702
703        deprecated:
704          - drivers/mtd
705
706        subsections:
707          - title: NAND
708            scope: nand
709
710            subsections:
711              - title: SPI NAND
712                scope: spi-nand
713
714                deprecated:
715                  - spi_nand
716
717      - title: GUID Partition Tables Support
718        scope: guid-partition
719
720      - title: SCMI
721        scope: scmi
722
723        deprecated:
724          - scmi_common
725          - drivers/scmi-msg
726
727      - title: UFS
728        scope: ufs
729
730      - title: Arm
731        scope: arm-drivers
732
733        subsections:
734          - title: Ethos-N
735            scope: ethos-n
736
737            deprecated:
738              - drivers/arm/ethosn
739
740          - title: GIC
741            scope: gic
742
743            subsections:
744              - title: GICv3
745                scope: gicv3
746
747                subsections:
748                  - title: GIC-600AE
749                    scope: gic600ae
750
751          - title: SMMU
752            scope: smmu
753
754          - title: MHU
755            scope: mhu
756
757            deprecated:
758              - drivers/arm/mhu
759
760          - title: RSS
761            scope: rss
762
763            deprecated:
764              - drivers/arm/rss
765
766          - title: TZC
767            scope: tzc
768
769            subsections:
770              - title: TZC-400
771                scope: tzc400
772
773                deprecated:
774                  - drivers/tzc400
775
776              - title: TZC-380
777                scope: tzc380
778
779                deprecated:
780                  - drivers/tzc380
781
782      - title: Marvell
783        scope: marvell-drivers
784
785        subsections:
786          - title: COMPHY
787            scope: marvell-comphy
788
789            deprecated:
790              - drivers/marvell/comphy
791
792            subsections:
793              - title: Armada 3700
794                scope: marvell-comphy-3700
795
796                deprecated:
797                  - drivers/marvell/comphy-3700
798
799              - title: CP110
800                scope: marvell-comphy-cp110
801
802                deprecated:
803                  - drivers/marvell/comphy-cp110
804
805          - title: UART
806            scope: marvell-uart
807
808            deprecated:
809              - plat/marvell/uart
810
811          - title: Armada
812            scope: armada-drivers
813
814            subsections:
815              - title: A3K
816                scope: a3k-drivers
817
818                subsections:
819                  - title: A3720
820                    scope: a3720-uart
821
822                    deprecated:
823                      - plat/marvell/a3720/uart
824
825      - title: MediaTek
826        scope: mediatek-drivers
827
828        subsections:
829          - title: APU
830            scope: mediatek-apu
831
832            deprecated:
833              - plat/mediatek/apu
834
835          - title: EMI MPU
836            scope: mediatek-emi-mpu
837
838            deprecated:
839              - plat/mediatek/mpu
840
841          - title: PMIC Wrapper
842            scope: mediatek-pmic-wrapper
843
844            deprecated:
845              - plat/mediatek/pmic_wrap
846
847          - title: MT8192
848            scope: mt8192-drivers
849
850            subsections:
851              - title: SPM
852                scope: mt8192-spm
853
854                deprecated:
855                  - mediatek/mt8192/spm
856
857      - title: NXP
858        scope: nxp-drivers
859
860        subsections:
861          - title: DCFG
862            scope: nxp-dcfg
863
864            deprecated:
865              - driver/nxp/dcfg
866
867          - title: FLEXSPI
868            scope: flexspi
869
870            deprecated:
871              - include/drivers/flexspi
872              - driver/nxp/xspi
873
874          - title: SCFG
875            scope: nxp-scfg
876
877            deprecated:
878              - nxp/scfg
879
880          - title: SFP
881            scope: nxp-sfp
882
883            deprecated:
884              - drivers/nxp/sfp
885
886          - title: QSPI
887            scope: nxp-qspi
888
889          - title: NXP Crypto
890            scope: nxp-crypto
891
892          - title: DDR
893            scope: nxp-ddr
894
895          - title: GIC
896            scope: nxp-gic
897
898          - title: CSU
899            scope: nxp-csu
900
901          - title: IFC NAND
902            scope: nxp-ifc-nand
903
904          - title: IFC NOR
905            scope: nxp-ifc-nor
906
907          - title: TZC-380
908            scope: nxp-tzc380
909
910      - title: Renesas
911        scope: renesas-drivers
912
913        subsections:
914          - title: R-Car3
915            scope: rcar3-drivers
916
917            deprecated:
918              - drivers/rcar3
919
920      - title: ST
921        scope: st-drivers
922
923        deprecated:
924          - drivers/st
925
926        subsections:
927          - title: BSEC
928            scope: st-bsec
929
930          - title: Clock
931            scope: st-clock
932
933            deprecated:
934              - stm32mp_clk
935              - drivers/st/clk
936              - stm32mp1_clk
937
938          - title: Crypto
939            scope: st-crypto
940
941          - title: DDR
942            scope: st-ddr
943
944          - title: I/O
945            scope: st-io-drivers
946
947            subsections:
948              - title: STM32 Image
949                scope: st-io-stm32image
950
951                deprecated:
952                  - io-stm32image
953                  - io_stm32image
954
955          - title: I2C
956            scope: st-i2c
957
958          - title: FMC
959            scope: st-fmc
960
961          - title: GPIO
962            scope: st-gpio
963
964          - title: SDMMC2
965            scope: st-sdmmc2
966
967            deprecated:
968              - stm32_sdmmc2
969
970          - title: ST PMIC
971            scope: st-pmic
972
973            deprecated:
974              - drivers/st/pmic
975
976          - title: STPMIC1
977            scope: stpmic1
978
979          - title: Regulator
980            scope: st-regulator
981
982          - title: Reset
983            scope: st-reset
984
985          - title: SPI
986            scope: st-spi
987
988          - title: UART
989            scope: st-uart
990
991            subsections:
992              - title: STM32 Console
993                scope: stm32-console
994
995                deprecated:
996                  - stm32_console
997
998          - title: USB
999            scope: st-usb
1000
1001            deprecated:
1002              - drivers/st/usb
1003
1004          - title: Watchdog
1005            scope: st-iwdg
1006
1007      - title: USB
1008        scope: usb
1009
1010        deprecated:
1011          - drivers/usb
1012
1013  - title: Miscellaneous
1014
1015    subsections:
1016      - title: AArch64
1017        scope: aarch64
1018
1019      - title: Debug
1020        scope: debug
1021
1022        deprecated:
1023          - common/debug
1024
1025      - title: CRC32
1026        scope: crc32
1027
1028        subsections:
1029          - title: Hardware CRC32
1030            scope: hw-crc32
1031
1032            deprecated:
1033              - hw_crc
1034              - hw_crc32
1035
1036          - title: Software CRC32
1037            scope: sw-crc32
1038
1039            deprecated:
1040              - sw_crc32
1041
1042      - title: DT Bindings
1043        scope: dt-bindings
1044
1045      - title: FDT Wrappers
1046        scope: fdt-wrappers
1047
1048      - title: FDTs
1049        scope: fdts
1050
1051        deprecated:
1052          - fdt
1053
1054        subsections:
1055          - title: Morello
1056            scope: morello-fdts
1057
1058            deprecated:
1059              - fdts/morello
1060
1061          - title: STM32MP1
1062            scope: stm32mp1-fdts
1063
1064            deprecated:
1065              - fdts stm32mp1
1066
1067            subsections:
1068              - title: STM32MP13
1069                scope: stm32mp13-fdts
1070
1071              - title: STM32MP15
1072                scope: stm32mp15-fdts
1073
1074      - title: PIE
1075        scope: pie
1076
1077      - title: Security
1078        scope: security
1079
1080      - title: SDEI
1081        scope: sdei
1082
1083      - title: TBBR
1084        scope: tbbr
1085
1086      - title: NXP
1087
1088        subsections:
1089          - title: OCRAM
1090            scope: nxp-ocram
1091
1092            deprecated:
1093              - nxp/common/ocram
1094
1095          - title: PSCI
1096            scope: nxp-psci
1097
1098            deprecated:
1099              - plat/nxp/common/psci
1100
1101  - title: Documentation
1102    scope: docs
1103
1104    deprecated:
1105      - doc
1106
1107    subsections:
1108      - title: Changelog
1109        scope: changelog
1110
1111      - title: Commit Style
1112        scope: commit-style
1113
1114      - title: Contribution Guidelines
1115        scope: contributing
1116
1117        deprecated:
1118          - contribution-guidelines
1119          - docs-contributing.rst
1120
1121      - title: Maintainers
1122        scope: maintainers
1123
1124      - title: Prerequisites
1125        scope: prerequisites
1126
1127      - title: Threat Model
1128        scope: threat-model
1129
1130  - title: Build System
1131    scope: build
1132
1133    deprecated:
1134      - makefile
1135      - Makefile
1136
1137    subsections:
1138      - title: Git Hooks
1139        scope: hooks
1140
1141  - title: Tools
1142
1143    subsections:
1144      - title: STM32 Image
1145        scope: stm32image
1146
1147        deprecated:
1148          - tools/stm32image
1149
1150      - title: NXP Tools
1151        scope: nxp-tools
1152
1153      - title: Firmware Image Package Tool
1154        scope: fiptool
1155
1156      - title: Secure Partition Tool
1157        scope: sptool
1158
1159      - title: Certificate Creation Tool
1160        scope: cert-create
1161
1162  - title: Dependencies
1163    scope: deps
1164
1165    subsections:
1166      - title: checkpatch
1167        scope: checkpatch
1168
1169      - title: commitlint
1170        scope: commitlint
1171
1172      - title: libfdt
1173        scope: libfdt
1174
1175      - title: Node Package Manager (NPM)
1176        scope: npm
1177