@micro-os-plus/architecture-riscv 4.1.0

package/include/micro-os-plus/architecture-riscv/device-functions.h

@@ -0,0 +1,166 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (https://github.com/micro-os-plus/)
+ * Copyright (c) 2017 Liviu Ionescu.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT/.
+ */
+
+#ifndef MICRO_OS_PLUS_ARCHITECTURE_RISCV_DEVICE_FUNCTIONS_H_
+#define MICRO_OS_PLUS_ARCHITECTURE_RISCV_DEVICE_FUNCTIONS_H_
+
+// ----------------------------------------------------------------------------
+
+#include <micro-os-plus/architecture-riscv/types.h>
+
+// ----------------------------------------------------------------------------
+
+/*
+ * RISC-V device support functions.
+ *
+ * The declarations are part of the common design, but each device
+ * must define the actual address and include the file
+ * <micro-os-plus/architecture-riscv/device-functions-inlines.h>.
+ */
+
+// ----------------------------------------------------------------------------
+#if defined(__cplusplus)
+extern "C"
+{
+#endif // defined(__cplusplus)
+
+  // --------------------------------------------------------------------------
+  // `mtime` functions.
+
+#if __riscv_xlen == 64
+  static
+#endif // __riscv_xlen == 64
+      uint64_t
+      riscv_device_read_mtime (void);
+
+  static uint32_t
+  riscv_device_read_mtime_low (void);
+
+  static uint32_t
+  riscv_device_read_mtime_high (void);
+
+#if __riscv_xlen == 64
+  static
+#endif // __riscv_xlen == 64
+      void
+      riscv_device_write_mtime (uint64_t value);
+
+  static void
+  riscv_device_write_mtime_low (uint32_t value);
+
+  static void
+  riscv_device_write_mtime_high (uint32_t value);
+
+  // --------------------------------------------------------------------------
+  // `mtimecmp` functions.
+
+  static uint64_t
+  riscv_device_read_mtimecmp (void);
+
+  static uint32_t
+  riscv_device_read_mtimecmp_low (void);
+
+  static uint32_t
+  riscv_device_read_mtimecmp_high (void);
+
+#if __riscv_xlen == 64
+  static
+#endif // __riscv_xlen == 64
+      void
+      riscv_device_write_mtimecmp (uint64_t value);
+
+  static void
+  riscv_device_write_mtimecmp_low (uint32_t value);
+
+  static void
+  riscv_device_write_mtimecmp_high (uint32_t value);
+
+  // --------------------------------------------------------------------------
+
+#if defined(__cplusplus)
+}
+#endif // defined(__cplusplus)
+
+// ============================================================================
+
+#if defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+namespace riscv
+{
+  namespace device
+  {
+    // ----------------------------------------------------------------------------
+    // `mtime` functions.
+
+    /**
+     * Read the RTC current counter.
+     */
+    uint64_t
+    mtime (void);
+
+    uint32_t
+    mtime_low (void);
+
+    uint32_t
+    mtime_high (void);
+
+    void
+    mtime (uint64_t value);
+
+    void
+    mtime_low (uint32_t value);
+
+    void
+    mtime_high (uint32_t value);
+
+    // ------------------------------------------------------------------------
+    // `mtimecmp` functions.
+
+    /**
+     * Read the RTC comparator.
+     */
+    uint64_t
+    mtimecmp (void);
+
+    uint32_t
+    mtimecmp_low (void);
+
+    uint32_t
+    mtimecmp_high (void);
+
+    /**
+     * Write the RTC comparator.
+     */
+    void
+    mtimecmp (uint64_t value);
+
+    void
+    mtimecmp_low (uint32_t value);
+
+    void
+    mtimecmp_high (uint32_t value);
+
+    // ------------------------------------------------------------------------
+  } // namespace device
+} // namespace riscv
+
+// ----------------------------------------------------------------------------
+
+#endif // defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_OS_PLUS_ARCHITECTURE_RISCV_DEVICE_FUNCTIONS_H_
+
+// ----------------------------------------------------------------------------

package/include/micro-os-plus/architecture-riscv/instructions-inlines.h

@@ -0,0 +1,172 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (https://github.com/micro-os-plus/)
+ * Copyright (c) 2017 Liviu Ionescu.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT/.
+ */
+
+#ifndef MICRO_OS_PLUS_ARCHITECTURE_RISCV_ARCH_INSTRUCTIONS_INLINES_H_
+#define MICRO_OS_PLUS_ARCHITECTURE_RISCV_ARCH_INSTRUCTIONS_INLINES_H_
+
+// ----------------------------------------------------------------------------
+
+#include <stdint.h>
+
+// ----------------------------------------------------------------------------
+
+// Inline implementations for the RISC-V architecture instructions.
+
+#if defined(__cplusplus)
+extern "C"
+{
+#endif // defined(__cplusplus)
+
+  // --------------------------------------------------------------------------
+
+  static inline __attribute__ ((always_inline)) void
+  riscv_architecture_nop (void)
+  {
+    __asm__ volatile(
+
+        " nop "
+
+        : /* Outputs */
+        : /* Inputs */
+        : /* Clobbers */
+    );
+  }
+
+  static inline __attribute__ ((always_inline)) void
+  riscv_architecture_ebreak (void)
+  {
+    __asm__ volatile(
+
+        " ebreak "
+
+        : /* Outputs */
+        : /* Inputs */
+        : /* Clobbers */
+    );
+  }
+
+  static inline __attribute__ ((always_inline)) void
+  riscv_architecture_wfi (void)
+  {
+    __asm__ volatile(
+
+        " wfi "
+
+        : /* Outputs */
+        : /* Inputs */
+        : /* Clobbers */
+    );
+  }
+
+  static inline __attribute__ ((always_inline)) void
+  micro_os_plus_architecture_nop (void)
+  {
+    riscv_architecture_nop ();
+  }
+
+  /**
+   * `break` instruction.
+   */
+  static inline __attribute__ ((always_inline)) void
+  micro_os_plus_architecture_brk (void)
+  {
+    riscv_architecture_ebreak ();
+  }
+
+  /**
+   * `wfi` instruction.
+   */
+  static inline __attribute__ ((always_inline)) void
+  micro_os_plus_architecture_wfi (void)
+  {
+    riscv_architecture_wfi ();
+  }
+
+  // --------------------------------------------------------------------------
+
+#if defined(__cplusplus)
+}
+#endif // defined(__cplusplus)
+
+// ============================================================================
+
+#if defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+namespace riscv
+{
+  namespace architecture
+  {
+    // ------------------------------------------------------------------------
+
+    inline __attribute__ ((always_inline)) void
+    nop (void)
+    {
+      riscv_architecture_nop ();
+    }
+
+    inline __attribute__ ((always_inline)) void
+    ebreak (void)
+    {
+      riscv_architecture_ebreak ();
+    }
+
+    inline __attribute__ ((always_inline)) void
+    wfi (void)
+    {
+      riscv_architecture_wfi ();
+    }
+
+    // ------------------------------------------------------------------------
+  } // namespace architecture
+} // namespace riscv
+
+// ----------------------------------------------------------------------------
+// Inline functions.
+namespace micro_os_plus
+{
+  namespace architecture
+  {
+    // ------------------------------------------------------------------------
+
+    inline __attribute__ ((always_inline)) void
+    nop (void)
+    {
+      riscv::architecture::nop ();
+    }
+
+    inline __attribute__ ((always_inline)) void
+    brk (void)
+    {
+      riscv::architecture::ebreak ();
+    }
+
+    inline __attribute__ ((always_inline)) void
+    wfi (void)
+    {
+      riscv::architecture::wfi ();
+    }
+
+    // ------------------------------------------------------------------------
+  } // namespace architecture
+} // namespace micro_os_plus
+
+// ----------------------------------------------------------------------------
+
+#endif // defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_OS_PLUS_ARCHITECTURE_RISCV_ARCH_INSTRUCTIONS_INLINES_H_
+
+// ----------------------------------------------------------------------------

package/include/micro-os-plus/architecture-riscv/instructions.h

@@ -0,0 +1,153 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (https://github.com/micro-os-plus/)
+ * Copyright (c) 2017 Liviu Ionescu.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT/.
+ */
+
+#ifndef MICRO_OS_PLUS_ARCHITECTURE_RISCV_ARCH_INSTRUCTIONS_H_
+#define MICRO_OS_PLUS_ARCHITECTURE_RISCV_ARCH_INSTRUCTIONS_H_
+
+// ----------------------------------------------------------------------------
+
+#include <micro-os-plus/architecture-riscv/defines.h>
+
+#include <stdint.h>
+
+// ----------------------------------------------------------------------------
+
+// Declarations of RISC-V functions to wrap architecture instructions.
+
+#if defined(__cplusplus)
+extern "C"
+{
+#endif // defined(__cplusplus)
+
+  // --------------------------------------------------------------------------
+  // Architecture assembly instructions in C.
+
+  /**
+   * `nop` instruction.
+   */
+  static void
+  riscv_architecture_nop (void);
+
+  /**
+   * `ebreak` instruction.
+   */
+  static void
+  riscv_architecture_ebreak (void);
+
+  /**
+   * `wfi` instruction.
+   */
+  static void
+  riscv_architecture_wfi (void);
+
+  // --------------------------------------------------------------------------
+  // Portable architecture assembly instructions in C.
+
+  /**
+   * `nop` instruction.
+   */
+  static void
+  micro_os_plus_architecture_nop (void);
+
+  /**
+   * `break` instruction.
+   */
+  static void
+  micro_os_plus_architecture_brk (void);
+
+  /**
+   * `wfi` instruction.
+   */
+  static void
+  micro_os_plus_architecture_wfi (void);
+
+  // --------------------------------------------------------------------------
+
+#if defined(__cplusplus)
+}
+#endif // defined(__cplusplus)
+
+// ============================================================================
+
+#if defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+namespace riscv
+{
+  namespace architecture
+  {
+    // ------------------------------------------------------------------------
+    // Architecture assembly instructions in C++.
+
+    /**
+     * The assembler `nop` instruction.
+     */
+    void
+    nop (void);
+
+    /**
+     * The assembler `ebreak` instruction.
+     */
+    void
+    ebreak (void);
+
+    /**
+     * The assembler `wfi` instruction.
+     */
+    void
+    wfi (void);
+
+    // ------------------------------------------------------------------------
+  } // namespace architecture
+} // namespace riscv
+
+// ----------------------------------------------------------------------------
+// Inline functions.
+namespace micro_os_plus
+{
+  namespace architecture
+  {
+    // ------------------------------------------------------------------------
+    // Portable architecture assembly instructions in C++.
+
+    /**
+     * The assembler `nop` instruction.
+     */
+    void
+    nop (void);
+
+    /**
+     * The assembler `break` instruction.
+     */
+    void
+    brk (void);
+
+    /**
+     * The assembler `wfi` instruction.
+     */
+    void
+    wfi (void);
+
+    // ------------------------------------------------------------------------
+  } // namespace architecture
+} // namespace micro_os_plus
+
+// ----------------------------------------------------------------------------
+
+#endif // defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_OS_PLUS_ARCHITECTURE_RISCV_ARCH_INSTRUCTIONS_H_
+
+// ----------------------------------------------------------------------------

package/include/micro-os-plus/architecture-riscv/platform-functions-inlines.h

@@ -0,0 +1,81 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (https://github.com/micro-os-plus/)
+ * Copyright (c) 2017 Liviu Ionescu.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT/.
+ */
+
+#ifndef MICRO_OS_PLUS_ARCHITECTURE_RISCV_PLATFORM_FUNCTIONS_INLINES_H_
+#define MICRO_OS_PLUS_ARCHITECTURE_RISCV_PLATFORM_FUNCTIONS_INLINES_H_
+
+// ----------------------------------------------------------------------------
+
+#include <stdint.h>
+
+// ----------------------------------------------------------------------------
+
+/*
+ * Board support functions.
+ *
+ * Inline functions are first defined in C (prefixed with `riscv_board_`),
+ * then, for convenience, are redefined in C++ in the `riscv::board::`
+ * namespace.
+ *
+ * Regular functions are first defined in C++ then aliased to C.
+ */
+
+// ----------------------------------------------------------------------------
+#if defined(__cplusplus)
+extern "C"
+{
+#endif // defined(__cplusplus)
+
+  static inline __attribute__ ((always_inline)) uint32_t
+  riscv_board_get_rtc_frequency_hz (void)
+  {
+    return RISCV_PLATFORM_RTC_FREQUENCY_HZ;
+  }
+
+#if defined(__cplusplus)
+}
+#endif // defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+#if defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+namespace riscv
+{
+  namespace board
+  {
+    // ------------------------------------------------------------------------
+
+    /**
+     * Get the board RTC frequency.
+     */
+    inline __attribute__ ((always_inline)) uint32_t
+    rtc_frequency_hz (void)
+    {
+      return riscv_board_get_rtc_frequency_hz ();
+    }
+
+    // ------------------------------------------------------------------------
+  } // namespace board
+} // namespace riscv
+
+// ----------------------------------------------------------------------------
+
+#endif // defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_OS_PLUS_ARCHITECTURE_RISCV_PLATFORM_FUNCTIONS_INLINES_H_
+
+// ----------------------------------------------------------------------------

package/include/micro-os-plus/architecture-riscv/platform-functions.h

@@ -0,0 +1,75 @@
+/*
+ * This file is part of the µOS++ distribution.
+ *   (https://github.com/micro-os-plus/)
+ * Copyright (c) 2017 Liviu Ionescu.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT/.
+ */
+
+#ifndef MICRO_OS_PLUS_ARCHITECTURE_RISCV_PLATFORM_FUNCTIONS_H_
+#define MICRO_OS_PLUS_ARCHITECTURE_RISCV_PLATFORM_FUNCTIONS_H_
+
+// ----------------------------------------------------------------------------
+
+#include <stdint.h>
+
+// ----------------------------------------------------------------------------
+
+// RISC-V core support functions.
+
+#if defined(__cplusplus)
+extern "C"
+{
+#endif // defined(__cplusplus)
+
+  // --------------------------------------------------------------------------
+
+  // The declarations are part of the common design, but each board
+  // must implement them in the <xxx/platform-functions.h> file.
+
+  // Redundant, see the inline definitions.
+
+  // static uint32_t
+  // riscv_board_get_rtc_frequency_hz (void);
+
+  // --------------------------------------------------------------------------
+
+#if defined(__cplusplus)
+}
+#endif // defined(__cplusplus)
+
+// ============================================================================
+
+#if defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+namespace riscv
+{
+  namespace board
+  {
+    // The declarations are part of the common design, but each board
+    // must implement them in the <xxx/platform-functions.h> file.
+
+    // Redundant, see the inline definitions.
+
+    // uint32_t
+    // rtc_frequency_hz (void);
+
+    // ------------------------------------------------------------------------
+  } // namespace board
+} // namespace riscv
+
+// ----------------------------------------------------------------------------
+
+#endif // defined(__cplusplus)
+
+// ----------------------------------------------------------------------------
+
+#endif // MICRO_OS_PLUS_ARCHITECTURE_RISCV_PLATFORM_FUNCTIONS_H_
+
+// ----------------------------------------------------------------------------