From 067a96ad0c3b0818d71d9aaadaee4b520d940de1 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Fri, 18 Apr 2008 15:02:20 +0000 Subject: 2008-04-18 Joel Sherrill * rtems/include/rtems.h, rtems/include/rtems/rtems/asr.h, rtems/include/rtems/rtems/attr.h, rtems/include/rtems/rtems/barrier.h, rtems/include/rtems/rtems/barriermp.h, rtems/include/rtems/rtems/cache.h, rtems/include/rtems/rtems/clock.h, rtems/include/rtems/rtems/config.h, rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h, rtems/include/rtems/rtems/eventmp.h, rtems/include/rtems/rtems/eventset.h, rtems/include/rtems/rtems/intr.h, rtems/include/rtems/rtems/message.h, rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h, rtems/include/rtems/rtems/msgmp.h, rtems/include/rtems/rtems/object.h, rtems/include/rtems/rtems/options.h, rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h, rtems/include/rtems/rtems/ratemon.h, rtems/include/rtems/rtems/region.h, rtems/include/rtems/rtems/regionmp.h, rtems/include/rtems/rtems/rtemsapi.h, rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h, rtems/include/rtems/rtems/signal.h, rtems/include/rtems/rtems/signalmp.h, rtems/include/rtems/rtems/status.h, rtems/include/rtems/rtems/support.h, rtems/include/rtems/rtems/taskmp.h, rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h, rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl, rtems/inline/rtems/rtems/attr.inl, rtems/inline/rtems/rtems/barrier.inl, rtems/inline/rtems/rtems/dpmem.inl, rtems/inline/rtems/rtems/event.inl, rtems/inline/rtems/rtems/eventset.inl, rtems/inline/rtems/rtems/message.inl, rtems/inline/rtems/rtems/modes.inl, rtems/inline/rtems/rtems/options.inl, rtems/inline/rtems/rtems/part.inl, rtems/inline/rtems/rtems/ratemon.inl, rtems/inline/rtems/rtems/region.inl, rtems/inline/rtems/rtems/sem.inl, rtems/inline/rtems/rtems/status.inl, rtems/inline/rtems/rtems/support.inl, rtems/inline/rtems/rtems/tasks.inl, rtems/inline/rtems/rtems/timer.inl: Initial conversion of Classic API header files to Doxygen. * rtems/Doxyfile: New file. --- cpukit/rtems/include/rtems/rtems/part.h | 76 ++++++++++++++------------------- 1 file changed, 32 insertions(+), 44 deletions(-) (limited to 'cpukit/rtems/include/rtems/rtems/part.h') diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index 0e2eb496c4..fda28714c7 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -1,8 +1,6 @@ /** * @file rtems/rtems/part.h - */ - -/* + * * This include file contains all the constants and structures associated * with the Partition Manager. This manager provides facilities to * dynamically allocate memory in fixed-sized units which are returned @@ -10,13 +8,14 @@ * * Directives provided are: * - * + create a partition - * + get an ID of a partition - * + delete a partition - * + get a buffer from a partition - * + return a buffer to a partition - * - * COPYRIGHT (c) 1989-2007. + * - create a partition + * - get an ID of a partition + * - delete a partition + * - get a buffer from a partition + * - return a buffer to a partition + */ + +/* COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -44,10 +43,16 @@ extern "C" { #include #include -/* - * The following defines the control block used to manage each partition. +/** + * @defgroup ClassicPart Classic API Partition + * + * This encapsulates functionality which XXX */ +/**@{*/ +/** + * The following defines the control block used to manage each partition. + */ typedef struct { Objects_Control Object; void *starting_address; /* physical address */ @@ -58,29 +63,23 @@ typedef struct { Chain_Control Memory; /* buffer chain */ } Partition_Control; -/* +/** * The following defines the information control block used to * manage this class of objects. */ - RTEMS_PART_EXTERN Objects_Information _Partition_Information; -/* - * _Partition_Manager_initialization - * - * DESCRIPTION: +/** + * @brief Partition_Manager_initialization * * This routine performs the initialization necessary for this manager. */ - void _Partition_Manager_initialization( uint32_t maximum_partitions ); -/* - * rtems_partition_create - * - * DESCRIPTION: +/** + * @brief rtems_partition_create * * This routine implements the rtems_partition_create directive. The * partition will have the name name. The memory area managed by @@ -90,7 +89,6 @@ void _Partition_Manager_initialization( * the partition is global or local. It returns the id of the * created partition in ID. */ - rtems_status_code rtems_partition_create( rtems_name name, void *starting_address, @@ -100,10 +98,8 @@ rtems_status_code rtems_partition_create( Objects_Id *id ); -/* - * rtems_partition_ident - * - * DESCRIPTION: +/** + * @brief rtems_partition_ident * * This routine implements the rtems_partition_ident directive. * This directive returns the partition ID associated with name. @@ -113,51 +109,41 @@ rtems_status_code rtems_partition_create( * The search can be limited to a particular node or allowed to * encompass all nodes. */ - rtems_status_code rtems_partition_ident( rtems_name name, uint32_t node, Objects_Id *id ); -/* - * rtems_partition_delete - * - * DESCRIPTION: +/** + * @brief rtems_partition_delete * * This routine implements the rtems_partition_delete directive. The * partition indicated by ID is deleted. */ - rtems_status_code rtems_partition_delete( Objects_Id id ); -/* - * rtems_partition_get_buffer - * - * DESCRIPTION: +/** + * @brief rtems_partition_get_buffer * * This routine implements the rtems_partition_get_buffer directive. It * attempts to allocate a buffer from the partition associated with ID. * If a buffer is allocated, its address is returned in buffer. */ - rtems_status_code rtems_partition_get_buffer( Objects_Id id, void **buffer ); -/* - * rtems_partition_return_buffer - * - * DESCRIPTION: +/** + * @brief rtems_partition_return_buffer * * This routine implements the rtems_partition_return_buffer directive. It * frees the buffer to the partition associated with ID. The buffer must * have been previously allocated from the same partition. */ - rtems_status_code rtems_partition_return_buffer( Objects_Id id, void *buffer @@ -174,5 +160,7 @@ rtems_status_code rtems_partition_return_buffer( } #endif +/**@}*/ + #endif /* end of include file */ -- cgit v1.2.3