can-devcommon.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_DEVCOMMON_H
#define _DEV_CAN_CAN_DEVCOMMON_H
 
#include <rtems.h>
#include <stdint.h>
#include <stdatomic.h>
#include <sys/ioccom.h>
#include <rtems/thread.h>
 
#include <dev/can/can.h>
#include <dev/can/can-bus.h>
#include <dev/can/can-impl.h>
 
struct rtems_can_queue_ends_dev {
  struct rtems_can_queue_ends base;
  struct rtems_can_chip *chip;
  rtems_binary_semaphore worker_sem;
};
 
struct rtems_can_user;
TAILQ_HEAD( rtems_can_user_list_t, rtems_can_user );
 
struct rtems_can_chip;
 
struct rtems_can_chip_ops {
  int ( *start_chip )( struct rtems_can_chip *chip );
  int ( *stop_chip )( struct rtems_can_chip *chip, struct timespec *ts );
  int ( *chip_ioctl )(
    struct rtems_can_chip *chip,
    ioctl_command_t command,
    void *arg
  );
  int ( *get_chip_timestamp )(
    struct rtems_can_chip *chip,
    uint64_t *timestamp
  );
  int ( *get_chip_info )( struct rtems_can_chip *chip, int what );
  int ( *calc_bittiming )(
    struct rtems_can_chip *chip,
    int type,
    struct rtems_can_bittiming *bt
  );
  int ( *check_and_set_bittiming )(
    struct rtems_can_chip *chip,
    int type,
    struct rtems_can_bittiming *bt
  );
  int ( *set_chip_mode )( struct rtems_can_chip *chip, uint32_t mode );
};
 
struct rtems_can_chip {
  const char *type;
  rtems_vector_number irq;
  uint32_t freq;
  bool close_nonblock;
  atomic_uint flags;
  atomic_uint used;
  uint32_t ctrlmode;
  uint32_t ctrlmode_supported;
  uint32_t capabilities;
  rtems_mutex lock;
  rtems_binary_semaphore stop_sem;
  const struct rtems_can_bittiming_const *bittiming_const;
  const struct rtems_can_bittiming_const *data_bittiming_const;
  struct rtems_can_bittiming bittiming;
  struct rtems_can_bittiming data_bittiming;
  struct rtems_can_chip_ops chip_ops;
  struct rtems_can_queue_ends_dev *qends_dev;
  struct rtems_can_user_list_t can_users;
  struct rtems_can_stats chip_stats;
  void *internal;
};
 
struct rtems_can_queue_ends_user_t {
  struct rtems_can_queue_ends base;
  rtems_binary_semaphore sem_read;
  rtems_binary_semaphore sem_write;
  rtems_binary_semaphore sem_sync;
};
 
struct rtems_can_user {
  unsigned long flags;
  TAILQ_ENTRY( rtems_can_user ) peers;
  struct rtems_can_queue_ends_user_t *qends_user;
  struct rtems_can_bus *bus;
  int magic;
};
 
int rtems_can_chip_start( struct rtems_can_chip *chip );
 
int rtems_can_bitrate2bittiming(
  struct rtems_can_chip *chip,
  struct rtems_can_bittiming *bt,
  const struct rtems_can_bittiming_const *btc
);
 
uint64_t rtems_can_fill_timestamp( void );
 
int rtems_can_queue_ends_init_user(
  struct rtems_can_queue_ends_user_t *qends
);
 
int rtems_can_queue_ends_init_chip(
  struct rtems_can_chip *chip,
  const char *name
);
 
#endif /* _DEV_CAN_CAN_DEVCOMMON_H */