rtems/bsd/bsd.h: Documentation

This commit is contained in:
Sebastian Huber 2016-04-27 09:45:26 +02:00
parent 3c7fdb2e5a
commit 5784e6d9c7

View File

@ -7,7 +7,7 @@
*/
/*
* Copyright (c) 2009-2015 embedded brains GmbH. All rights reserved.
* Copyright (c) 2009, 2016 embedded brains GmbH. All rights reserved.
*
* embedded brains GmbH
* Dornierstr. 4
@ -143,6 +143,22 @@ uintptr_t rtems_bsd_get_allocator_domain_size(
void rtems_bsd_get_mac_address(const char *name, int unit,
uint8_t mac_addr[6]);
/**
* @defgroup BSDBusRoot Bus Root Functions
*
* @brief Functions to perform bus root operations.
*
* Suspend and resume can be used to go into or exit a power saving state.
* Detach may be used to shutdown the system and do a warm reset.
*
* All functions must be called from task context. They perform complex
* operations affecting all devices of the bus tree and work only if all
* drivers are written properly and no resources used by the drivers are
* blocked.
*
* @{
*/
/**
* @brief Attach the root bus.
*
@ -175,6 +191,8 @@ int rtems_bsd_bus_root_resume(void);
*/
int rtems_bsd_bus_root_detach(void);
/** @} */
#ifdef __cplusplus
}
#endif /* __cplusplus */