[PATCH rtems-examples v2] Add regulator example
Joel Sherrill
joel at rtems.org
Fri Jul 14 23:49:42 UTC 2023
Updates #4924.
---
misc/Makefile | 6 +
misc/regulator/Makefile | 20 +++
misc/regulator/regulator_example.c | 187 +++++++++++++++++++++++++++++
misc/regulator/rtems_config.c | 59 +++++++++
misc/regulator/wscript | 15 +++
misc/wscript | 1 +
6 files changed, 288 insertions(+)
create mode 100644 misc/regulator/Makefile
create mode 100644 misc/regulator/regulator_example.c
create mode 100644 misc/regulator/rtems_config.c
create mode 100644 misc/regulator/wscript
diff --git a/misc/Makefile b/misc/Makefile
index ed31598..a75ea58 100644
--- a/misc/Makefile
+++ b/misc/Makefile
@@ -8,3 +8,9 @@ SUBDIRS=minimum bspcmdline extract_example nanosecond_tick_wrap userdrv
ifeq ($(RTEMS_HAS_POSIX_API),yes)
# SUBDIRS += adamain
endif
+
+# If regulator.h is not present, do not build that example
+ifneq (,$(RTEMS_MAKEFILE_PATH).lib/include/rtems/regulator.h)
+ SUBDIRS += regulator
+endif
+
diff --git a/misc/regulator/Makefile b/misc/regulator/Makefile
new file mode 100644
index 0000000..7446839
--- /dev/null
+++ b/misc/regulator/Makefile
@@ -0,0 +1,20 @@
+#
+# RTEMS_MAKEFILE_PATH is typically set in an environment variable
+#
+
+PGM=${ARCH}/regulator_example.exe
+
+# C source names
+CSRCS = rtems_config.c regulator_example.c
+COBJS = $(CSRCS:%.c=${ARCH}/%.o)
+
+include $(RTEMS_MAKEFILE_PATH)/Makefile.inc
+include $(RTEMS_CUSTOM)
+include $(PROJECT_ROOT)/make/leaf.cfg
+
+OBJS= $(COBJS) $(CXXOBJS) $(ASOBJS)
+
+all: ${ARCH} $(PGM)
+
+$(PGM): $(OBJS)
+ $(make-exe)
diff --git a/misc/regulator/regulator_example.c b/misc/regulator/regulator_example.c
new file mode 100644
index 0000000..4bffb1d
--- /dev/null
+++ b/misc/regulator/regulator_example.c
@@ -0,0 +1,187 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @defgroup RegulatorExamples Regulator Use Examples
+ *
+ * @brief User Examples for the Regulator
+ *
+ * This is a set of user examples for the regulator.
+ */
+
+/**
+ * @ingroup RegulatorExamples
+ *
+ * @file
+ *
+ * @brief Example 1 for Regulator Library
+ */
+
+/*
+ * Copyright (C) 2022 On-Line Applications Research Corporation (OAR)
+ *
+ * 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.
+ *
+ * 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.
+ */
+
+#include <assert.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+
+#include <rtems.h>
+#include <rtems/inttypes.h>
+
+#include <rtems/regulator.h>
+
+/**
+ * @brief Count of Delivered Messages
+ */
+static int delivered = 1;
+
+/**
+ * @ingroup RegulatorExamples
+ * @brief Deliver Method Which Prints
+ *
+ * This deliverer method implementation prints the message with the
+ * receipt time. The following behavioral warnings should be noted
+ * as this is not necessarily representative of whata real application
+ * may do:
+ *
+ * - The printing may skew the delivery time.
+ * - The message must be in ASCII and NUL terminated.
+ */
+static bool example_deliverer(
+ void *context,
+ void *message,
+ size_t length
+)
+{
+ (void) context;
+ (void) length;
+
+ int rc;
+ struct timespec current;
+
+ rc = clock_gettime(CLOCK_REALTIME, ¤t);
+ assert(rc == 0);
+
+ fprintf(
+ stderr,
+ "%" PRIdtime_t ":%9ld %s\n",
+ current.tv_sec,
+ current.tv_nsec,
+ (char *)message
+ );
+ delivered += 1;
+
+ /*
+ * When we printed the message, we completed processing it. Because of this,
+ * the message buffer can now be released. We have the option of explicitly
+ * doing it here and returning false or telling the Delivery Thread to release
+ * the buffer by returning true.
+ */
+ return true;
+}
+
+
+/**
+ * @ingroup RegulatorTests
+ * @brief Verify rtems_regulator_send and output thread delivers message
+ *
+ * This example shows that when the regulator is successfully initialized
+ * and used as expected, a message sent via rtems_regulator_send() is delivered as
+ * expected.
+ */
+static void example_send_messages(void)
+{
+ #define MAXIMUM_MESSAGE_LENGTH 32
+
+ rtems_status_code sc;
+ rtems_regulator_instance *regulator;
+ char message[MAXIMUM_MESSAGE_LENGTH];
+ void *buffer;
+ size_t length;
+ int msg;
+ int i;
+ int burst;
+
+ rtems_regulator_attributes attributes = {
+ .deliverer = example_deliverer,
+ .deliverer_context = NULL,
+ .maximum_message_size = MAXIMUM_MESSAGE_LENGTH,
+ .maximum_messages = 10,
+ .output_thread_priority = 16,
+ .output_thread_stack_size = 0,
+ .output_thread_period = RTEMS_MILLISECONDS_TO_TICKS(1000),
+ .maximum_to_dequeue_per_period = 3
+ };
+
+ sc = rtems_regulator_create(&attributes, ®ulator);
+ assert(sc == RTEMS_SUCCESSFUL);
+ assert(regulator != NULL);
+
+ /**
+ * Send messages as a burst which will need to be smoothly sent at
+ * the configured rate.
+ */
+ msg = 0;
+ for (burst=0 ; burst < 2 ; burst++ ) {
+ fprintf(stderr, "Send Burst %d of 7 messages with 3 delivered per second\n", burst);
+ for (i=1; i <= 7 ; i++, msg++) {
+ sc = rtems_regulator_obtain_buffer(regulator, &buffer);
+ assert(sc == RTEMS_SUCCESSFUL);
+ assert(buffer != NULL);
+
+ length = snprintf(message, MAXIMUM_MESSAGE_LENGTH, "message %d", msg);
+ strcpy(buffer, message);
+
+ sc = rtems_regulator_send(regulator, buffer, length);
+ assert(sc == RTEMS_SUCCESSFUL);
+ }
+ sleep(5);
+ if (delivered == 14) {
+ fprintf(stderr, "*** END OF REGULATOR EXAMPLE 01 ***");
+ exit(0);
+ }
+ }
+
+ /* Will not exit above loop */
+ #undef MAXIMUM_MESSAGE_LENGTH
+}
+
+/* Necessary prototype */
+rtems_task test_regulator(rtems_task_argument);
+
+/**
+ * @ingroup RegulatorExamples
+ * @brief Entry task which invokes the example helper
+ */
+rtems_task test_regulator(rtems_task_argument arg)
+{
+ (void) arg;
+
+ puts("*** START OF REGULATOR EXAMPLE 01 ***");
+
+ example_send_messages();
+
+ puts("*** END OF EXAMPLE REGULATOR 01 ***");
+ exit(0);
+}
diff --git a/misc/regulator/rtems_config.c b/misc/regulator/rtems_config.c
new file mode 100644
index 0000000..ca96e1b
--- /dev/null
+++ b/misc/regulator/rtems_config.c
@@ -0,0 +1,59 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
+/**
+ * @file
+ *
+ * @brief RTEMS Configuration for regulator tests
+ */
+
+/*
+ * COPYRIGHT (c) 2022. * On-Line Applications Research Corporation (OAR).
+ *
+ * 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.
+ *
+ * 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.
+ */
+
+
+#include <rtems.h>
+
+rtems_task test_regulator(rtems_task_argument);
+
+#include <bsp.h> /* for device driver prototypes */
+
+/* NOTICE: the clock driver is explicitly disabled */
+#define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
+#define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
+
+#define CONFIGURE_RTEMS_INIT_TASKS_TABLE
+#define CONFIGURE_INIT_TASK_ENTRY_POINT test_regulator
+#define CONFIGURE_INIT_TASK_ATTRIBUTES RTEMS_FLOATING_POINT
+
+/* Use hard limits to make it easier to trip object creation errors */
+#define CONFIGURE_MAXIMUM_TASKS 2
+#define CONFIGURE_MAXIMUM_MESSAGE_QUEUES 1
+#define CONFIGURE_MAXIMUM_PARTITIONS 1
+#define CONFIGURE_MAXIMUM_PERIODS 1
+
+#define CONFIGURE_UNIFIED_WORK_AREAS
+#define CONFIGURE_MINIMUM_TASK_STACK_SIZE (8 * 1024)
+
+#define CONFIGURE_INIT
+#include <rtems/confdefs.h>
diff --git a/misc/regulator/wscript b/misc/regulator/wscript
new file mode 100644
index 0000000..4a4f8de
--- /dev/null
+++ b/misc/regulator/wscript
@@ -0,0 +1,15 @@
+# Copyright 2023 Joel Sherrill (joel at rtems.org)
+#
+# This file's license is 2-clause BSD as in this distribution's LICENSE.2 file.
+#
+
+# Waf build script for an RTEMS Hello
+import rtems_waf.rtems as rtems
+
+def build(bld):
+ rtems.build(bld)
+ #if rtems.check_inc(bld, ['rtems/regulator.h']):
+ if bld.check(header_name='rtems/regulator.h', features='c', mandatory = False):
+ bld(features = 'c cprogram',
+ target = 'regulator_example.exe',
+ source = ['regulator_example.c','rtems_config.c'])
diff --git a/misc/wscript b/misc/wscript
index 8689080..4b8aa38 100644
--- a/misc/wscript
+++ b/misc/wscript
@@ -14,6 +14,7 @@ def build(bld):
bld.recurse('bspcmdline')
bld.recurse('nanosecond_tick_wrap')
bld.recurse('qemu_vfat')
+ bld.recurse('regulator')
bld.recurse('applib')
bld.recurse('userdrv')
#if rtems.check_posix(bld):
--
2.24.4
More information about the devel
mailing list