aboutsummaryrefslogtreecommitdiff
path: root/include/apos/lock.h
diff options
context:
space:
mode:
authorKimplul <kimi.h.kuparinen@gmail.com>2022-05-22 23:35:02 +0300
committerKimplul <kimi.h.kuparinen@gmail.com>2022-05-22 23:35:02 +0300
commit72df0de8cb579fd96449d19eb57fc71335907a19 (patch)
tree6a0a24478fe95f009619787afd24ddfe5df8cfd7 /include/apos/lock.h
parentd99be9e2912e0726ab779053b43a89e3b9e21490 (diff)
downloadkmi-72df0de8cb579fd96449d19eb57fc71335907a19.tar.gz
kmi-72df0de8cb579fd96449d19eb57fc71335907a19.zip
add @file info to all files
+ Next step, start documenting contents of each file.
Diffstat (limited to 'include/apos/lock.h')
-rw-r--r--include/apos/lock.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/include/apos/lock.h b/include/apos/lock.h
index 178140b..2fac160 100644
--- a/include/apos/lock.h
+++ b/include/apos/lock.h
@@ -1,5 +1,11 @@
-#ifndef LOCK_H
-#define LOCK_H
+#ifndef APOS_LOCK_H
+#define APOS_LOCK_H
+
+/**
+ * @file lock.h
+ * Atomic locks, currently only \ref spin_lock and \ref spin_unlock. Mutex is
+ * probably overkill for this project.
+ */
#include <apos/atomic.h>
#include <apos/irq.h>
@@ -23,4 +29,4 @@ static inline void spin_unlock(spinlock_t *lck)
enable_irq();
}
-#endif /* LOCK_H */
+#endif /* APOS_LOCK_H */