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