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