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