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