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