diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2016-04-27 09:45:26 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2016-04-27 09:45:26 +0200 |
| commit | 5784e6d9c720eb619006e472c2ed82148ffb820a (patch) | |
| tree | e7bf71d7e8fa0e9f328b3bb18bb3411667284672 | |
| parent | libbsd: Remove sys/select.h and sys/_sigset.h. (diff) | |
| download | rtems-libbsd-5784e6d9c720eb619006e472c2ed82148ffb820a.tar.bz2 | |
rtems/bsd/bsd.h: Documentation
| -rw-r--r-- | rtemsbsd/include/rtems/bsd/bsd.h | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/rtemsbsd/include/rtems/bsd/bsd.h b/rtemsbsd/include/rtems/bsd/bsd.h index ecffcb48..e955b9f3 100644 --- a/rtemsbsd/include/rtems/bsd/bsd.h +++ b/rtemsbsd/include/rtems/bsd/bsd.h @@ -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 @@ -144,6 +144,22 @@ 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. * * @retval 0 Successful operation. @@ -175,6 +191,8 @@ int rtems_bsd_bus_root_resume(void); */ int rtems_bsd_bus_root_detach(void); +/** @} */ + #ifdef __cplusplus } #endif /* __cplusplus */ |