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