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