blob: 4e187ef0e081ffb9ca30306b7fda400cccc822b5 [file] [log] [blame]
Chris Kay82117d72021-12-01 16:34:55 +00001#
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: SCMI
570 scope: scmi
571
572 deprecated:
573 - scmi_common
574 - drivers/scmi-msg
575
576 - title: UFS
577 scope: ufs
578
579 - title: Arm
580 scope: arm-drivers
581
582 subsections:
583 - title: Ethos-N
584 scope: ethos-n
585
586 deprecated:
587 - drivers/arm/ethosn
588
589 - title: GIC
590 scope: gic
591
592 subsections:
593 - title: GICv3
594 scope: gicv3
595
596 subsections:
597 - title: GIC-600AE
598 scope: gic600ae
599
600 - title: TZC
601 scope: tzc
602
603 subsections:
604 - title: TZC-400
605 scope: tzc400
606
607 deprecated:
608 - drivers/tzc400
609
610 - title: Marvell
611 scope: marvell-drivers
612
613 subsections:
614 - title: COMPHY
615 scope: marvell-comphy
616
617 deprecated:
618 - drivers/marvell/comphy
619
620 subsections:
621 - title: Armada 3700
622 scope: marvell-comphy-3700
623
624 deprecated:
625 - drivers/marvell/comphy-3700
626
627 - title: CP110
628 scope: marvell-comphy-cp110
629
630 deprecated:
631 - drivers/marvell/comphy-cp110
632
633 - title: UART
634 scope: marvell-uart
635
636 deprecated:
637 - plat/marvell/uart
638
639 - title: Armada
640 scope: armada-drivers
641
642 subsections:
643 - title: A3K
644 scope: a3k-drivers
645
646 subsections:
647 - title: A3720
648 scope: a3720-uart
649
650 deprecated:
651 - plat/marvell/a3720/uart
652
653 - title: MediaTek
654 scope: mediatek-drivers
655
656 subsections:
657 - title: APU
658 scope: mediatek-apu
659
660 deprecated:
661 - plat/mediatek/apu
662
663 - title: EMI MPU
664 scope: mediatek-emi-mpu
665
666 deprecated:
667 - plat/mediatek/mpu
668
669 - title: PMIC Wrapper
670 scope: mediatek-pmic-wrapper
671
672 deprecated:
673 - plat/mediatek/pmic_wrap
674
675 - title: MT8192
676 scope: mt8192-drivers
677
678 subsections:
679 - title: SPM
680 scope: mt8192-spm
681
682 deprecated:
683 - mediatek/mt8192/spm
684
685 - title: NXP
686 scope: nxp-drivers
687
688 subsections:
689 - title: DCFG
690 scope: nxp-dcfg
691
692 deprecated:
693 - driver/nxp/dcfg
694
695 - title: FLEXSPI
696 scope: flexspi
697
698 deprecated:
699 - include/drivers/flexspi
700 - driver/nxp/xspi
701
702 - title: SCFG
703 scope: nxp-scfg
704
705 deprecated:
706 - nxp/scfg
707
708 - title: SFP
709 scope: nxp-sfp
710
711 deprecated:
712 - drivers/nxp/sfp
713
714 - title: Renesas
715 scope: renesas-drivers
716
717 subsections:
718 - title: R-Car3
719 scope: rcar3-drivers
720
721 deprecated:
722 - drivers/rcar3
723
724 - title: ST
725 scope: st-drivers
726
727 deprecated:
728 - drivers/st
729
730 subsections:
731 - title: Clock
732 scope: st-clock
733
734 deprecated:
735 - stm32mp_clk
736 - drivers/st/clk
737 - stm32mp1_clk
738
739 - title: I/O
740 scope: st-io-drivers
741
742 subsections:
743 - title: STM32 Image
744 scope: st-io-stm32image
745
746 deprecated:
747 - io-stm32image
748 - io_stm32image
749
750 - title: fiptool
751 scope: fiptool
752
753 - title: SDMMC2
754 scope: st-sdmmc2
755
756 deprecated:
757 - stm32_sdmmc2
758
759 - title: ST PMIC
760 scope: st-pmic
761
762 deprecated:
763 - drivers/st/pmic
764
765 - title: STPMIC1
766 scope: stpmic1
767
768 - title: UART
769 scope: st-uart
770
771 subsections:
772 - title: STM32 Console
773 scope: stm32-console
774
775 deprecated:
776 - stm32_console
777
778 - title: USB
779 scope: st-usb
780
781 deprecated:
782 - drivers/st/usb
783
784 - title: USB
785 scope: usb
786
787 deprecated:
788 - drivers/usb
789
790 - title: Miscellaneous
791
792 subsections:
793 - title: AArch64
794 scope: aarch64
795
796 - title: Debug
797 scope: debug
798
799 deprecated:
800 - common/debug
801
802 - title: CRC32
803 scope: crc32
804
805 subsections:
806 - title: Hardware CRC32
807 scope: hw-crc32
808
809 deprecated:
810 - hw_crc
811 - hw_crc32
812
813 - title: Software CRC32
814 scope: sw-crc32
815
816 deprecated:
817 - sw_crc32
818
819 - title: DT Bindings
820 scope: dt-bindings
821
822 - title: FDT Wrappers
823 scope: fdt-wrappers
824
825 - title: FDTs
826 scope: fdts
827
828 deprecated:
829 - fdt
830
831 subsections:
832 - title: Morello
833 scope: morello-fdts
834
835 deprecated:
836 - fdts/morello
837
838 - title: STM32MP1
839 scope: stm32mp1-fdts
840
841 deprecated:
842 - fdts stm32mp1
843
844 - title: PIE
845 scope: pie
846
847 - title: Security
848 scope: security
849
850 - title: SDEI
851 scope: sdei
852
853 - title: TBBR
854 scope: tbbr
855
856 - title: NXP
857
858 subsections:
859 - title: OCRAM
860 scope: nxp-ocram
861
862 deprecated:
863 - nxp/common/ocram
864
865 - title: PSCI
866 scope: nxp-psci
867
868 deprecated:
869 - plat/nxp/common/psci
870
871 - title: Documentation
872 scope: docs
873
874 deprecated:
875 - doc
876
877 subsections:
878 - title: Changelog
879 scope: changelog
880
881 - title: Commit Style
882 scope: commit-style
883
884 - title: Contribution Guidelines
885 scope: contributing
886
887 deprecated:
888 - contribution-guidelines
889 - docs-contributing.rst
890
891 - title: Maintainers
892 scope: maintainers
893
894 - title: Prerequisites
895 scope: prerequisites
896
897 - title: Build System
898 scope: build
899
900 deprecated:
901 - makefile
902 - Makefile
903
904 subsections:
905 - title: Git Hooks
906 scope: hooks
907
908 - title: Tools
909
910 subsections:
911 - title: STM32 Image
912 scope: stm32image
913
914 deprecated:
915 - tools/stm32image
916
917 - title: Dependencies
918 scope: deps
919
920 subsections:
921 - title: checkpatch
922 scope: checkpatch
923
924 - title: commitlint
925 scope: commitlint
926
927 - title: libfdt
928 scope: libfdt
929
930 - title: Node Package Manager (NPM)
931 scope: npm