regulatorimpl.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 RTEMS_REGULATORIMPL_H
#define RTEMS_REGULATORIMPL_H
 
#include <stdatomic.h>
 
#include <rtems/chain.h>
 
 
#define REGULATOR_INITIALIZED 0xDeadF00d
 
typedef struct {
  void   *buffer;
  size_t  length;
} _Regulator_Message_t;
 
typedef struct {
  atomic_size_t    obtained;
  
  atomic_size_t    released;
 
  atomic_size_t    delivered;
} _Regulator_Statistics;
 
typedef struct {
  uint32_t   initialized;
 
  rtems_regulator_attributes  Attributes;
 
  void *message_memory;
 
  void *message_queue_storage;
 
  rtems_id  queue_id;
 
  rtems_id  messages_partition_id;
 
  rtems_id  delivery_thread_id;
 
  rtems_id  delivery_thread_period_id;
 
  bool  delivery_thread_is_running;
 
  bool  delivery_thread_request_exit;
 
  bool  delivery_thread_has_exited;
 
  _Regulator_Statistics Statistics;
 
} _Regulator_Control;
 
#endif /* RTEMS_REGULATORIMPL_H */