_flex_ray__handler_8c.tex

基于freescale MC9S12XF512 MCU

\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\_\-4}~1\label{_flex_ray__handler_8c_a0}

\begin{CompactList}\small\item\em Transmit MB 1, slot 4. \item\end{CompactList}\item 
\#define {\bf RX\_\-SLOT\_\-1}~2\label{_flex_ray__handler_8c_a1}

\begin{CompactList}\small\item\em Receive MB 2, slot 1. \item\end{CompactList}\item 
\#define {\bf TX\_\-SLOT\_\-5}~4\label{_flex_ray__handler_8c_a2}

\begin{CompactList}\small\item\em Transmit MB 4, slot 5. \item\end{CompactList}\item 
\#define {\bf TX\_\-SLOT\_\-5\_\-TRANSMIT\_\-SIDE}~5\label{_flex_ray__handler_8c_a3}

\begin{CompactList}\small\item\em Double Transmit Buffer - transmit side\-MB 5, slot 5. \item\end{CompactList}\item 
\#define {\bf TX\_\-SLOT\_\-62}~11\label{_flex_ray__handler_8c_a4}

\begin{CompactList}\small\item\em Transmit MB 11, slot 62. \item\end{CompactList}\item 
\#define {\bf TX\_\-SLOT\_\-63}~12\label{_flex_ray__handler_8c_a5}

\begin{CompactList}\small\item\em Transmit MB 12, slot 63. \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 vfn\-Flex\-Ray\_\-Init} (void)
\begin{CompactList}\small\item\em Flex\-Ray module configuration. \item\end{CompactList}\item 
void {\bf vfn\-Flex\-Ray\_\-Handler} (void)
\begin{CompactList}\small\item\em Flex\-Ray module handling routines. \item\end{CompactList}\end{CompactItemize}
\subsection*{Variables}
\begin{CompactItemize}
\item 
Fr\_\-return\_\-type {\bf return\_\-value}\label{_flex_ray__handler_8c_a6}

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

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

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

\begin{CompactList}\small\item\em Current cycle value. \item\end{CompactList}\item 
uint16 {\bf tx\_\-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 
uint16 {\bf tx\_\-data\_\-5} [16] = \{0\}\label{_flex_ray__handler_8c_a11}

\begin{CompactList}\small\item\em Data array - static segment, slot 5. \item\end{CompactList}\item 
uint16 {\bf tx\_\-data\_\-62} [8] = \{0\}\label{_flex_ray__handler_8c_a12}

\begin{CompactList}\small\item\em Data array - dynamic segment, slot 62. \item\end{CompactList}\item 
uint16 {\bf tx\_\-data\_\-63} [8] = \{0\}\label{_flex_ray__handler_8c_a13}

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

\begin{CompactList}\small\item\em Variable used for storing of the return values. \item\end{CompactList}\item 
Fr\_\-tx\_\-status\_\-type {\bf tx\_\-status}\label{_flex_ray__handler_8c_a15}

\begin{CompactList}\small\item\em Variable to determine if data has been tranmsitted. \item\end{CompactList}\item 
uint16 {\bf rx\_\-data\_\-1} [16] = \{0\}\label{_flex_ray__handler_8c_a16}

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

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

\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_a19}

\begin{CompactList}\small\item\em Variable used for storing of the return values. \item\end{CompactList}\item 
Fr\_\-rx\_\-status\_\-type {\bf rx\_\-status}\label{_flex_ray__handler_8c_a20}

\begin{CompactList}\small\item\em Variable to determine if a frame has been received. \item\end{CompactList}\item 
uint16 {\bf mb\_\-access\_\-error} = 0\label{_flex_ray__handler_8c_a21}

\begin{CompactList}\small\item\em The number of the message buffer access errors. \item\end{CompactList}\item 
uint16 {\bf chi\_\-error} = 0\label{_flex_ray__handler_8c_a22}

\begin{CompactList}\small\item\em The number of the CHI related errors. \item\end{CompactList}\item 
uint16 {\bf transmission\_\-across\_\-boundary} = 0\label{_flex_ray__handler_8c_a23}

\begin{CompactList}\small\item\em The number of the transmission across boundary errors. \item\end{CompactList}\item 
uint16 {\bf violation} = 0\label{_flex_ray__handler_8c_a24}

\begin{CompactList}\small\item\em The number of boundary violation errors. \item\end{CompactList}\item 
boolean {\bf protocol\_\-error} = FALSE\label{_flex_ray__handler_8c_a25}

\begin{CompactList}\small\item\em Internal protocol error detected. \item\end{CompactList}\item 
boolean {\bf cycle\_\-starts} = FALSE\label{_flex_ray__handler_8c_a26}

\begin{CompactList}\small\item\em Communication cycle. \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 polling mode (transmit\_\-receive\_\-node2.c) made by R62779. \begin{Desc}
\item[Author:]Freescale Semiconductor 

Guadalajara Applications Laboratory RTAC Americas 

Jaime Orozco \end{Desc}
\begin{Desc}
\item[Version:]1.2 \end{Desc}
\begin{Desc}
\item[Date:]March/12/2007 \end{Desc}


\subsection{Function Documentation}
\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_a27}


Error function for debugging. 

\begin{Desc}
\item[Author:]R62779 \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_Handler@{vfnFlexRay\_\-Handler}}
\index{vfnFlexRay_Handler@{vfnFlexRay\_\-Handler}!FlexRay_handler.c@{Flex\-Ray\_\-handler.c}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void vfn\-Flex\-Ray\_\-Handler (void)}\label{_flex_ray__handler_8c_a29}


Flex\-Ray module handling routines. 

\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}
\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_a28}


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}