1

\documentclass[12pt,english,a4paper]{book}

     2

\usepackage[T1]{fontenc}

     3

\usepackage[latin9]{inputenc}

     4

\usepackage{graphicx}

     5

\usepackage{amsfonts}

     6

\usepackage{textcomp}

     7

\usepackage{color}

     8

\usepackage{calc}

     9

\usepackage{longtable}

    10

\usepackage{hyperref}

    11

\usepackage{graphics}

    12

\DeclareGraphicsExtensions{.jpg}

    13

\DeclareGraphicsExtensions{.png}

    14

\hypersetup{colorlinks=true, linkcolor=blue, filecolor=blue, pagecolor=blue, urlcolor=blue}

    15

    16

%%%%\%%%%%%%% titre, auteurs, date, etc...%%%%%%%%%%%%%%%%%%

    17

\title{\Huge The CanFestival CANOpen stack manual}

    18

\author{Edouard TISSERANT}

    19

\date{\today}

    20

    21

\setcounter{secnumdepth}{5}

    22

\renewcommand\thesection{\arabic{section} -}

    23

\renewcommand\thesubsection{\arabic{section}.\arabic{subsection})}

    24

\renewcommand\thesubsubsection{\arabic{section}.\arabic{subsection}.\arabic{subsubsection})}

    25

\renewcommand\theparagraph{\alph{paragraph})}

    26

\renewcommand\thesubparagraph{\roman{subparagraph})}

    27

    28

\newcommand{\canopen}{CANopen }

    29

    30

\begin{document}

    31

{\centering\textsf{\huge The CanFestival \canopen stack manual.}}

    32

    33

\renewcommand{\contentsname}{CanFestival v3.0 Manual}

    34

\setcounter{tocdepth}{2} \tableofcontents{}

    35

    36

\clearpage{}

    37

    38

\section{Introduction}

    39

    40

CanFestival is an OpenSource (LGPL and GPL) \canopen framework.

    41

    42

\subsection{The CanFestival project}

    43

    44

This project, initiated by Edouard TISSERANT in 2001, has grown thanks

    45

to Francis DUPIN and other contributors.

    46

    47

Today, CanFestival focuses on providing an ANSI-C platform independent

    48

\canopen stack that can be implemented as master or slave nodes on

    49

PCs, Real-time IPCs, and Microcontrollers.

    50

    51

CanFestival is a project supported by Lolitech.

    52

    53

    54

\subsection{What is \canopen}

    55

    56

CANopen is a CAN based high level protocol. It defines some protocols

    57

to :

    58

    59

\begin{enumerate}

    60

\item Configure a CAN network. 

    61

\item Transmit data to a specific node or in broadcast. 

    62

\item Administrate the network. For example detecting a not responding node. 

    63

\end{enumerate}

    64

The documentation can be found on the CAN in Automation website :

    65

    66

