Files
rtems/cpukit/libdebugger/rtems-debugger-smp.h
T
Sebastian Huber 7ef5e25be2 cpukit/libdebugger: Add the Doxygen file headers
Seventeen of the 18 debugger files had no Doxygen block.  Doxygen listed
only rtems-debugger-microblaze.c, so the debugger server had almost no
page of its own.

Give each file a block with @file, @ingroup and @brief.  The brief names
what the file implements.

These files carry no SPDX-License-Identifier line.  The block goes above
the copyright notice.  The licence statement stays as it is.

Updates #5717.

Assisted-by: Claude:claude-opus-5 claude-code
Signed-off-by: Sebastian Huber <sebastian.huber@embedded-brains.de>
2026-09-01 20:17:20 +00:00

61 lines
2.1 KiB
C

/**
* @file
*
* @ingroup RTEMSImplDebugger
*
* @brief This header file provides the SMP interfaces of the debugger
* server.
*/
/*
* Copyright (c) 2025 Chris Johns <chrisj@rtems.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Debugger for RTEMS.
*/
#ifndef _RTEMS_DEBUGGER_SMP_h
#define _RTEMS_DEBUGGER_SMP_h
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*
* The function used to run a provided function with arbitrary argument across
* all cores registered to the current scheduler. This is similar to the Linux
* kernel's on_each_cpu() call and always waits for the task to complete before
* returning.
*/
rtems_status_code rtems_debugger_cpu_run_all(rtems_task_entry task_entry,
rtems_task_argument arg);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif