can-queue.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause OR Apache-2.0 OR GPL-2.0-or-later */
 
/*
 * Copyright (C) 2023-2024 Michal Lenc <michallenc@seznam.cz>
 * Implementation is based on original LinCAN - Linux CAN bus driver
 * Part of OrtCAN project https://ortcan.sourceforge.net/
 * Copyright (C) 2002-2009 DCE FEE CTU Prague <http://control.fel.cvut.cz>
 * Copyright (C) 2002-2024 Pavel Pisa <pisa@cmp.felk.cvut.cz>
 *
 * 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 __DEV_CAN_CAN_QUEUE_H
#define __DEV_CAN_CAN_QUEUE_H
 
#include <stdatomic.h>
#include <inttypes.h>
#include <sys/queue.h>
#include <rtems.h>
#include <rtems/timespec.h>
#include <rtems/status-checks.h>
#include <rtems/thread.h>
 
#include <dev/can/can-frame.h>
#include <dev/can/can-filter.h>
 
struct rtems_can_queue_slot {
  struct rtems_can_queue_slot *next;
  atomic_uint slot_flags;
  struct can_frame frame;
};
 
#define RTEMS_CAN_SLOTF_CMD  ( 0x00ff )
 
struct rtems_can_queue_fifo {
  atomic_uint fifo_flags;
  unsigned int out_taken;
  unsigned long error_code;
  struct rtems_can_queue_slot *head;
  struct rtems_can_queue_slot **tail;
  struct rtems_can_queue_slot *free_list;
  struct rtems_can_queue_slot *entry;
  int max_data_length;
  int allocated_slot_count;
  rtems_mutex fifo_lock;
};
 
#define RTEMS_CAN_FIFOF_DESTROY      ( 1 << 15 )
#define RTEMS_CAN_FIFOF_ERROR        ( 1 << 14 )
#define RTEMS_CAN_FIFOF_ERR2BLOCK    ( 1 << 13 )
#define RTEMS_CAN_FIFOF_BLOCK        ( 1 << 12 )
#define RTEMS_CAN_FIFOF_OVERRUN      ( 1 << 11 )
#define RTEMS_CAN_FIFOF_FULL         ( 1 << 10 )
#define RTEMS_CAN_FIFOF_EMPTY        ( 1 << 9 )
#define RTEMS_CAN_FIFOF_DEAD         ( 1 << 8 )
#define RTEMS_CAN_FIFOF_INACTIVE     ( 1 << 7 )
#define RTEMS_CAN_FIFOF_FREEONEMPTY  ( 1 << 6 )
#define RTEMS_CAN_FIFOF_READY        ( 1 << 5 )
#define RTEMS_CAN_FIFOF_NOTIFYPEND   ( 1 << 4 )
 
int rtems_can_queue_fifo_flush_slots( struct rtems_can_queue_fifo *fifo );
 
int rtems_can_queue_fifo_init_slots( struct rtems_can_queue_fifo *fifo );
 
struct rtems_can_queue_edge;
TAILQ_HEAD( rtems_can_queue_edges_list, rtems_can_queue_edge );
 
struct rtems_can_queue_edge {
  struct rtems_can_queue_fifo fifo;
  struct rtems_can_filter filter;
  TAILQ_ENTRY( rtems_can_queue_edge ) input_peers;
  TAILQ_ENTRY( rtems_can_queue_edge ) output_peers;
  TAILQ_ENTRY( rtems_can_queue_edge ) activepeers;
  struct rtems_can_queue_edges_list *peershead;
  struct rtems_can_queue_ends *input_ends;
  struct rtems_can_queue_ends *output_ends;
  atomic_uint edge_used;
  int edge_prio;
  int edge_num;
};
 
struct rtems_can_queue_ends;
TAILQ_HEAD( rtems_can_queue_ends_list, rtems_can_queue_ends );
 
struct rtems_can_queue_ends {
  struct rtems_can_queue_edges_list active[RTEMS_CAN_QUEUE_PRIO_NR];
  struct rtems_can_queue_edges_list idle;
  struct rtems_can_queue_edges_list inlist;
  struct rtems_can_queue_edges_list outlist;
  rtems_mutex ends_lock;
  void (*notify)(
    struct rtems_can_queue_ends *qends,
    struct rtems_can_queue_edge *qedge,
    int what
  );
  TAILQ_ENTRY( rtems_can_queue_ends ) dead_peers;
};
 
#define RTEMS_CAN_QUEUE_NOTIFY_EMPTY  ( 1 )
#define RTEMS_CAN_QUEUE_NOTIFY_SPACE  ( 2 )
#define RTEMS_CAN_QUEUE_NOTIFY_PROC   ( 3 )
#define RTEMS_CAN_QUEUE_NOTIFY_NOUSR  ( 4 )
#define RTEMS_CAN_QUEUE_NOTIFY_DEAD   ( 5 )
#define RTEMS_CAN_QUEUE_NOTIFY_DEAD_WANTED ( 6 )
#define RTEMS_CAN_QUEUE_NOTIFY_ATTACH ( 7 )
 
int rtems_can_queue_get_inslot(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge **qedgep,
  struct rtems_can_queue_slot **slotp,
  int cmd
);
 
int rtems_can_queue_get_inslot_for_prio(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge **qedgep,
  struct rtems_can_queue_slot **slotp,
  const struct can_frame_header *header,
  int cmd,
  int prio
);
 
int rtems_can_queue_test_inslot( struct rtems_can_queue_ends *qends );
 
int rtems_can_queue_put_inslot(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge *qedge,
  struct rtems_can_queue_slot *slot
);
 
int rtems_can_queue_abort_inslot(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge *qedge,
  struct rtems_can_queue_slot *slot
);
 
int rtems_can_queue_filter_frame_to_edges(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge *src_edge,
  struct can_frame *frame,
  unsigned int flags2add
);
 
int rtems_can_queue_test_outslot(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge **qedgep,
  struct rtems_can_queue_slot **slotp
);
 
int rtems_can_queue_pending_outslot_prio(
  struct rtems_can_queue_ends *qends,
  int prio_min
);
 
int rtems_can_queue_free_outslot(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge *qedge,
  struct rtems_can_queue_slot *slot
);
 
int rtems_can_queue_push_back_outslot(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge *qedge,
  struct rtems_can_queue_slot *slot
);
 
int rtems_can_queue_flush( struct rtems_can_queue_edge *qedge );
 
int rtems_can_queue_disconnect_edge( struct rtems_can_queue_edge *qedge );
 
int rtems_can_queue_connect_edge(
  struct rtems_can_queue_edge *qedge,
  struct rtems_can_queue_ends *input_ends,
  struct rtems_can_queue_ends *output_ends
);
 
int rtems_can_queue_ends_init( struct rtems_can_queue_ends *qends );
 
void rtems_can_queue_block_inlist( struct rtems_can_queue_ends *qends );
 
void rtems_can_queue_block_outlist( struct rtems_can_queue_ends *qends );
 
int rtems_can_queue_ends_kill_inlist(
  struct rtems_can_queue_ends *qends,
  int send_rest
);
 
int rtems_can_queue_ends_kill_outlist( struct rtems_can_queue_ends *qends );
 
int rtems_can_queue_ends_flush_inlist( struct rtems_can_queue_ends *qends );
 
int rtems_can_queue_ends_flush_outlist( struct rtems_can_queue_ends *qends );
 
void rtems_can_queue_do_edge_decref( struct rtems_can_queue_edge *edge );
 
void rtems_can_queue_edge_do_dead( struct rtems_can_queue_edge *qedge );
 
int rtems_can_queue_fifo_init_kern(
  struct rtems_can_queue_fifo *fifo,
  int allocated_slot_count,
  int max_data_length
);
 
int rtems_can_queue_fifo_done_kern( struct rtems_can_queue_fifo *fifo );
 
struct rtems_can_queue_edge *rtems_can_queue_new_edge_kern(
  int allocated_slot_countm,
  int max_data_length
);
 
int rtems_can_queue_ends_sync_all_kern(
  struct rtems_can_queue_ends *qends,
  struct timespec *ts
);
 
int rtems_can_queue_sync_wait_kern(
  struct rtems_can_queue_ends *qends,
  struct rtems_can_queue_edge *qedge,
  bool nowait,
  rtems_interval timeout
);
 
int rtems_can_queue_ends_dispose_kern(
  struct rtems_can_queue_ends *qends,
  bool nonblock
);
 
int rtems_can_queue_kern_initialize( void );
 
#endif /* __DEV_CAN_CAN_QUEUE_H */