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