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