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