x86_64: x86_64 port doxygen and license cleanup

2025-12-12 19:06:28 +08:00 · 2024-08-07 15:25:00 -03:00
parent e93bbe6534
commit 018e7ad407
25 changed files with 81 additions and 62 deletions
--- a/bsps/x86_64/amd64/clock/clock.c
+++ b/bsps/x86_64/amd64/clock/clock.c
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,8 +9,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/console/console.c
+++ b/bsps/x86_64/amd64/console/console.c
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,8 +9,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/include/apic.h
+++ b/bsps/x86_64/amd64/include/apic.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,9 +9,8 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
 * Copyright (C) 2024 Matheus Pecoraro
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/include/bsp.h
+++ b/bsps/x86_64/amd64/include/bsp.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -8,14 +10,8 @@
 * @brief Global BSP definitions.
 */

-/*  bsp.h
- *
- *  This include file contains all board IO definitions.
- */
-
 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Copyright (c) 1989-1999.
 * On-Line Applications Research Corporation (OAR).
--- a/bsps/x86_64/amd64/include/clock.h
+++ b/bsps/x86_64/amd64/include/clock.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,8 +9,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/include/pic.h
+++ b/bsps/x86_64/amd64/include/pic.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,8 +9,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/include/start.h
+++ b/bsps/x86_64/amd64/include/start.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,8 +9,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/interrupts/idt.c
+++ b/bsps/x86_64/amd64/interrupts/idt.c
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,8 +9,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/interrupts/isr_handler.S
+++ b/bsps/x86_64/amd64/interrupts/isr_handler.S
@@ -1,12 +1,17 @@
-/*
- * This file contains the _ISR_Handler that acts as the common handler for all
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @ingroup RTEMSBSPsX8664AMD64
+ *
+ * @brief Contains the _ISR_Handler that acts as the common handler for all
 * vectors to be managed by the RTEMS interrupt manager.
 */

 /*
 * Copyright (C) 2024 Matheus Pecoraro
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/interrupts/pic.c
+++ b/bsps/x86_64/amd64/interrupts/pic.c
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -7,8 +9,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/start/ap_trampoline.S
+++ b/bsps/x86_64/amd64/start/ap_trampoline.S
@@ -1,6 +1,15 @@
-/*
- * SPDX-License-Identifier: BSD-2-Clause
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
 *
+ * @ingroup RTEMSBSPsX8664AMD64
+ *
+ * @brief Contains the trampoline code that will be executed by every
+ * Application Processor when first started.
+ */
+
+/*
 * Copyright (C) 2024 Matheus Pecoraro
 *
 * Redistribution and use in source and binary forms, with or without
@@ -25,11 +34,6 @@
 * POSSIBILITY OF SUCH DAMAGE.
 */

-/**
- * This file contains the trampoline code that will be executed by every
- * Application Processor when first started.
- */
-
 #include <gdt.h>
 #include <smp.h>
 #include <rtems/asm.h>
--- a/bsps/x86_64/amd64/start/bspstart.c
+++ b/bsps/x86_64/amd64/start/bspstart.c
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -9,8 +11,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/start/page.c
+++ b/bsps/x86_64/amd64/start/page.c
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -17,8 +19,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/amd64/start/start.S
+++ b/bsps/x86_64/amd64/start/start.S
@@ -1,6 +1,7 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /*
- * SPDX-License-Identifier: BSD-2-Clause
- *
+ * Copyright (C) 2024 Matheus Pecoraro
 * Copyright (C) 2023 Karel Gardas
 * Copyright (C) 2018 embedded brains GmbH & Co. KG
 *
--- a/bsps/x86_64/include/bsp/irq.h
+++ b/bsps/x86_64/include/bsp/irq.h
@@ -1,11 +1,12 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /*
 * This file contains the mandatory defines to support the irq.h and
 * irq-generic.c interfaces (initialized finally with bsp_interrupt_initialize).
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/bsps/x86_64/include/libcpu/page.h
+++ b/bsps/x86_64/include/libcpu/page.h
@@ -1,6 +1,7 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/cpukit/score/cpu/x86_64/cpu.c
+++ b/cpukit/score/cpu/x86_64/cpu.c
@@ -5,8 +5,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Copyright (c) 1989-1999.
 * On-Line Applications Research Corporation (OAR).
--- a/cpukit/score/cpu/x86_64/include/rtems/asm.h
+++ b/cpukit/score/cpu/x86_64/include/rtems/asm.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -21,8 +23,7 @@
 *  notice.  This file is freely distributable as long as the source
 *  of the file is noted.  This file is:
 *
- *  COPYRIGHT (c) 2018.
- *  Amaan Cheval <amaan.cheval@gmail.com>
+ *  COPYRIGHT (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 *  COPYRIGHT (c) 1994-2006.
 *  On-Line Applications Research Corporation (OAR).
--- a/cpukit/score/cpu/x86_64/include/rtems/score/cpu.h
+++ b/cpukit/score/cpu/x86_64/include/rtems/score/cpu.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
 * @file
 *
@@ -8,8 +10,7 @@

 /*
 * Copyright (C) 2024 Matheus Pecoraro
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/cpukit/score/cpu/x86_64/include/rtems/score/cpu_asm.h
+++ b/cpukit/score/cpu/x86_64/include/rtems/score/cpu_asm.h
@@ -1,6 +1,7 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/cpukit/score/cpu/x86_64/include/rtems/score/cpuimpl.h
+++ b/cpukit/score/cpu/x86_64/include/rtems/score/cpuimpl.h
@@ -5,8 +5,7 @@
 */

 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Copyright (C) 2013, 2016 embedded brains GmbH & Co. KG
 *
--- a/cpukit/score/cpu/x86_64/include/rtems/score/idt.h
+++ b/cpukit/score/cpu/x86_64/include/rtems/score/idt.h
@@ -1,6 +1,7 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/cpukit/score/cpu/x86_64/include/rtems/score/x86_64.h
+++ b/cpukit/score/cpu/x86_64/include/rtems/score/x86_64.h
@@ -1,6 +1,5 @@
 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/cpukit/score/cpu/x86_64/x86_64-context-initialize.c
+++ b/cpukit/score/cpu/x86_64/x86_64-context-initialize.c
@@ -1,6 +1,5 @@
 /*
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
--- a/cpukit/score/cpu/x86_64/x86_64-context-switch.S
+++ b/cpukit/score/cpu/x86_64/x86_64-context-switch.S
@@ -1,7 +1,8 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /*
 * Copyright (C) 2024 Matheus Pecoraro
- * Copyright (c) 2018.
- * Amaan Cheval <amaan.cheval@gmail.com>
+ * Copyright (c) 2018 Amaan Cheval <amaan.cheval@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions