# 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