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