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