canstat.h
Go to the documentation of this file.
1 /*
2  * Copyright 2017 by Kvaser AB, Molndal, Sweden
3  * http://www.kvaser.com
4  *
5  * This software is dual licensed under the following two licenses:
6  * BSD-new and GPLv2. You may use either one. See the included
7  * COPYING file for details.
8  *
9  * License: BSD-new
10  * ==============================================================================
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  * * Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  * * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  * * Neither the name of the <organization> nor the
19  * names of its contributors may be used to endorse or promote products
20  * derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
29  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
30  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  *
35  * License: GPLv2
36  * ==============================================================================
37  * This program is free software; you can redistribute it and/or modify
38  * it under the terms of the GNU General Public License as published by
39  * the Free Software Foundation; either version 2 of the License, or
40  * (at your option) any later version.
41  *
42  * This program is distributed in the hope that it will be useful,
43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45  * GNU General Public License for more details.
46  *
47  * You should have received a copy of the GNU General Public License
48  * along with this program; if not, write to the Free Software
49  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
50  *
51  *
52  * IMPORTANT NOTICE:
53  * ==============================================================================
54  * This source code is made available for free, as an open license, by Kvaser AB,
55  * for use with its applications. Kvaser AB does not accept any liability
56  * whatsoever for any third party patent or other immaterial property rights
57  * violations that may result from any usage of this source code, regardless of
58  * the combination of source code and various applications that it can be used
59  * in, or with.
60  *
61  * -----------------------------------------------------------------------------
62  */
63 
64 #ifndef _CANSTAT_H_
65 #define _CANSTAT_H_
66 
81 //
82 // Don't forget to update canGetErrorText in canlib.c if this is changed!
83 //
84 typedef enum {
89  canOK = 0,
120 
122 
148 
159 
188 
202 
209 
241  canERR_DISK = -35,
245  canERR_CRC = -36,
265 
270 
275 
280 
285 
286  // The last entry - a dummy so we know where NOT to place a comma.
288 } canStatus;
295 #define CANSTATUS_SUCCESS(X) ((X) == canOK)
296 #define CANSTATUS_FAILURE(X) ((X) != canOK)
297 
305 #define canEVENT_RX 32000
306 #define canEVENT_TX 32001
307 #define canEVENT_ERROR 32002
308 #define canEVENT_STATUS 32003
309 #define canEVENT_ENVVAR 32004
310 
323 #define canNOTIFY_NONE 0
324 #define canNOTIFY_RX 0x0001
325 #define canNOTIFY_TX 0x0002
326 #define canNOTIFY_ERROR 0x0004
327 #define canNOTIFY_STATUS 0x0008
328 #define canNOTIFY_ENVVAR 0x0010
329 
348 #define canSTAT_ERROR_PASSIVE 0x00000001
349 #define canSTAT_BUS_OFF 0x00000002
350 #define canSTAT_ERROR_WARNING 0x00000004
351 #define canSTAT_ERROR_ACTIVE 0x00000008
352 #define canSTAT_TX_PENDING 0x00000010
353 #define canSTAT_RX_PENDING 0x00000020
354 #define canSTAT_RESERVED_1 0x00000040
355 #define canSTAT_TXERR 0x00000080
356 #define canSTAT_RXERR 0x00000100
357 #define canSTAT_HW_OVERRUN 0x00000200
358 #define canSTAT_SW_OVERRUN 0x00000400
359 #define canSTAT_OVERRUN (canSTAT_HW_OVERRUN | canSTAT_SW_OVERRUN)
360 
379 #define canMSG_MASK 0x00ff
380 #define canMSG_RTR 0x0001
381 #define canMSG_STD 0x0002
382 #define canMSG_EXT 0x0004
383 #define canMSG_WAKEUP 0x0008
384 
385 
403 #define canMSG_NERR 0x0010
404 #define canMSG_ERROR_FRAME 0x0020
405 #define canMSG_TXACK 0x0040
406 #define canMSG_TXRQ 0x0080
407 #define canMSG_DELAY_MSG 0x0100
408 
409 // single shot flags:
410 #define canMSG_SINGLE_SHOT 0x1000000
411 #define canMSG_TXNACK 0x2000000
412 #define canMSG_ABL 0x4000000
413 
414 
424 #define canFDMSG_MASK 0xff0000
425 #define canFDMSG_EDL 0x010000
426 #define canFDMSG_FDF 0x010000
427 #define canFDMSG_BRS 0x020000
428 #define canFDMSG_ESI 0x040000
429 
443 #define canMSGERR_MASK 0xff00
444 // 0x0100 reserved
445 #define canMSGERR_HW_OVERRUN 0x0200
446 #define canMSGERR_SW_OVERRUN 0x0400
447 #define canMSGERR_STUFF 0x0800
448 #define canMSGERR_FORM 0x1000
449 #define canMSGERR_CRC 0x2000
450 #define canMSGERR_BIT0 0x4000
451 #define canMSGERR_BIT1 0x8000
452 
453 // Convenience values for the message error flags.
454 #define canMSGERR_OVERRUN 0x0600
455 #define canMSGERR_BIT 0xC000
456 #define canMSGERR_BUSERR 0xF800
457 
458 
471 #define canTRANSCEIVER_LINEMODE_NA 0
472 #define canTRANSCEIVER_LINEMODE_SWC_SLEEP 4
473 #define canTRANSCEIVER_LINEMODE_SWC_NORMAL 5
474 #define canTRANSCEIVER_LINEMODE_SWC_FAST 6
475 #define canTRANSCEIVER_LINEMODE_SWC_WAKEUP 7
476 #define canTRANSCEIVER_LINEMODE_SLEEP 8
477 #define canTRANSCEIVER_LINEMODE_NORMAL 9
478 #define canTRANSCEIVER_LINEMODE_STDBY 10
479 #define canTRANSCEIVER_LINEMODE_TT_CAN_H 11
480 #define canTRANSCEIVER_LINEMODE_TT_CAN_L 12
481 #define canTRANSCEIVER_LINEMODE_OEM1 13
482 #define canTRANSCEIVER_LINEMODE_OEM2 14
483 #define canTRANSCEIVER_LINEMODE_OEM3 15
484 #define canTRANSCEIVER_LINEMODE_OEM4 16
485 
486 
492 #define canTRANSCEIVER_RESNET_NA 0
493 #define canTRANSCEIVER_RESNET_MASTER 1
494 #define canTRANSCEIVER_RESNET_MASTER_STBY 2
495 #define canTRANSCEIVER_RESNET_SLAVE 3
496 
510 // Also see src\include\hwnames.h and registered document 048.
511 #define canTRANSCEIVER_TYPE_UNKNOWN 0
512 #define canTRANSCEIVER_TYPE_251 1
513 #define canTRANSCEIVER_TYPE_252 2
514 #define canTRANSCEIVER_TYPE_DNOPTO 3
515 #define canTRANSCEIVER_TYPE_W210 4
516 #define canTRANSCEIVER_TYPE_SWC_PROTO 5
517 #define canTRANSCEIVER_TYPE_SWC 6
518 #define canTRANSCEIVER_TYPE_EVA 7
519 #define canTRANSCEIVER_TYPE_FIBER 8
520 #define canTRANSCEIVER_TYPE_K251 9
521 #define canTRANSCEIVER_TYPE_K 10
522 #define canTRANSCEIVER_TYPE_1054_OPTO 11
523 #define canTRANSCEIVER_TYPE_SWC_OPTO 12
524 #define canTRANSCEIVER_TYPE_TT 13
525 #define canTRANSCEIVER_TYPE_1050 14
526 #define canTRANSCEIVER_TYPE_1050_OPTO 15
527 #define canTRANSCEIVER_TYPE_1041 16
528 #define canTRANSCEIVER_TYPE_1041_OPTO 17
529 #define canTRANSCEIVER_TYPE_RS485 18
530 #define canTRANSCEIVER_TYPE_LIN 19
531 #define canTRANSCEIVER_TYPE_KONE 20
532 #define canTRANSCEIVER_TYPE_CANFD 22
533 #define canTRANSCEIVER_TYPE_CANFD_LIN 24
534 #define canTRANSCEIVER_TYPE_LINX_LIN 64
535 #define canTRANSCEIVER_TYPE_LINX_J1708 66
536 #define canTRANSCEIVER_TYPE_LINX_K 68
537 #define canTRANSCEIVER_TYPE_LINX_SWC 70
538 #define canTRANSCEIVER_TYPE_LINX_LS 72
539 
541 #endif
Can&#39;t find req&#39;d config s/w (e.g. CS/SS)
Definition: canstat.h:199
Definition: canstat.h:249
Definition: canstat.h:109
Reserved.
Definition: canstat.h:186
Definition: canstat.h:126
Operation not supported by hardware or firmware.
Definition: canstat.h:184
Reserved.
Definition: canstat.h:287
Definition: canstat.h:157
Definition: canstat.h:152
Definition: canstat.h:264
Reserved.
Definition: canstat.h:187
Definition: canstat.h:183
Definition: canstat.h:193
Reserved.
Definition: canstat.h:201
Definition: canstat.h:236
Definition: canstat.h:231
Definition: canstat.h:226
Definition: canstat.h:146
Definition: canstat.h:221
Definition: canstat.h:113
Definition: canstat.h:274
The card was removed or not inserted.
Definition: canstat.h:200
Definition: canstat.h:95
Reserved.
Definition: canstat.h:185
Reserved.
Definition: canstat.h:158
Definition: canstat.h:207
Definition: canstat.h:100
Definition: canstat.h:177
Definition: canstat.h:269
canStatus
Definition: canstat.h:84
Definition: canstat.h:241
Definition: canstat.h:253
The license is not valid.
Definition: canstat.h:208
Definition: canstat.h:171
Interrupted by signals.
Definition: canstat.h:121
Definition: canstat.h:279
Definition: canstat.h:198
Definition: canstat.h:131
Error in the ini-file (16-bit only)
Definition: canstat.h:147
Definition: canstat.h:245
Definition: canstat.h:140
Definition: canstat.h:284
Definition: canstat.h:89
Definition: canstat.h:165
Definition: canstat.h:214
Definition: canstat.h:119