From 018e7ad4077fe37ed7d471163a80b3d361b13583 Mon Sep 17 00:00:00 2001 From: Matheus Pecoraro Date: Wed, 7 Aug 2024 15:25:00 -0300 Subject: [PATCH] x86_64: x86_64 port doxygen and license cleanup --- bsps/x86_64/amd64/clock/clock.c | 5 +++-- bsps/x86_64/amd64/console/console.c | 5 +++-- bsps/x86_64/amd64/include/apic.h | 5 +++-- bsps/x86_64/amd64/include/bsp.h | 10 +++------- bsps/x86_64/amd64/include/clock.h | 5 +++-- bsps/x86_64/amd64/include/pic.h | 5 +++-- bsps/x86_64/amd64/include/start.h | 5 +++-- bsps/x86_64/amd64/interrupts/idt.c | 5 +++-- bsps/x86_64/amd64/interrupts/isr_handler.S | 13 +++++++++---- bsps/x86_64/amd64/interrupts/pic.c | 5 +++-- bsps/x86_64/amd64/start/ap_trampoline.S | 18 +++++++++++------- bsps/x86_64/amd64/start/bspstart.c | 5 +++-- bsps/x86_64/amd64/start/page.c | 5 +++-- bsps/x86_64/amd64/start/start.S | 5 +++-- bsps/x86_64/include/bsp/irq.h | 5 +++-- bsps/x86_64/include/libcpu/page.h | 5 +++-- cpukit/score/cpu/x86_64/cpu.c | 3 +-- cpukit/score/cpu/x86_64/include/rtems/asm.h | 5 +++-- .../score/cpu/x86_64/include/rtems/score/cpu.h | 5 +++-- .../cpu/x86_64/include/rtems/score/cpu_asm.h | 5 +++-- .../cpu/x86_64/include/rtems/score/cpuimpl.h | 3 +-- .../score/cpu/x86_64/include/rtems/score/idt.h | 5 +++-- .../cpu/x86_64/include/rtems/score/x86_64.h | 3 +-- .../cpu/x86_64/x86_64-context-initialize.c | 3 +-- .../score/cpu/x86_64/x86_64-context-switch.S | 5 +++-- 25 files changed, 81 insertions(+), 62 deletions(-) diff --git a/bsps/x86_64/amd64/clock/clock.c b/bsps/x86_64/amd64/clock/clock.c index 543ad760d2..6b2ff9b382 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/console/console.c b/bsps/x86_64/amd64/console/console.c index e6f22f5300..c68747bd10 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/include/apic.h b/bsps/x86_64/amd64/include/apic.h index 3289adcd08..98dd3d49df 100644 --- 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 * Copyright (C) 2024 Matheus Pecoraro + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/include/bsp.h b/bsps/x86_64/amd64/include/bsp.h index 5c0d526b49..a232f50330 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Copyright (c) 1989-1999. * On-Line Applications Research Corporation (OAR). diff --git a/bsps/x86_64/amd64/include/clock.h b/bsps/x86_64/amd64/include/clock.h index 963a6d13c6..23cc686a73 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/include/pic.h b/bsps/x86_64/amd64/include/pic.h index f16a9a6138..bb94d80baa 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/include/start.h b/bsps/x86_64/amd64/include/start.h index aa5626a288..294458cf05 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/interrupts/idt.c b/bsps/x86_64/amd64/interrupts/idt.c index d037045384..8104c4288a 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/interrupts/isr_handler.S b/bsps/x86_64/amd64/interrupts/isr_handler.S index 36cf80a590..02c95ca1c9 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/interrupts/pic.c b/bsps/x86_64/amd64/interrupts/pic.c index 549c75f13d..1c8f3bcf8b 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/start/ap_trampoline.S b/bsps/x86_64/amd64/start/ap_trampoline.S index 5ae89d43dc..e1268d5f86 100644 --- 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 #include #include diff --git a/bsps/x86_64/amd64/start/bspstart.c b/bsps/x86_64/amd64/start/bspstart.c index 00a4e6d758..3f31451148 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/start/page.c b/bsps/x86_64/amd64/start/page.c index 35009f4bc1..d6c02117e1 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/amd64/start/start.S b/bsps/x86_64/amd64/start/start.S index 58f9181870..b876b7be7e 100644 --- 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 * diff --git a/bsps/x86_64/include/bsp/irq.h b/bsps/x86_64/include/bsp/irq.h index ba765678d0..291d0f7d25 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/bsps/x86_64/include/libcpu/page.h b/bsps/x86_64/include/libcpu/page.h index 8cbae9a21e..c7fe637225 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/cpukit/score/cpu/x86_64/cpu.c b/cpukit/score/cpu/x86_64/cpu.c index 7527e797bb..7d82c3783a 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Copyright (c) 1989-1999. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/cpu/x86_64/include/rtems/asm.h b/cpukit/score/cpu/x86_64/include/rtems/asm.h index 0381388271..26470e9d44 100644 --- 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 + * COPYRIGHT (c) 2018 Amaan Cheval * * COPYRIGHT (c) 1994-2006. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/score/cpu/x86_64/include/rtems/score/cpu.h b/cpukit/score/cpu/x86_64/include/rtems/score/cpu.h index e9ce707090..5db67dcb18 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/cpukit/score/cpu/x86_64/include/rtems/score/cpu_asm.h b/cpukit/score/cpu/x86_64/include/rtems/score/cpu_asm.h index bb23ef8faa..156385b669 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/cpukit/score/cpu/x86_64/include/rtems/score/cpuimpl.h b/cpukit/score/cpu/x86_64/include/rtems/score/cpuimpl.h index 35fc56183f..4529a323da 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Copyright (C) 2013, 2016 embedded brains GmbH & Co. KG * diff --git a/cpukit/score/cpu/x86_64/include/rtems/score/idt.h b/cpukit/score/cpu/x86_64/include/rtems/score/idt.h index 4e88c3fd3f..a2e89919ea 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/cpukit/score/cpu/x86_64/include/rtems/score/x86_64.h b/cpukit/score/cpu/x86_64/include/rtems/score/x86_64.h index f4710c4b8f..9070d9c3e8 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/cpukit/score/cpu/x86_64/x86_64-context-initialize.c b/cpukit/score/cpu/x86_64/x86_64-context-initialize.c index 0df7cff1bc..b6bb37cd78 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions diff --git a/cpukit/score/cpu/x86_64/x86_64-context-switch.S b/cpukit/score/cpu/x86_64/x86_64-context-switch.S index 7a3b7d325a..6f2c66193a 100644 --- 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 + * Copyright (c) 2018 Amaan Cheval * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions