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