summaryrefslogtreecommitdiffstats
path: root/cpukit/include
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-18 10:00:12 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2022-05-18 10:01:29 +0200
commitf49ef6b6cbb794f52b24eb6ec44e1783d5d007c5 (patch)
tree97991ba86aeb3494d631300c4f5c8873fa827d74 /cpukit/include
parentFix copyright notice of kernel space headers (diff)
downloadrtems-f49ef6b6cbb794f52b24eb6ec44e1783d5d007c5.tar.bz2
Add file descriptions to kernel space headers
Diffstat (limited to 'cpukit/include')
-rw-r--r--cpukit/include/machine/_kernel_cpuset.h5
-rw-r--r--cpukit/include/machine/_kernel_in.h7
-rw-r--r--cpukit/include/machine/_kernel_in6.h7
-rw-r--r--cpukit/include/machine/_kernel_mman.h6
-rw-r--r--cpukit/include/machine/_kernel_param.h3
-rw-r--r--cpukit/include/machine/_kernel_time.h7
-rw-r--r--cpukit/include/machine/_kernel_types.h7
-rw-r--r--cpukit/include/machine/_kernel_uio.h7
-rw-r--r--cpukit/include/machine/_timecounter.h7
9 files changed, 53 insertions, 3 deletions
diff --git a/cpukit/include/machine/_kernel_cpuset.h b/cpukit/include/machine/_kernel_cpuset.h
index f950394996..19c1a3e504 100644
--- a/cpukit/include/machine/_kernel_cpuset.h
+++ b/cpukit/include/machine/_kernel_cpuset.h
@@ -1,9 +1,10 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
- * @file
+ * @file
*
- * @brief
+ * @brief This header file provides CPU set definitions for the kernel space
+ * (_KERNEL is defined before including <sys/cpuset.h>).
*/
/*
diff --git a/cpukit/include/machine/_kernel_in.h b/cpukit/include/machine/_kernel_in.h
index 0dad7f534e..29a6112e96 100644
--- a/cpukit/include/machine/_kernel_in.h
+++ b/cpukit/include/machine/_kernel_in.h
@@ -32,6 +32,13 @@
* $FreeBSD: head/sys/netinet/in.h 326023 2017-11-20 19:43:44Z pfg $
*/
+/**
+ * @file
+ *
+ * @brief This header file provides IPv4 definitions for the kernel space
+ * (_KERNEL is defined before including <netinet/in.h>).
+ */
+
#if !defined(_NETINET_IN_H_) || !defined(_KERNEL)
#error "must be included via <netinet/in.h> in kernel space"
#endif
diff --git a/cpukit/include/machine/_kernel_in6.h b/cpukit/include/machine/_kernel_in6.h
index 78f4a02970..c2b603fb36 100644
--- a/cpukit/include/machine/_kernel_in6.h
+++ b/cpukit/include/machine/_kernel_in6.h
@@ -31,6 +31,13 @@
* $KAME: in6.h,v 1.89 2001/05/27 13:28:35 itojun Exp $
*/
+/**
+ * @file
+ *
+ * @brief This header file provides IPv6 definitions for the kernel space
+ * (_KERNEL is defined before including <netinet6/in6.h>).
+ */
+
#if !defined(_NETINET6_IN6_H_) || !defined(_KERNEL)
#error "must be included via <netinet6/in6.h> in kernel space"
#endif
diff --git a/cpukit/include/machine/_kernel_mman.h b/cpukit/include/machine/_kernel_mman.h
index 1aac3f438a..fa2677a122 100644
--- a/cpukit/include/machine/_kernel_mman.h
+++ b/cpukit/include/machine/_kernel_mman.h
@@ -1,7 +1,13 @@
/* SPDX-License-Identifier: BSD-2-Clause */
/**
+ * @file
*
+ * @brief This header file provides memory map definitions for the kernel space
+ * (_KERNEL is defined before including <sys/mman.h>).
+ */
+
+/*
* Copyright (C) 2016 embedded brains GmbH
*
* Redistribution and use in source and binary forms, with or without
diff --git a/cpukit/include/machine/_kernel_param.h b/cpukit/include/machine/_kernel_param.h
index a05dd50d49..5b381ccca5 100644
--- a/cpukit/include/machine/_kernel_param.h
+++ b/cpukit/include/machine/_kernel_param.h
@@ -3,7 +3,8 @@
/**
* @file
*
- * @brief
+ * @brief This header file provides parameter definitions for the kernel space
+ * (_KERNEL is defined before including <sys/param.h>).
*/
/*
diff --git a/cpukit/include/machine/_kernel_time.h b/cpukit/include/machine/_kernel_time.h
index 1776447b9a..cfd223f0b6 100644
--- a/cpukit/include/machine/_kernel_time.h
+++ b/cpukit/include/machine/_kernel_time.h
@@ -34,6 +34,13 @@
* $FreeBSD$
*/
+/**
+ * @file
+ *
+ * @brief This header file provides time definitions for the kernel space
+ * (_KERNEL is defined before including <sys/time.h>).
+ */
+
#if !defined(_SYS_TIME_H_) || !defined(_KERNEL)
#error "must be included via <sys/time.h> in kernel space"
#endif
diff --git a/cpukit/include/machine/_kernel_types.h b/cpukit/include/machine/_kernel_types.h
index d1889c75ef..98f0366b64 100644
--- a/cpukit/include/machine/_kernel_types.h
+++ b/cpukit/include/machine/_kernel_types.h
@@ -1,5 +1,12 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @brief This header file provides type definitions for the kernel space
+ * (_KERNEL is defined before including <sys/types.h>).
+ */
+
/*
* Copyright (C) 2016 embedded brains GmbH
*
diff --git a/cpukit/include/machine/_kernel_uio.h b/cpukit/include/machine/_kernel_uio.h
index c73fa6d299..7e45a28c16 100644
--- a/cpukit/include/machine/_kernel_uio.h
+++ b/cpukit/include/machine/_kernel_uio.h
@@ -32,6 +32,13 @@
* $FreeBSD: head/sys/sys/uio.h 331621 2018-03-27 15:20:03Z brooks $
*/
+/**
+ * @file
+ *
+ * @brief This header file provides device driver I/O definitions for the
+ * kernel space (_KERNEL is defined before including <sys/uio.h>).
+ */
+
#if !defined(_SYS_UIO_H_) || !defined(_KERNEL)
#error "must be included via <sys/uio.h> in kernel space"
#endif
diff --git a/cpukit/include/machine/_timecounter.h b/cpukit/include/machine/_timecounter.h
index 6a85e654cc..fc3d78c5ad 100644
--- a/cpukit/include/machine/_timecounter.h
+++ b/cpukit/include/machine/_timecounter.h
@@ -1,5 +1,12 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @brief This header file provides timecounter definitions for the kernel space
+ * (_KERNEL is defined before including <sys/time.h>) and RTEMS.
+ */
+
/*
* Copyright (C) 2016 embedded brains GmbH
*