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