xref: /rk3399_ARM-atf/changelog.yaml (revision 6aaf257de4a4070ebc233f35a09bce4c39ea038c)
1#
2# Copyright (c) 2021, 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: ffa
450
451        deprecated:
452          - ff-a
453
454      - title: RME
455        scope: rme
456
457      - title: SPM
458        scope: spm
459
460        deprecated:
461          - spmc
462          - spmd
463          - SPMD
464          - spm_mm
465
466  - title: Libraries
467
468    subsections:
469      - title: CPU Support
470        scope: cpus
471
472        deprecated:
473          - cpu
474          - errata
475          - errata_report
476
477      - title: EL3 Runtime
478        scope: el3-runtime
479
480        deprecated:
481          - el3_runtime
482
483      - title: FCONF
484        scope: fconf
485
486      - title: MPMM
487        scope: mpmm
488
489      - title: OP-TEE
490        scope: optee
491
492        deprecated:
493          - lib/optee
494
495      - title: PSCI
496        scope: psci
497
498      - title: GPT
499        scope: gpt
500
501        deprecated:
502          - gpt_rme
503
504      - title: SMCCC
505        scope: smccc
506
507      - title: Translation Tables
508        scope: xlat
509
510  - title: Drivers
511
512    subsections:
513      - title: Authentication
514        scope: auth
515
516        deprecated:
517          - driver/auth
518
519        subsections:
520          - title: CryptoCell-713
521            scope: cc-713
522
523      - title: FWU
524        scope: fwu
525
526        deprecated:
527          - fwu_metadata
528
529      - title: I/O
530        scope: io
531
532        subsections:
533          - title: MTD
534            scope: mtd
535
536            deprecated:
537              - io_mtd
538
539      - title: Measured Boot
540        scope: measured-boot
541
542        deprecated:
543          - measured boot
544          - measured_boot
545
546      - title: MMC
547        scope: mmc
548
549        deprecated:
550          - drivers/mmc
551
552      - title: MTD
553        scope: mtd
554
555        deprecated:
556          - drivers/mtd
557
558        subsections:
559          - title: NAND
560            scope: nand
561
562            subsections:
563              - title: SPI NAND
564                scope: spi-nand
565
566                deprecated:
567                  - spi_nand
568
569      - title: Partition
570        scope: partition
571
572      - title: SCMI
573        scope: scmi
574
575        deprecated:
576          - scmi_common
577          - drivers/scmi-msg
578
579      - title: UFS
580        scope: ufs
581
582      - title: Arm
583        scope: arm-drivers
584
585        subsections:
586          - title: Ethos-N
587            scope: ethos-n
588
589            deprecated:
590              - drivers/arm/ethosn
591
592          - title: GIC
593            scope: gic
594
595            subsections:
596              - title: GICv3
597                scope: gicv3
598
599                subsections:
600                  - title: GIC-600AE
601                    scope: gic600ae
602
603          - title: TZC
604            scope: tzc
605
606            subsections:
607              - title: TZC-400
608                scope: tzc400
609
610                deprecated:
611                  - drivers/tzc400
612
613      - title: Marvell
614        scope: marvell-drivers
615
616        subsections:
617          - title: COMPHY
618            scope: marvell-comphy
619
620            deprecated:
621              - drivers/marvell/comphy
622
623            subsections:
624              - title: Armada 3700
625                scope: marvell-comphy-3700
626
627                deprecated:
628                  - drivers/marvell/comphy-3700
629
630              - title: CP110
631                scope: marvell-comphy-cp110
632
633                deprecated:
634                  - drivers/marvell/comphy-cp110
635
636          - title: UART
637            scope: marvell-uart
638
639            deprecated:
640              - plat/marvell/uart
641
642          - title: Armada
643            scope: armada-drivers
644
645            subsections:
646              - title: A3K
647                scope: a3k-drivers
648
649                subsections:
650                  - title: A3720
651                    scope: a3720-uart
652
653                    deprecated:
654                      - plat/marvell/a3720/uart
655
656      - title: MediaTek
657        scope: mediatek-drivers
658
659        subsections:
660          - title: APU
661            scope: mediatek-apu
662
663            deprecated:
664              - plat/mediatek/apu
665
666          - title: EMI MPU
667            scope: mediatek-emi-mpu
668
669            deprecated:
670              - plat/mediatek/mpu
671
672          - title: PMIC Wrapper
673            scope: mediatek-pmic-wrapper
674
675            deprecated:
676              - plat/mediatek/pmic_wrap
677
678          - title: MT8192
679            scope: mt8192-drivers
680
681            subsections:
682              - title: SPM
683                scope: mt8192-spm
684
685                deprecated:
686                  - mediatek/mt8192/spm
687
688      - title: NXP
689        scope: nxp-drivers
690
691        subsections:
692          - title: DCFG
693            scope: nxp-dcfg
694
695            deprecated:
696              - driver/nxp/dcfg
697
698          - title: FLEXSPI
699            scope: flexspi
700
701            deprecated:
702              - include/drivers/flexspi
703              - driver/nxp/xspi
704
705          - title: SCFG
706            scope: nxp-scfg
707
708            deprecated:
709              - nxp/scfg
710
711          - title: SFP
712            scope: nxp-sfp
713
714            deprecated:
715              - drivers/nxp/sfp
716
717      - title: Renesas
718        scope: renesas-drivers
719
720        subsections:
721          - title: R-Car3
722            scope: rcar3-drivers
723
724            deprecated:
725              - drivers/rcar3
726
727      - title: ST
728        scope: st-drivers
729
730        deprecated:
731          - drivers/st
732
733        subsections:
734          - title: Clock
735            scope: st-clock
736
737            deprecated:
738              - stm32mp_clk
739              - drivers/st/clk
740              - stm32mp1_clk
741
742          - title: I/O
743            scope: st-io-drivers
744
745            subsections:
746              - title: STM32 Image
747                scope: st-io-stm32image
748
749                deprecated:
750                  - io-stm32image
751                  - io_stm32image
752
753              - title: fiptool
754                scope: fiptool
755
756          - title: SDMMC2
757            scope: st-sdmmc2
758
759            deprecated:
760              - stm32_sdmmc2
761
762          - title: ST PMIC
763            scope: st-pmic
764
765            deprecated:
766              - drivers/st/pmic
767
768          - title: STPMIC1
769            scope: stpmic1
770
771          - title: UART
772            scope: st-uart
773
774            subsections:
775              - title: STM32 Console
776                scope: stm32-console
777
778                deprecated:
779                  - stm32_console
780
781          - title: USB
782            scope: st-usb
783
784            deprecated:
785              - drivers/st/usb
786
787      - title: USB
788        scope: usb
789
790        deprecated:
791          - drivers/usb
792
793  - title: Miscellaneous
794
795    subsections:
796      - title: AArch64
797        scope: aarch64
798
799      - title: Debug
800        scope: debug
801
802        deprecated:
803          - common/debug
804
805      - title: CRC32
806        scope: crc32
807
808        subsections:
809          - title: Hardware CRC32
810            scope: hw-crc32
811
812            deprecated:
813              - hw_crc
814              - hw_crc32
815
816          - title: Software CRC32
817            scope: sw-crc32
818
819            deprecated:
820              - sw_crc32
821
822      - title: DT Bindings
823        scope: dt-bindings
824
825      - title: FDT Wrappers
826        scope: fdt-wrappers
827
828      - title: FDTs
829        scope: fdts
830
831        deprecated:
832          - fdt
833
834        subsections:
835          - title: Morello
836            scope: morello-fdts
837
838            deprecated:
839              - fdts/morello
840
841          - title: STM32MP1
842            scope: stm32mp1-fdts
843
844            deprecated:
845              - fdts stm32mp1
846
847      - title: PIE
848        scope: pie
849
850      - title: Security
851        scope: security
852
853      - title: SDEI
854        scope: sdei
855
856      - title: TBBR
857        scope: tbbr
858
859      - title: NXP
860
861        subsections:
862          - title: OCRAM
863            scope: nxp-ocram
864
865            deprecated:
866              - nxp/common/ocram
867
868          - title: PSCI
869            scope: nxp-psci
870
871            deprecated:
872              - plat/nxp/common/psci
873
874  - title: Documentation
875    scope: docs
876
877    deprecated:
878      - doc
879
880    subsections:
881      - title: Changelog
882        scope: changelog
883
884      - title: Commit Style
885        scope: commit-style
886
887      - title: Contribution Guidelines
888        scope: contributing
889
890        deprecated:
891          - contribution-guidelines
892          - docs-contributing.rst
893
894      - title: Maintainers
895        scope: maintainers
896
897      - title: Prerequisites
898        scope: prerequisites
899
900  - title: Build System
901    scope: build
902
903    deprecated:
904      - makefile
905      - Makefile
906
907    subsections:
908      - title: Git Hooks
909        scope: hooks
910
911  - title: Tools
912
913    subsections:
914      - title: STM32 Image
915        scope: stm32image
916
917        deprecated:
918          - tools/stm32image
919
920  - title: Dependencies
921    scope: deps
922
923    subsections:
924      - title: checkpatch
925        scope: checkpatch
926
927      - title: commitlint
928        scope: commitlint
929
930      - title: libfdt
931        scope: libfdt
932
933      - title: Node Package Manager (NPM)
934        scope: npm
935