ctucanfd_internal.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 Linux CTU CAN FD driver
* Copyright (C) 2015-2018 Ondrej Ille <ondrej.ille@gmail.com> FEE CTU
* Copyright (C) 2018-2021 Ondrej Ille <ondrej.ille@gmail.com> self-funded
* Copyright (C) 2018-2019 Martin Jerabek <martin.jerabek01@gmail.com> FEE CTU
* Copyright (C) 2018-2022 Pavel Pisa <pisa@cmp.felk.cvut.cz> FEE CTU/self-funded
*
* 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 __CTUCANFD_INTERNAL_H
#define __CTUCANFD_INTERNAL_H
 
#include <dev/can/can-queue.h>
#include <dev/can/can-helpers.h>
 
#include <dev/can/ctucanfd.h>
 
#include "ctucanfd_kregs.h"
 
struct ctucanfd_txb_info {
  struct rtems_can_queue_slot *slot;
  struct rtems_can_queue_edge *edge;
};
 
struct ctucanfd_internal {
  uintptr_t base;
  uint32_t int_ena;
  uint32_t int_mask;
  struct ctucanfd_txb_info txb_info[RTEMS_CTUCANFD_NTXBUFS_MAX];
  uint8_t txb_prio_tail[RTEMS_CAN_QUEUE_PRIO_NR];
  uint32_t txb_order;
  unsigned int ntxbufs;
};
 
static inline void ctucanfd_write32(
  struct ctucanfd_internal *internal,
  enum ctu_can_fd_can_registers reg,
  uint32_t val
)
{
  *( volatile uint32_t * )( internal->base + reg ) = val;
}
 
static inline uint32_t ctucanfd_read32(
  struct ctucanfd_internal *internal,
  enum ctu_can_fd_can_registers reg
)
{
  return *( volatile uint32_t * )( internal->base + reg );
}
 
static inline void ctucanfd_write_txt_buf(
  struct ctucanfd_internal *internal,
  enum ctu_can_fd_can_registers buf_base,
  uint32_t offset,
  uint32_t val
)
{
  *( volatile uint32_t * )( internal->base + buf_base + offset ) = val;
}
 
#define CTU_CAN_FD_ENABLED( internal ) (!!FIELD_GET( \
  REG_MODE_ENA, \
  ctucanfd_read32( internal, CTUCANFD_MODE ) \
) )
 
#endif /* __CTUCANFD_PRIV_H */