mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-08-22 18:08:32 +08:00
Add the Regulator Interface and test
Updates #4924. The Regulator is an application support class which is used to deal with the scenario where there is a bursty input source which needs to be metered out to a destination sink. The maximum size of bursts needs to be known and the delivery method must be configured to deliver messages at a rate that allows the traffic to not overflow.
This commit is contained in:
Joel Sherrill
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,135 @@
|
||||
/* SPDX-License-Identifier: BSD-2-Clause */
|
||||
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @ingroup RegulatorInternalAPI
|
||||
*
|
||||
* @brief Regulator Library Implementation Support
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2023 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup RegulatorInternalAPI Regulator API Internals
|
||||
*
|
||||
* @brief Regulator Internal Information
|
||||
*
|
||||
* This concerns implementation information about the Regulator.
|
||||
*/
|
||||
|
||||
#ifndef RTEMS_REGULATORIMPL_H
|
||||
#define RTEMS_REGULATORIMPL_H
|
||||
|
||||
#include <stdatomic.h>
|
||||
|
||||
#include <rtems/chain.h>
|
||||
|
||||
|
||||
/**
|
||||
* @ingroup RegulatorInternalAPI
|
||||
*
|
||||
* This constant is used to indicate the regulator instance is initialized.
|
||||
*/
|
||||
#define REGULATOR_INITIALIZED 0xDeadF00d
|
||||
|
||||
/**
|
||||
* @ingroup RegulatorInternalAPI
|
||||
*
|
||||
* @brief Regulator Message Instance Management Structure
|
||||
*/
|
||||
typedef struct {
|
||||
/** This points to the message contents. */
|
||||
void *buffer;
|
||||
/** This is the length of the message. */
|
||||
size_t length;
|
||||
} _Regulator_Message_t;
|
||||
|
||||
/**
|
||||
* @ingroup RegulatorInternalAPI
|
||||
*
|
||||
* @brief Regulator Statistics Private Structure
|
||||
*
|
||||
* An instance of this structure is allocated per regulator instance.
|
||||
*/
|
||||
typedef struct {
|
||||
/** Number of successfully obtained buffers. */
|
||||
atomic_size_t obtained;
|
||||
|
||||
/** Number of successfully released buffers. */
|
||||
atomic_size_t released;
|
||||
|
||||
/** Number of successfully delivered buffers. */
|
||||
atomic_size_t delivered;
|
||||
} _Regulator_Statistics;
|
||||
|
||||
/**
|
||||
* @ingroup RegulatorInternalAPI
|
||||
*
|
||||
* @brief Regulator Instance Private Structure
|
||||
*
|
||||
* An instance of this structure is allocated per regulator instance.
|
||||
*/
|
||||
typedef struct {
|
||||
/** Has magic value when instance is usable */
|
||||
uint32_t initialized;
|
||||
|
||||
/** Attributes for this instance -- copied from user */
|
||||
rtems_regulator_attributes Attributes;
|
||||
|
||||
/** Pointer to allocated message memory */
|
||||
void *message_memory;
|
||||
|
||||
/** Pointer to allocated memory for RTEMS Message Queue for pending buffers*/
|
||||
void *message_queue_storage;
|
||||
|
||||
/** RTEMS Message Queue of pending outgoing messages */
|
||||
rtems_id queue_id;
|
||||
|
||||
/** RTEMS Partition for pool of unused messages */
|
||||
rtems_id messages_partition_id;
|
||||
|
||||
/** RTEMS Task for performing output */
|
||||
rtems_id delivery_thread_id;
|
||||
|
||||
/** Id of period used by output thread */
|
||||
rtems_id delivery_thread_period_id;
|
||||
|
||||
/** Indicates Delivery thread is running */
|
||||
bool delivery_thread_is_running;
|
||||
|
||||
/** Indicates Delivery thread has been requested to exit */
|
||||
bool delivery_thread_request_exit;
|
||||
|
||||
/** Indicates Delivery thread has exited */
|
||||
bool delivery_thread_has_exited;
|
||||
|
||||
/** Internal Statistics */
|
||||
_Regulator_Statistics Statistics;
|
||||
|
||||
} _Regulator_Control;
|
||||
|
||||
#endif /* RTEMS_REGULATORIMPL_H */
|
||||
File diff suppressed because it is too large
Load Diff
@@ -510,6 +510,8 @@ links:
|
||||
uid: objmpci
|
||||
- role: build-dependency
|
||||
uid: objpci
|
||||
- role: build-dependency
|
||||
uid: objregulator
|
||||
- role: build-dependency
|
||||
uid: objpsxsgnl
|
||||
- role: build-dependency
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
|
||||
build-type: objects
|
||||
cflags: []
|
||||
copyrights:
|
||||
- Copyright (C) 2023 OAR Corporatoin
|
||||
cppflags: []
|
||||
cxxflags: []
|
||||
enabled-by: true
|
||||
includes: []
|
||||
install:
|
||||
- destination: ${BSP_INCLUDEDIR}/rtems
|
||||
source:
|
||||
- cpukit/include/rtems/regulator.h
|
||||
- cpukit/include/rtems/regulatorimpl.h
|
||||
links: []
|
||||
source:
|
||||
- cpukit/libmisc/regulator/regulator.c
|
||||
type: build
|
||||
@@ -228,6 +228,8 @@ links:
|
||||
uid: record01
|
||||
- role: build-dependency
|
||||
uid: record02
|
||||
- role: build-dependency
|
||||
uid: regulator01
|
||||
- role: build-dependency
|
||||
uid: rtmonuse
|
||||
- role: build-dependency
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
|
||||
build-type: test-program
|
||||
cflags: []
|
||||
copyrights:
|
||||
- Copyright (C) 2023 OAR Corporation
|
||||
cppflags: []
|
||||
cxxflags: []
|
||||
enabled-by: true
|
||||
features: c cprogram
|
||||
includes: []
|
||||
ldflags:
|
||||
- -Wl,--wrap=malloc
|
||||
links: []
|
||||
source:
|
||||
- testsuites/libtests/regulator01/regulator01.c
|
||||
- testsuites/libtests/regulator01/rtems_config.c
|
||||
stlib: []
|
||||
target: testsuites/libtests/regulator01.exe
|
||||
type: build
|
||||
use-after: []
|
||||
use-before: []
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,67 @@
|
||||
# SPDX-License-Identifier: BSD-2-Clause
|
||||
|
||||
# Copyright (c) 2023 OAR Corporation
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
|
||||
This file describes the directives and concepts tested by this test set.
|
||||
|
||||
test set name: regulator01
|
||||
|
||||
directives:
|
||||
+ rtems_regulator_create
|
||||
+ rtems_regulator_delete
|
||||
+ rtems_regulator_obtain_buffer
|
||||
+ rtems_regulator_release_buffer
|
||||
+ rtems_regulator_send
|
||||
|
||||
concepts
|
||||
+ Verify rtems_regulator_create() maximum_to_dequeue_per_period
|
||||
+ Verify rtems_regulator_create() NULL attributes error
|
||||
+ Verify rtems_regulator_create NULL regulator error
|
||||
+ Verify rtems_regulator_create deliverer is NULL
|
||||
+ Verify rtems_regulator_create maximum_messages is 0 error
|
||||
+ Verify rtems_regulator_create maximum_message_size is 0 error
|
||||
+ Verify rtems_regulator_create maximum_to_dequeue_per_period is 0 error
|
||||
+ Verify rtems_regulator_create returns error on failure to allocate regulator
|
||||
+ Verify rtems_regulator_create returns error on failure to allocate buffers
|
||||
+ Verify rtems_regulator_create and delete work
|
||||
+ Verify rtems_regulator_create rtems_partition_create error
|
||||
+ Verify rtems_regulator_create rtems_message_queue_create error
|
||||
+ Verify rtems_regulator_create rtems_task_create error
|
||||
+ Verify Regulator Output Thread Handles Error on Period Create
|
||||
+ Verify rtems_regulator_delete NULL regulator error
|
||||
+ Verify rtems_regulator_delete uninitialized regulator error
|
||||
+ Verify rtems_regulator_delete successful case
|
||||
+ Verify rtems_regulator_obtain_buffer NULL regulator error
|
||||
+ Verify rtems_regulator_obtain_buffer uninitialized regulator error
|
||||
+ Verify rtems_regulator_obtain_buffer successful case
|
||||
+ Verify rtems_regulator_release_buffer NULL regulator error
|
||||
+ Verify rtems_regulator_release_buffer uninitialized regulator error
|
||||
+ Verify rtems_regulator_release_buffer successful case
|
||||
+ Verify rtems_regulator_send NULL regulator error
|
||||
+ Verify rtems_regulator_send NULL message error
|
||||
+ Verify rtems_regulator_send zero length message error
|
||||
+ Verify rtems_regulator_send uninitialized regulator error
|
||||
+ Verify rtems_regulator_send and output thread delivers message
|
||||
+ Verify rtems_regulator_send and cannot delete with outstanding messages
|
||||
@@ -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>
|
||||
Reference in New Issue
Block a user