regulator.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * 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.
 */
 
#ifndef REGULATOR_H
#define REGULATOR_H
 
#include <stdlib.h>
 
#include <rtems.h>
 
typedef bool (*rtems_regulator_deliverer)(
  void     *context,
  void     *message,
  size_t    length
);
 
typedef struct {
  rtems_regulator_deliverer deliverer;
 
  void  *deliverer_context;
 
  size_t  maximum_message_size;
 
  size_t  maximum_messages;
 
  rtems_task_priority delivery_thread_priority;
 
  size_t delivery_thread_stack_size;
 
  rtems_interval delivery_thread_period;
 
  size_t  maximum_to_dequeue_per_period;
 
} rtems_regulator_attributes;
 
typedef struct {
  size_t    obtained;
  
  size_t    released;
 
  size_t    delivered;
 
  rtems_rate_monotonic_period_statistics period_statistics;
 
} rtems_regulator_statistics;
 
struct _Regulator_Control;
 
typedef struct _Regulator_Control *rtems_regulator_instance;
 
rtems_status_code rtems_regulator_create(
  rtems_regulator_attributes  *attributes,
  rtems_regulator_instance   **regulator
);
 
rtems_status_code rtems_regulator_delete(
  rtems_regulator_instance    *regulator,
  rtems_interval               ticks
);
 
rtems_status_code rtems_regulator_obtain_buffer(
  rtems_regulator_instance   *regulator,
  void                      **buffer
);
 
rtems_status_code rtems_regulator_release_buffer(
  rtems_regulator_instance   *regulator,
  void                       *buffer
);
 
rtems_status_code rtems_regulator_send(
  rtems_regulator_instance  *regulator,
  void                      *message,
  size_t                     length
);
 
rtems_status_code rtems_regulator_get_statistics(
  rtems_regulator_instance   *regulator,
  rtems_regulator_statistics *statistics
);
 
#endif /* REGULATOR_H */