\href{http://www.can-cia.de/canopen}{http://www.can-cia.de/canopen}

    67

    68

The most important document about \canopen is the normative CiA Draft

    69

Standard 301, version 4.02. You can now download the specification

    70

from the CAN in Automation website at no cost.

    71

    72

To continue reading this document, let us assume that you have read

    73

some papers introducing \canopen .

    74

    75

    76

\section{CanFestival Features}

    77

    78

    79

\subsection{Tools }

    80

    81

The \canopen library is coming with some tools :

    82

    83

\begin{enumerate}

    84

\item Object Dictionary editor GUI. WxPython Model-View-Controler based

    85

GUI, that helps a lot in generating object dictionary source code for

    86

each node. 

    87

\item A configure script, that let you chose compile time options such as

    88

target CPU/HOST, CAN and TIMER drivers.\\

    89

 This script has not been generated with autoconf, it has been made

    90

keeping micro-controller target in mind. 

    91

\end{enumerate}

    92

    93

\subsection{Multi-Platform}

    94

    95

\begin{enumerate}

    96

\item Library source code is C-ANSI. 

    97

\item Driver and examples coding conventions merely depend on target specific

    98

contributor/compiler. 

    99

\item Unix compatible interfaces and examples should compile and run on

   100

any Unix system (tested on GNU/Linux and GNU/FreeBSD). 

   101

\end{enumerate}

   102

   103

\subsection{\canopen standard conformance}

   104

   105

\subsubsection{DS-301}

   106

   107

Supported features should conform to DS301. V.4.02 13 february 2002. 

   108

   109

\begin{enumerate}

   110

\item NMT master and slave

   111

\item Heartbeat consumer and producer

   112

\item NodeGuard slave reponder and basic master without tracking

   113

\item SYNC service

   114

\item SDO multiples client and server, segmented and expedited

   115

\item PDO : TPDO and RPDO, with respect to transmission type

   116

\item PDO mapping from/to OD variables bit per bit. 

   117

\item EMCY : Send and receive and keeps track of emergency objects

   118

\item Data types : 8 to 64 bits values, fixed length strings.

   119

\end{enumerate}

   120

   121

\subsubsection{DS-302}

   122

   123

Only concise DFC is supported.

   124

   125

\section{How to start}

   126

   127

\subsection{Host requirements}

   128

   129

What you need on your development workstation.

   130

   131

\subsubsection{Object Dictionary Editor GUI}

   132

   133

\begin{enumerate}

   134

\item Python, with 

   135

\item wxPython modules installed (at least version 2.6.3).

   136

\item Gnosis xml tools. (Optional can also be installed locally to the project

   137

automatically with the help of a Makefile. Please see {}``Using Dictionary

   138

Editor GUI'' ) 

   139

\end{enumerate}

   140

   141

\subsubsection{Linux and Unix-likes}

   142

   143

\begin{enumerate}

   144

\item Linux, FreeBSD, Cygwin or any Unix environment with GNU toolchain. 

   145

\item The GNU C compiler (gcc) or any other ANSI-C compiler for your target

   146

platform. 

   147

\item Xpdf, and the official 301\_v04000201.pdf file in order to get GUI

   148

context sensitive help. 

   149

\item GNU Make 

   150

\item Bash and sed 

   151

\end{enumerate}

   152

   153

\subsubsection{Windows (for native win32 target)}

   154

   155

\begin{enumerate}

   156

\item Visual Studio Express 2005 or worst. 

   157

\item Microsoft platform SDK (requires Genuine Advantage) 

   158

\item Cygwin (for configuration only) 

   159

\end{enumerate}

   160

   161

\subsection{How to get CanFestival}

   162

   163

Please always use CVS, this is the best way to get the most reactive

   164

support from the developer community :

   165

   166

   167

\begin{verbatim}

   168

	cvs -d:pserver:anonymous@lolitech.dyndns.org:/canfestival login

   169

\end{verbatim}

   170

   171

(type return, without entering a password)

   172

   173

Then, enter :

   174

   175

\begin{verbatim}

   176

	cvs -z3 -d:pserver:anonymous@lolitech.dyndns.org:/canfestival co -P CanFestival-3

   177

\end{verbatim}

   178

   179

   180

   181

\section{Understanding Canfestival}

   182

   183

\subsection{CanFestival Project tree layout}

   184

   185

Simplified directory structure.

   186

   187

\begin{verbatim}

   188

./src ANSI-C source of \canopen stack

   189

./include Exportables Header files

   190

./drivers Interfaces to specific platforms/HW

   191

./drivers/unix Linux and Cygwin OS interface

   192

./drivers/win32 Native Win32 OS interface

   193

./drivers/timers_xeno Xenomai timers/threads (Linux only)

   194

./drivers/timers_kernel Linux kernel timer/threads

   195

./drivers/timers_unix Posix timers/threads (Linux, Cygwin)

   196

./drivers/can_virtual_kernel Fake CAN network (kernel space)

   197

./drivers/can_serial Serial point to point and PTY hub (*nix only)

   198

./drivers/can_peak_linux PeakSystem CAN library interface

   199

./drivers/can_peak_win32 PeakSystem PCAN-Light interface

   200

./drivers/can_uvccm_win32 Acacetus's RS232 CAN-uVCCM interface

   201

./drivers/can_virtual Fake CAN network (Linux, Cygwin)

   202

./drivers/hcs12 HCS12 full target interface

   203

./examples Examples

   204

./examples/TestMasterSlave 2 nodes, NMT SYNC SDO PDO, win32+unix

   205

./examples/TestMasterMicroMod 1 node, control Peak I/O Module, unix

   206

./examples/gene_SYNC_HCS12 Just send periodic SYNC on HCS12

   207

./examples/win32test Ask some DS301 infos to a node (win32)

   208

./objdictgen Object Dictionary editor GUI

   209

./objdictgen/config Pre-defined OD profiles

   210

./objdictgen/examples Some examples/test OD

   211

./doc Documentation source

   212

\end{verbatim}

   213

   214

   215

   216

\subsection{Implement CanFestival in your application}

   217

   218

\begin{center}

   219

\includegraphics[width=12cm]{Pictures/10000201000003F9000002CF880931E7} 

   220

\par\end{center}

   221

   222

\bigskip{}

   223

   224

   225

   226

\subsection{CanFestival CAN interfaces}

   227

   228

Because most CAN controllers and drivers implement FIFOs, CanFestival

   229

consider sending message as a non blocking operation.

   230

   231

In order to prevent reentrent calls to the stack, messages reception

   232

is implemented differently on {\textmu}C and OS.:

   233

   234

\begin{enumerate}

   235

\item {\textmu}C must provide interruption masking, mutually excluding timer and CAN receive interrupts.\\

   236

   237

   238

   239

\begin{center}

   240

\includegraphics[width=12cm]{Pictures/10000201000003CA0000016604E6A5EF} 

   241

\par\end{center}

   242

   243

\item OS must provide a receive thread, a timer thread and a mutex. CAN

   244

reception should be a bloking operation.\\

   245

   246

   247

   248

\begin{center}

   249

\includegraphics[width=12cm]{Pictures/10000201000003F9000002CF8B0CDAEA} 

   250

\par\end{center}

   251

   252

\end{enumerate}

   253

   254

\subsection{CanFestival event scheduling}

   255

   256

A \canopen node must be able to take delayed actions.

   257

   258

For instance, periodic sync emission, heartbeat production or SDO timeout

   259

need to set some alarms that will be called later and do the job.

   260

   261

{\textmu}C generally do not have enough free timers to handle all

   262

the \canopen needs directly. Moreover, CanFestival internal data

   263

may be corrupt by reentrant calls.

   264

   265

CanFestival implement a micro -scheduler (timer.c). It uses only one

   266

timer to mimic many timers. It manage an alarm table, and call alarms

   267

at desired time.

   268

   269

\begin{center}

   270

\includegraphics[width=12cm]{Pictures/100000000000022C000000DEDAD2140C} 

   271

\par\end{center}

   272

   273

Scheduler can handle short clock value ranges limitation found on

   274

some {\textmu}C. As an example, value range for a 16bit clock counter

   275

with 4{\textmu}s tick is crossed within 0.26 seconds... Long alarms

   276

must be segmented.

   277

   278

Chronogram illustrate a long alarm (A) and a short periodic alarm

   279

(B), with a A value {\textgreater} clock range {\textgreater}

   280

B value. Values t0...t8 are successive setTimer call parameter values.

   281

t1 illustrates an intermediate call to TimeDispatch, caused by a delay

   282

longer than clock range. Because of long alarm segmentation, at the

   283

end of t1, TimeDispatch call will not trig any alarm callback.

   284

   285

\begin{center}

   286

\includegraphics[width=12cm]{Pictures/1000000000000396000000FFC42573DA} 

   287

\par\end{center}

   288

   289

   290

\section{Linux Target}

   291

   292

Linux target is default configure target.

   293

   294

   295

\subsection{Linux Compilation and installation}

   296

   297

Call ./configure -- help to see all available compile time options.

   298

   299

After invoking ./configure with your platform specific switches, just

   300

type make.

   301

   302

   303

   304

\begin{verbatim}

   305

	./configure [options]

   306

	make

   307

	make install

   308

\end{verbatim}

   309

   310

   311

   312

   313

\subsubsection{Standard Linux node}

   314

   315

   316

\begin{verbatim}

   317

	./configure --timers=unix

   318

\end{verbatim}

   319

   320

   321

To do a \canopen node running on PC -Linux, you need :

   322

   323

\begin{enumerate}

   324

\item A working linux distribution 

   325

\item One or more Peak system PC CAN interface and the last Peak Linux driver

   326

installed. 

   327

\end{enumerate}

   328

   329

\subsubsection{Real -Time Linux node}

   330

   331

   332

\begin{verbatim}

   333

	./configure --timers=xeno

   334

\end{verbatim}

   335

   336

   337

   338

To do a \canopen node running on PC -Linux, you need :

   339

   340

\begin{enumerate}

   341

\item A working Linux distribution patched with XENOMAI 2.1 or greater. 

   342

\item One or more Peak system PC CAN interface and the last Peak Real Time

   343

Linux driver installed. 

   344

\end{enumerate}

   345

   346

\subsubsection{Linux kernel node}

   347

   348

To do a CANopen node running on PC-Linux in kernel space, you need:

   349

   350

   351

\begin{enumerate}

   352

\item A working Linux distribution with pre-built 2.6.x.x kernel sources

   353

\item A CAN card driver compatible with CanFestival

   354

\end{enumerate}

   355

   356

   357

\subsubsection{CAN devices}

   358

   359

Currently supported CAN devices and corresponding configure switch:

   360

   361

   362

\paragraph{Peak systems}

   363

   364

   365

\begin{verbatim}

   366

	./configure --can=peak_linux

   367

\end{verbatim}

   368

   369

   370

PeakSystems CAN interface is automatically chosen as default CAN interface

   371

if libpcan is present in the system.

   372

   373

Please download driver at \href{http://www.peak-system.com/linux}{http://www.peak

   374

-system.com/linux} and follow instructions in order to install driver

   375

on your system.

   376

   377

   378

\paragraph{Socket -Can (http://socketcan.berlios.de)}

   379

   380

   381

\begin{verbatim}

   382

	./configure --can=socket

   383

\end{verbatim}

   384

   385

\paragraph{Serial}

   386

   387

   388

\begin{verbatim}

   389

	./configure --can=serial

   390

\end{verbatim}

   391

   392

The CAN serial driver implements a 1:1 serial connection between 2 CAN devices.

   393

For example, you can connect 2 CANFestival applications via a NULL modem cable.

   394

   395

Also with this driver comes a software hub, for up to 16 CANFestival apps to 

   396

be connected on a single PC, with an optional connection to another CAN driver.

   397

Note that only the serial driver is supported at this time.  The hub uses ptys 

   398

(pseudo ttys) available on a *nix like system.

   399

   400

   401

\paragraph{LinCan}

   402

   403

   404

\begin{verbatim}

   405

	./configure --can=lincan

   406

\end{verbatim}

   407

   408

   409

\paragraph{Virtual CAN interfaces (for test/debug)}

   410

   411

   412

\begin{verbatim}

   413

	./configure --can=virtual

   414

		or, for kernel space:

   415

	./configure --can=kernel_virtual

   416

\end{verbatim}

   417

   418

   419

Virtual CAN interface use Unix pipes to emulate a virtual CAN network.

   420

Each message issued from a node is repeat to all other nodes. Currently

   421

only works with nodes running in the same process, and does not support

   422

work with Xenomai.

   423

   424

   425

\subsection{Testing your CanFestival installation}

   426

   427

\subsection{User space}

   428

   429

Sample provided in /example/TestMasterSlave is installed into your

   430

system during installation.

   431

   432

   433

\begin{verbatim}

   434

	TestMasterSlave

   435

\end{verbatim}

   436

   437

   438

Default CAN driver library is libcanfestival\_can\_virtual.so., which

   439

will simply pass CAN messages through Unix pipes between Master and

   440

Slave.

   441

   442

You may also want to specify different can interface and define some

   443

CAN ports. Another example using Peak{\textquotesingle}s dual PCMCIA

   444

(configure and install with --can=peak) :

   445

   446

   447

\begin{verbatim}

   448

	TestMasterSlave -l libcanfestival_can_peak.so -s 40 -m 41

   449

\end{verbatim}

   450

   451

   452

\subsection{Kernel space}

   453

   454

   455

\begin{verbatim}

   456

	example/kerneltest

   457

\end{verbatim}

   458

   459

   460

It's based on TestMasterSlave example

   461

and has the same functionality. Uses virtual can driver as default

   462

too. After successful installation you can insert the module by typing:

   463

modprobe canf\_ktest Module control is done by simple console 'canf\_ktest\_console'

   464

which is used to start/stop sending data.

   465

   466

   467

\section{Windows Targets}

   468

   469

CanFestival can be compiled and run on Windows platform. It is possible

   470

to use both Cygwin and win32 native runtime environment.

   471

   472

\subsection{Object Dictionary Editor GUI installation.}

   473

   474

Please refer to \hyperlink{a821UsingDictionaryEditorGUIoutline}{8.2.1)Using

   475

Dictionary Editor GUI}

   476

   477

\subsection{CYGWIN}

   478

   479

\subsubsection{Requirements}

   480

   481

Cygwin have to be installed with those packages :

   482

   483

\begin{enumerate}

   484

\item gcc 

   485

\item unzip 

   486

\item wget 

   487

\item make 

   488

\end{enumerate}

   489

Currently, the only supported CAN devices are PeakSystems ones, with

   490

PcanLight driver and library.

   491

   492

Please download driver at \href{http://www.peak-system.com/themen/download_gb.html}{http://www.peak