_flex_ray__handler_8c.tex

来自「基于freescale MC9S12XF512 MCU」· TEX 代码 · 共 242 行

\section{Flex\-Ray\_\-handler.c File Reference}
\label{_flex_ray__handler_8c}\index{FlexRay_handler.c@{FlexRay\_\-handler.c}}
Copyright (c) 2007 Freescale Semiconductor Freescale Confidential Proprietary

Flex\-Ray module handling routines. 

{\tt \#include \char`\"{}M9S12XF512.h\char`\"{}}\par
{\tt \#include \char`\"{}GPIO\_\-macros.h\char`\"{}}\par
{\tt \#include \char`\"{}Fr\_\-UNIFIED\_\-types.h\char`\"{}}\par
{\tt \#include \char`\"{}Fr\_\-UNIFIED.h\char`\"{}}\par
{\tt \#include \char`\"{}Fr\_\-UNIFIED\_\-cfg.h\char`\"{}}\par
\subsection*{Defines}
\begin{CompactItemize}
\item 
\#define {\bf TX\_\-SLOT\_\-1}~0\label{_flex_ray__handler_8c_a0}

\begin{CompactList}\small\item\em Double transmit MB 0 - commit side, slot 1. \item\end{CompactList}\item 
\#define {\bf TX\_\-SLOT\_\-1\_\-TRANSMIT\_\-SIDE}~1\label{_flex_ray__handler_8c_a1}

\begin{CompactList}\small\item\em Double transmit MB 1 - transmit side, slot 1. \item\end{CompactList}\item 
\#define {\bf RX\_\-SLOT\_\-4}~3\label{_flex_ray__handler_8c_a2}

\begin{CompactList}\small\item\em Receive MB 3, slot 4. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void {\bf Failed} (uint8 u8number)
\begin{CompactList}\small\item\em Error function for debugging. \item\end{CompactList}\item 
void {\bf CC\_\-interrupt\_\-slot\_\-1} (uint8 buffer\_\-idx)
\begin{CompactList}\small\item\em Function for transmission on Slot 1. \item\end{CompactList}\item 
void {\bf CC\_\-interrupt\_\-slot\_\-4} (uint8 buffer\_\-idx)
\begin{CompactList}\small\item\em Function for reception on Slot 4. \item\end{CompactList}\item 
void {\bf CC\_\-interrupt\_\-timer\_\-1} (void)
\begin{CompactList}\small\item\em Function for Flex\-Ray Timer 1. \item\end{CompactList}\item 
void {\bf CC\_\-interrupt\_\-timer\_\-2} (void)
\begin{CompactList}\small\item\em Function for Flex\-Ray Timer 2. \item\end{CompactList}\item 
void {\bf CC\_\-interrupt\_\-cycle\_\-start} (void)
\begin{CompactList}\small\item\em Function for Flex\-Ray cycle start interrupt. \item\end{CompactList}\item 
void {\bf CC\_\-interrupt\_\-FIFO\_\-A} (uint16 header\_\-idx)
\begin{CompactList}\small\item\em Function for Flex\-Ray FIFO A interrupt. \item\end{CompactList}\item 
void {\bf vfn\-Flex\-Ray\_\-Init} (void)
\begin{CompactList}\small\item\em Flex\-Ray module configuration. \item\end{CompactList}\end{CompactItemize}
\subsection*{Variables}
\begin{CompactItemize}
\item 
Fr\_\-return\_\-type {\bf return\_\-value}\label{_flex_ray__handler_8c_a3}

\begin{CompactList}\small\item\em Return values. \item\end{CompactList}\item 
Fr\_\-POC\_\-state\_\-type {\bf protocol\_\-state}\label{_flex_ray__handler_8c_a4}

\begin{CompactList}\small\item\em Current protocol state. \item\end{CompactList}\item 
Fr\_\-wakeup\_\-state\_\-type {\bf wakeup\_\-status}\label{_flex_ray__handler_8c_a5}

\begin{CompactList}\small\item\em Current wakeup status. \item\end{CompactList}\item 
uint8 {\bf current\_\-cycle}\label{_flex_ray__handler_8c_a6}

\begin{CompactList}\small\item\em Current cycle value. \item\end{CompactList}\item 
uint16 {\bf current\_\-macrotick}\label{_flex_ray__handler_8c_a7}

\begin{CompactList}\small\item\em Current macrotick value. \item\end{CompactList}\item 
uint16 {\bf tx\_\-data\_\-1} [16] = \{0\}\label{_flex_ray__handler_8c_a8}

\begin{CompactList}\small\item\em Data array - static segment, slot 1. \item\end{CompactList}\item 
Fr\_\-tx\_\-MB\_\-status\_\-type {\bf tx\_\-return\_\-value}\label{_flex_ray__handler_8c_a9}

\begin{CompactList}\small\item\em Transmission return values. \item\end{CompactList}\item 
uint16 {\bf rx\_\-data\_\-4} [16] = \{0\}\label{_flex_ray__handler_8c_a10}

\begin{CompactList}\small\item\em Data array - static segment, slot 4. \item\end{CompactList}\item 
uint8 {\bf rx\_\-data\_\-length} = 0\label{_flex_ray__handler_8c_a11}

\begin{CompactList}\small\item\em Received data length. \item\end{CompactList}\item 
uint16 {\bf rx\_\-status\_\-slot} = 0\label{_flex_ray__handler_8c_a12}

\begin{CompactList}\small\item\em Received frame status. \item\end{CompactList}\item 
Fr\_\-rx\_\-MB\_\-status\_\-type {\bf rx\_\-return\_\-value}\label{_flex_ray__handler_8c_a13}

\begin{CompactList}\small\item\em Reception return values. \item\end{CompactList}\item 
uint16 {\bf fifo\_\-data} [8] = \{0\}\label{_flex_ray__handler_8c_a14}

\begin{CompactList}\small\item\em Data array. \item\end{CompactList}\item 
uint8 {\bf fifo\_\-data\_\-length} = 0\label{_flex_ray__handler_8c_a15}

\begin{CompactList}\small\item\em Received data length. \item\end{CompactList}\item 
uint16 {\bf fifo\_\-status\_\-slot} = 0\label{_flex_ray__handler_8c_a16}

\begin{CompactList}\small\item\em Received frame status. \item\end{CompactList}\item 
uint16 {\bf fifo\_\-slot\_\-idx} = 0\label{_flex_ray__handler_8c_a17}

\begin{CompactList}\small\item\em Received frame index. \item\end{CompactList}\item 
Fr\_\-FIFO\_\-status\_\-type {\bf fifo\_\-return\_\-value}\label{_flex_ray__handler_8c_a18}

\begin{CompactList}\small\item\em Return values. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Copyright (c) 2007 Freescale Semiconductor Freescale Confidential Proprietary

Flex\-Ray module handling routines. 

Code based on the Transmit/Receive application example for the Flex\-Ray UNIFIED driver in interrupt driven mode (transmit\_\-receive\_\-node1.c) made by R62779. \begin{Desc}
\item[Author:]Freescale Semiconductor 

Guadalajara Applications Laboratory RTAC Americas 

Jaime Orozco \end{Desc}
\begin{Desc}
\item[Version:]1.1 \end{Desc}
\begin{Desc}
\item[Date:]May/07/2007 \end{Desc}


\subsection{Function Documentation}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!CC_interrupt_cycle_start@{CC\_\-interrupt\_\-cycle\_\-start}}
\index{CC_interrupt_cycle_start@{CC\_\-interrupt\_\-cycle\_\-start}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CC\_\-interrupt\_\-cycle\_\-start (void)}\label{_flex_ray__handler_8c_a24}


Function for Flex\-Ray cycle start interrupt. 

\begin{Desc}
\item[Author:]R62779 \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em void}]\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!CC_interrupt_FIFO_A@{CC\_\-interrupt\_\-FIFO\_\-A}}
\index{CC_interrupt_FIFO_A@{CC\_\-interrupt\_\-FIFO\_\-A}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CC\_\-interrupt\_\-FIFO\_\-A (uint16 {\em header\_\-idx})}\label{_flex_ray__handler_8c_a25}


Function for Flex\-Ray FIFO A interrupt. 

\begin{Desc}
\item[Author:]R62779 \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em header\_\-idx,:}]Header index \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!CC_interrupt_slot_1@{CC\_\-interrupt\_\-slot\_\-1}}
\index{CC_interrupt_slot_1@{CC\_\-interrupt\_\-slot\_\-1}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CC\_\-interrupt\_\-slot\_\-1 (uint8 {\em buffer\_\-idx})}\label{_flex_ray__handler_8c_a20}


