lincan_internals.tmpl

LinCAN is a Linux kernel module that implements a CAN driver capable of working with multiple cards,

<?xml version="1.0" encoding="UTF-8"?>
<section id="lincan-internals">
  <title>LinCAN Driver Internals</title>
  <section id="lincan-api-main" xreflabel="lincan-api-main">
    <title>Basic Driver Data Structures</title>
!F../include/main.h
  </section>
  <section id="lincan-api-board" xreflabel="lincan-api-board">
    <title>Board Support Functions</title>
    <para>
      The functions, which should be implemented for each supported board,
      are described in the next section. The functions are prefixed
      by boardname. The prefix <replaceable>template</replaceable> has
      been selected for next description.
    </para>
!F../src/template.c
  </section>
  <section id="lincan-api-chip" xreflabel="lincan-api-chip">
    <title>Chip Support Functions</title>
    <para>
      The controller chip specific functions are described in the next section.
      The functions should be prefixed by chip type.
      Because documentation of chip functions has been retrieved from
      the actual SJA1000 PeliCAN support, the function prefix
      is <replaceable>sja1000p</replaceable>.
    </para>
!F../src/sja1000p.c
  </section>
  <section id="lincan-api-queues" xreflabel="lincan-api-queues">
    <title>CAN Queues Common Structures and Functions</title>
    <para>
      This part of the driver implements basic CAN queues infrastructure.
      It is written as much generic as possible and then specialization for each
      category of CAN queues clients is implemented in separate subsystem.
      The only synchronization mechanism required from target system 
      are spin-lock synchronization and atomic bit manipulation.
      Locked sections are narrowed to the short operations.
      Even can message 8 bytes movement is excluded from the locked 
      sections of the code.
    </para>
!F../include/can_queue.h
!F../src/can_queue.c
  </section>
  <section>
    <title>CAN Queues Kernel Specific Functions</title>
!F../src/can_quekern.c
  </section>
  <section>
    <title>CAN Queues RT-Linux Specific Functions</title>
!F../src/can_quertl.c
  </section>
  <section>
    <title>CAN Queues CAN Chips Specific Functions</title>
!F../src/devcommon.c
  </section>
  <section>
    <title>CAN Boards and Chip Setup specific Functions</title>
!F../src/setup.c
  </section>
  <section>
    <title>CAN Boards and Chip Finalization Functions</title>
!F../src/finish.c
  </section>
</section>