xref: /rk3399_ARM-atf/changelog.yaml (revision c1f5a0925ddf84981d9e176d146bfddb48eb45d1)
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: MSM8916
352            scope: msm8916
353
354      - title: Raspberry Pi
355        scope: rpi
356
357        subsections:
358          - title: Raspberry Pi 4
359            scope: rpi4
360
361      - title: Renesas
362        scope: renesas
363
364        subsections:
365          - title: R-Car
366            scope: rcar
367
368            deprecated:
369              - plat/rcar
370
371            subsections:
372              - title: R-Car 3
373                scope: rcar3
374
375                deprecated:
376                  - plat/rcar3
377
378      - title: Rockchip
379        scope: rockchip
380
381        subsections:
382          - title: RK3399
383            scope: rk3399
384
385            deprecated:
386              - rockchip/rk3399
387              - rk3399/suspend
388
389      - title: Socionext
390        scope: socionext
391
392        subsections:
393          - title: Synquacer
394            scope: synquacer
395
396            deprecated:
397              - plat/synquacer
398
399      - title: ST
400        scope: st
401
402        deprecated:
403          - plat/st
404
405        subsections:
406          - title: ST32MP1
407            scope: stm32mp1
408
409            deprecated:
410              - plat/st/stm32mp1
411
412      - title: Xilinx
413        scope: xilinx
414
415        deprecated:
416          - plat/xilinx
417
418        subsections:
419          - title: Versal
420            scope: versal
421
422            deprecated:
423              - plat/xilinx/versal/include
424              - plat/xilinx/versal
425              - plat/versal
426
427          - title: ZynqMP
428            scope: zynqmp
429
430            deprecated:
431              - plat/zynqmp
432              - plat/xilinx/zynqmp
433
434  - title: Bootloader Images
435    scope: bl
436
437    deprecated:
438      - bl_common
439
440    subsections:
441      - title: BL1
442        scope: bl1
443
444      - title: BL2
445        scope: bl2
446
447  - title: Services
448    scope: services
449
450    subsections:
451      - title: FF-A
452        scope: ff-a
453
454        deprecated:
455          - ffa
456
457      - title: RME
458        scope: rme
459
460      - title: SPM
461        scope: spm
462
463        deprecated:
464          - spmc
465          - spmd
466          - SPMD
467
468      - title: SPM MM
469        scope: spm-mm
470
471  - title: Libraries
472
473    subsections:
474      - title: CPU Support
475        scope: cpus
476
477        deprecated:
478          - cpu
479          - errata
480          - errata_report
481
482      - title: EL3 Runtime
483        scope: el3-runtime
484
485        deprecated:
486          - el3_runtime
487
488      - title: FCONF
489        scope: fconf
490
491      - title: MPMM
492        scope: mpmm
493
494      - title: OP-TEE
495        scope: optee
496
497        deprecated:
498          - lib/optee
499
500      - title: PSCI
501        scope: psci
502
503      - title: GPT
504        scope: gpt
505
506        deprecated:
507          - gpt_rme
508
509      - title: SMCCC
510        scope: smccc
511
512      - title: Translation Tables
513        scope: xlat
514
515  - title: Drivers
516
517    subsections:
518      - title: Authentication
519        scope: auth
520
521        deprecated:
522          - driver/auth
523
524        subsections:
525          - title: CryptoCell-713
526            scope: cc-713
527
528      - title: FWU
529        scope: fwu
530
531        deprecated:
532          - fwu_metadata
533
534      - title: I/O
535        scope: io
536
537        subsections:
538          - title: MTD
539            scope: mtd
540
541            deprecated:
542              - io_mtd
543
544      - title: Measured Boot
545        scope: measured-boot
546
547        deprecated:
548          - measured boot
549          - measured_boot
550
551      - title: MMC
552        scope: mmc
553
554        deprecated:
555          - drivers/mmc
556
557      - title: MTD
558        scope: mtd
559
560        deprecated:
561          - drivers/mtd
562
563        subsections:
564          - title: NAND
565            scope: nand
566
567            subsections:
568              - title: SPI NAND
569                scope: spi-nand
570
571                deprecated:
572                  - spi_nand
573
574      - title: Partition
575        scope: partition
576
577      - title: SCMI
578        scope: scmi
579
580        deprecated:
581          - scmi_common
582          - drivers/scmi-msg
583
584      - title: UFS
585        scope: ufs
586
587      - title: Arm
588        scope: arm-drivers
589
590        subsections:
591          - title: Ethos-N
592            scope: ethos-n
593
594            deprecated:
595              - drivers/arm/ethosn
596
597          - title: GIC
598            scope: gic
599
600            subsections:
601              - title: GICv3
602                scope: gicv3
603
604                subsections:
605                  - title: GIC-600AE
606                    scope: gic600ae
607
608          - title: TZC
609            scope: tzc
610
611            subsections:
612              - title: TZC-400
613                scope: tzc400
614
615                deprecated:
616                  - drivers/tzc400
617
618      - title: Marvell
619        scope: marvell-drivers
620
621        subsections:
622          - title: COMPHY
623            scope: marvell-comphy
624
625            deprecated:
626              - drivers/marvell/comphy
627
628            subsections:
629              - title: Armada 3700
630                scope: marvell-comphy-3700
631
632                deprecated:
633                  - drivers/marvell/comphy-3700
634
635              - title: CP110
636                scope: marvell-comphy-cp110
637
638                deprecated:
639                  - drivers/marvell/comphy-cp110
640
641          - title: UART
642            scope: marvell-uart
643
644            deprecated:
645              - plat/marvell/uart
646
647          - title: Armada
648            scope: armada-drivers
649
650            subsections:
651              - title: A3K
652                scope: a3k-drivers
653
654                subsections:
655                  - title: A3720
656                    scope: a3720-uart
657
658                    deprecated:
659                      - plat/marvell/a3720/uart
660
661      - title: MediaTek
662        scope: mediatek-drivers
663
664        subsections:
665          - title: APU
666            scope: mediatek-apu
667
668            deprecated:
669              - plat/mediatek/apu
670
671          - title: EMI MPU
672            scope: mediatek-emi-mpu
673
674            deprecated:
675              - plat/mediatek/mpu
676
677          - title: PMIC Wrapper
678            scope: mediatek-pmic-wrapper
679
680            deprecated:
681              - plat/mediatek/pmic_wrap
682
683          - title: MT8192
684            scope: mt8192-drivers
685
686            subsections:
687              - title: SPM
688                scope: mt8192-spm
689
690                deprecated:
691                  - mediatek/mt8192/spm
692
693      - title: NXP
694        scope: nxp-drivers
695
696        subsections:
697          - title: DCFG
698            scope: nxp-dcfg
699
700            deprecated:
701              - driver/nxp/dcfg
702
703          - title: FLEXSPI
704            scope: flexspi
705
706            deprecated:
707              - include/drivers/flexspi
708              - driver/nxp/xspi
709
710          - title: SCFG
711            scope: nxp-scfg
712
713            deprecated:
714              - nxp/scfg
715
716          - title: SFP
717            scope: nxp-sfp
718
719            deprecated:
720              - drivers/nxp/sfp
721
722      - title: Renesas
723        scope: renesas-drivers
724
725        subsections:
726          - title: R-Car3
727            scope: rcar3-drivers
728
729            deprecated:
730              - drivers/rcar3
731
732      - title: ST
733        scope: st-drivers
734
735        deprecated:
736          - drivers/st
737
738        subsections:
739          - title: BSEC
740            scope: st-bsec
741
742          - title: Clock
743            scope: st-clock
744
745            deprecated:
746              - stm32mp_clk
747              - drivers/st/clk
748              - stm32mp1_clk
749
750          - title: Crypto
751            scope: st-crypto
752
753          - title: DDR
754            scope: st-ddr
755
756          - title: I/O
757            scope: st-io-drivers
758
759            subsections:
760              - title: STM32 Image
761                scope: st-io-stm32image
762
763                deprecated:
764                  - io-stm32image
765                  - io_stm32image
766
767              - title: fiptool
768                scope: fiptool
769
770          - title: I2C
771            scope: st-i2c
772
773          - title: FMC
774            scope: st-fmc
775
776          - title: GPIO
777            scope: st-gpio
778
779          - title: SDMMC2
780            scope: st-sdmmc2
781
782            deprecated:
783              - stm32_sdmmc2
784
785          - title: ST PMIC
786            scope: st-pmic
787
788            deprecated:
789              - drivers/st/pmic
790
791          - title: STPMIC1
792            scope: stpmic1
793
794          - title: Regulator
795            scope: st-regulator
796
797          - title: Reset
798            scope: st-reset
799
800          - title: SPI
801            scope: st-spi
802
803          - title: UART
804            scope: st-uart
805
806            subsections:
807              - title: STM32 Console
808                scope: stm32-console
809
810                deprecated:
811                  - stm32_console
812
813          - title: USB
814            scope: st-usb
815
816            deprecated:
817              - drivers/st/usb
818
819          - title: Watchdog
820            scope: st-iwdg
821
822      - title: USB
823        scope: usb
824
825        deprecated:
826          - drivers/usb
827
828  - title: Miscellaneous
829
830    subsections:
831      - title: AArch64
832        scope: aarch64
833
834      - title: Debug
835        scope: debug
836
837        deprecated:
838          - common/debug
839
840      - title: CRC32
841        scope: crc32
842
843        subsections:
844          - title: Hardware CRC32
845            scope: hw-crc32
846
847            deprecated:
848              - hw_crc
849              - hw_crc32
850
851          - title: Software CRC32
852            scope: sw-crc32
853
854            deprecated:
855              - sw_crc32
856
857      - title: DT Bindings
858        scope: dt-bindings
859
860      - title: FDT Wrappers
861        scope: fdt-wrappers
862
863      - title: FDTs
864        scope: fdts
865
866        deprecated:
867          - fdt
868
869        subsections:
870          - title: Morello
871            scope: morello-fdts
872
873            deprecated:
874              - fdts/morello
875
876          - title: STM32MP1
877            scope: stm32mp1-fdts
878
879            deprecated:
880              - fdts stm32mp1
881
882      - title: PIE
883        scope: pie
884
885      - title: Security
886        scope: security
887
888      - title: SDEI
889        scope: sdei
890
891      - title: TBBR
892        scope: tbbr
893
894      - title: NXP
895
896        subsections:
897          - title: OCRAM
898            scope: nxp-ocram
899
900            deprecated:
901              - nxp/common/ocram
902
903          - title: PSCI
904            scope: nxp-psci
905
906            deprecated:
907              - plat/nxp/common/psci
908
909  - title: Documentation
910    scope: docs
911
912    deprecated:
913      - doc
914
915    subsections:
916      - title: Changelog
917        scope: changelog
918
919      - title: Commit Style
920        scope: commit-style
921
922      - title: Contribution Guidelines
923        scope: contributing
924
925        deprecated:
926          - contribution-guidelines
927          - docs-contributing.rst
928
929      - title: Maintainers
930        scope: maintainers
931
932      - title: Prerequisites
933        scope: prerequisites
934
935  - title: Build System
936    scope: build
937
938    deprecated:
939      - makefile
940      - Makefile
941
942    subsections:
943      - title: Git Hooks
944        scope: hooks
945
946  - title: Tools
947
948    subsections:
949      - title: STM32 Image
950        scope: stm32image
951
952        deprecated:
953          - tools/stm32image
954
955  - title: Dependencies
956    scope: deps
957
958    subsections:
959      - title: checkpatch
960        scope: checkpatch
961
962      - title: commitlint
963        scope: commitlint
964
965      - title: libfdt
966        scope: libfdt
967
968      - title: Node Package Manager (NPM)
969        scope: npm
970