Function for transmission on Slot 1. 

\begin{Desc}
\item[Author:]R62779 \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buffer\_\-idx,:}]Message Buffer identifier \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!CC_interrupt_slot_4@{CC\_\-interrupt\_\-slot\_\-4}}
\index{CC_interrupt_slot_4@{CC\_\-interrupt\_\-slot\_\-4}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CC\_\-interrupt\_\-slot\_\-4 (uint8 {\em buffer\_\-idx})}\label{_flex_ray__handler_8c_a21}


Function for reception on Slot 4. 

\begin{Desc}
\item[Author:]R62779 \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buffer\_\-idx,:}]Message Buffer identifier \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!CC_interrupt_timer_1@{CC\_\-interrupt\_\-timer\_\-1}}
\index{CC_interrupt_timer_1@{CC\_\-interrupt\_\-timer\_\-1}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CC\_\-interrupt\_\-timer\_\-1 (void)}\label{_flex_ray__handler_8c_a22}


Function for Flex\-Ray Timer 1. 

\begin{Desc}
\item[Author:]R62779 \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em void}]\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!CC_interrupt_timer_2@{CC\_\-interrupt\_\-timer\_\-2}}
\index{CC_interrupt_timer_2@{CC\_\-interrupt\_\-timer\_\-2}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void CC\_\-interrupt\_\-timer\_\-2 (void)}\label{_flex_ray__handler_8c_a23}


Function for Flex\-Ray Timer 2. 

\begin{Desc}
\item[Author:]R62779 \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em void}]\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!Failed@{Failed}}
\index{Failed@{Failed}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Failed (uint8 {\em u8number})}\label{_flex_ray__handler_8c_a19}


Error function for debugging. 

\begin{Desc}
\item[Author:]Jaime Orozco \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em u8number,:}]error code \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}
\index{FlexRay_handler.c@{Flex\-Ray\_\-handler.c}!vfnFlexRay_Init@{vfnFlexRay\_\-Init}}
\index{vfnFlexRay_Init@{vfnFlexRay\_\-Init}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void vfn\-Flex\-Ray\_\-Init (void)}\label{_flex_ray__handler_8c_a26}


Flex\-Ray module configuration. 

\begin{Desc}
\item[Author:]Jaime Orozco \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em void}]\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]void \end{Desc}