canstat.h
Go to the documentation of this file.
1 /*
2  * Copyright 2023 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 
80 //
81 // Don't forget to update canGetErrorText in canlib.c if this is changed!
82 //
83 typedef enum {
88  canOK = 0,
119 
121 
147 
158 
187 
201 
208 
240  canERR_DISK = -35,
244  canERR_CRC = -36,
264 
269 
274 
279 
284 
290 
296 
302 
309 
315 
316  // The last entry - a dummy so we know where NOT to place a comma.
318 } canStatus;
325 #define CANSTATUS_SUCCESS(X) ((X) == canOK)
326 #define CANSTATUS_FAILURE(X) ((X) != canOK)
327 
335 #define canEVENT_RX 32000
336 #define canEVENT_TX 32001
337 #define canEVENT_ERROR 32002
338 #define canEVENT_STATUS 32003
339 
345 #define canEVENT_ENVVAR 32004
346 #define canEVENT_BUSONOFF 32005
347 
360 #define canNOTIFY_NONE 0
361 #define canNOTIFY_RX 0x0001
362 #define canNOTIFY_TX 0x0002
363 #define canNOTIFY_ERROR 0x0004
364 #define canNOTIFY_STATUS 0x0008
365 #define canNOTIFY_ENVVAR 0x0010
366 
367 #define canNOTIFY_BUSONOFF 0x0020
368 
387 #define canSTAT_ERROR_PASSIVE 0x00000001
388 #define canSTAT_BUS_OFF 0x00000002
389 #define canSTAT_ERROR_WARNING 0x00000004
390 #define canSTAT_ERROR_ACTIVE 0x00000008
391 #define canSTAT_TX_PENDING 0x00000010
392 #define canSTAT_RX_PENDING 0x00000020
393 #define canSTAT_RESERVED_1 0x00000040
394 #define canSTAT_TXERR 0x00000080
395 #define canSTAT_RXERR 0x00000100
396 #define canSTAT_HW_OVERRUN 0x00000200
397 #define canSTAT_SW_OVERRUN 0x00000400
398 #define canSTAT_OVERRUN (canSTAT_HW_OVERRUN | canSTAT_SW_OVERRUN)
399 
418 #define canMSG_MASK 0x00ff
419 #define canMSG_RTR 0x0001
420 
421 
426 #define canMSG_STD 0x0002
427 #define canMSG_EXT 0x0004
428 #define canMSG_WAKEUP 0x0008
429 
430 
448 #define canMSG_NERR 0x0010
449 #define canMSG_ERROR_FRAME 0x0020
450 #define canMSG_TXACK 0x0040
451 #define canMSG_TXRQ 0x0080
452 #define canMSG_DELAY_MSG 0x0100
453 
454 #define canMSG_LOCAL_TXACK 0x10000000
455 
456 // single shot flags:
457 #define canMSG_SINGLE_SHOT 0x1000000
458 #define canMSG_TXNACK 0x2000000
459 #define canMSG_ABL 0x4000000
460 
461 
471 #define canFDMSG_MASK 0xff0000
472 #define canFDMSG_EDL 0x010000
473 #define canFDMSG_FDF 0x010000
474 #define canFDMSG_BRS 0x020000
475 #define canFDMSG_ESI 0x040000
476 
490 #define canMSGERR_MASK 0xff00
491 // 0x0100 reserved
492 #define canMSGERR_HW_OVERRUN 0x0200
493 #define canMSGERR_SW_OVERRUN 0x0400
494 #define canMSGERR_STUFF 0x0800
495 #define canMSGERR_FORM 0x1000
496 #define canMSGERR_CRC 0x2000
497 #define canMSGERR_BIT0 0x4000
498 #define canMSGERR_BIT1 0x8000
499 
500 // Convenience values for the message error flags.
501 #define canMSGERR_OVERRUN 0x0600
502 #define canMSGERR_BIT 0xC000
503 #define canMSGERR_BUSERR 0xF800
504 
505 
507 #define canMSG_RESERVED_FOR_EXTENDING 0x80000000
508 
509 
520 #define canTRANSCEIVER_LINEMODE_NA 0
521 #define canTRANSCEIVER_LINEMODE_SWC_SLEEP 4
522 #define canTRANSCEIVER_LINEMODE_SWC_NORMAL 5
523 #define canTRANSCEIVER_LINEMODE_SWC_FAST 6
524 #define canTRANSCEIVER_LINEMODE_SWC_WAKEUP 7
525 #define canTRANSCEIVER_LINEMODE_SLEEP 8
526 #define canTRANSCEIVER_LINEMODE_NORMAL 9
527 #define canTRANSCEIVER_LINEMODE_STDBY 10
528 #define canTRANSCEIVER_LINEMODE_TT_CAN_H 11
529 #define canTRANSCEIVER_LINEMODE_TT_CAN_L 12
530 #define canTRANSCEIVER_LINEMODE_OEM1 13
531 #define canTRANSCEIVER_LINEMODE_OEM2 14
532 #define canTRANSCEIVER_LINEMODE_OEM3 15
533 #define canTRANSCEIVER_LINEMODE_OEM4 16
534 
535 
541 #define canTRANSCEIVER_RESNET_NA 0
542 #define canTRANSCEIVER_RESNET_MASTER 1
543 #define canTRANSCEIVER_RESNET_MASTER_STBY 2
544 #define canTRANSCEIVER_RESNET_SLAVE 3
545 
559 // Also see src\include\hwnames.h and registered document 048.
560 #define canTRANSCEIVER_TYPE_UNKNOWN 0
561 #define canTRANSCEIVER_TYPE_251 1
562 #define canTRANSCEIVER_TYPE_252 2
563 #define canTRANSCEIVER_TYPE_DNOPTO 3
564 #define canTRANSCEIVER_TYPE_W210 4
565 #define canTRANSCEIVER_TYPE_SWC_PROTO 5
566 #define canTRANSCEIVER_TYPE_SWC 6
567 #define canTRANSCEIVER_TYPE_EVA 7
568 #define canTRANSCEIVER_TYPE_FIBER 8
569 #define canTRANSCEIVER_TYPE_K251 9
570 #define canTRANSCEIVER_TYPE_K 10
571 #define canTRANSCEIVER_TYPE_1054_OPTO 11
572 #define canTRANSCEIVER_TYPE_SWC_OPTO 12
573 #define canTRANSCEIVER_TYPE_TT 13
574 #define canTRANSCEIVER_TYPE_1050 14
575 #define canTRANSCEIVER_TYPE_1050_OPTO 15
576 #define canTRANSCEIVER_TYPE_1041 16
577 #define canTRANSCEIVER_TYPE_1041_OPTO 17
578 #define canTRANSCEIVER_TYPE_RS485 18
579 #define canTRANSCEIVER_TYPE_LIN 19
580 #define canTRANSCEIVER_TYPE_KONE 20
581 #define canTRANSCEIVER_TYPE_CANFD 22
582 #define canTRANSCEIVER_TYPE_CANFD_LIN 24
583 #define canTRANSCEIVER_TYPE_CANFD_SIC 26
584 #define canTRANSCEIVER_TYPE_LINX_LIN 64
585 #define canTRANSCEIVER_TYPE_LINX_J1708 66
586 #define canTRANSCEIVER_TYPE_LINX_K 68
587 #define canTRANSCEIVER_TYPE_LINX_SWC 70
588 #define canTRANSCEIVER_TYPE_LINX_LS 72
589 
591 #endif
Definition: canstat.h:220
Definition: canstat.h:308
Definition: canstat.h:252
canStatus
Definition: canstat.h:83
Definition: canstat.h:164
Definition: canstat.h:88
Definition: canstat.h:130
Definition: canstat.h:108
Definition: canstat.h:283
Definition: canstat.h:176
Reserved.
Definition: canstat.h:157
Definition: canstat.h:273
Operation not supported by hardware or firmware.
Definition: canstat.h:183
Definition: canstat.h:192
Definition: canstat.h:139
Definition: canstat.h:197
Definition: canstat.h:213
Definition: canstat.h:244
Reserved.
Definition: canstat.h:317
Definition: canstat.h:248
Reserved.
Definition: canstat.h:185
Definition: canstat.h:278
Definition: canstat.h:156
Definition: canstat.h:94
Definition: canstat.h:182
Definition: canstat.h:263
Reserved.
Definition: canstat.h:200
Definition: canstat.h:268
The license is not valid.
Definition: canstat.h:207
Error in the ini-file (16-bit only)
Definition: canstat.h:146
Definition: canstat.h:118
Definition: canstat.h:112
Definition: canstat.h:301
Definition: canstat.h:230
Definition: canstat.h:225
Definition: canstat.h:295
Reserved.
Definition: canstat.h:186
Definition: canstat.h:240
Definition: canstat.h:145
Definition: canstat.h:235
Definition: canstat.h:125
Definition: canstat.h:206
Definition: canstat.h:99
Interrupted by signals.
Definition: canstat.h:120
Reserved.
Definition: canstat.h:184
Definition: canstat.h:170
Definition: canstat.h:151
The card was removed or not inserted.
Definition: canstat.h:199
Definition: canstat.h:289
Definition: canstat.h:314
Can&#39;t find req&#39;d config s/w (e.g. CS/SS)
Definition: canstat.h:198