kern: Introduce high-level spinlock interface

Signed-off-by: Ian Moffett <ian@osmora.org>

1 files changed, 69 insertions, 0 deletions

diff --git a/sys/inc/kern/spinlock.h b/sys/inc/kern/spinlock.h
new file mode 100644
index 0000000..76a2c3f
--- /dev/null
+++ b/sys/inc/kern/spinlock.h
@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2025 Ian Marco Moffett and the Osmora Team.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of Hyra nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _KERN_SPINLOCK_H_
+#define _KERN_SPINLOCK_H_ 1
+
+#include <sys/types.h>
+#include <lib/stdbool.h>
+
+#define SPINLOCK_NAMELEN 32
+
+struct spinlock {
+    char name[SPINLOCK_NAMELEN];
+    volatile size_t lock;
+};
+
+/*
+ * Initialize a named spinlock
+ *
+ * @name: Spinlock name
+ * @lock: Lock to initialize
+ *
+ * Returns zero on success
+ */
+int spinlock_init(const char *name, struct spinlock *lock);
+
+/*
+ * Acquire a spinlock
+ *
+ * @lock: Lock to acquire
+ * @irqclr: Mask interrupts
+ */
+void spinlock_acquire(struct spinlock *lock, bool irqclr);
+
+/*
+ * Release a spinlock
+ *
+ * @lock: Lock to release
+ * @irqset: Unmask interrupts
+ */
+void spinlock_release(struct spinlock *lock, bool irqset);
+
+#endif  /* !_KERN_SPINLOCK_H_ */