canlib.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 
156 #ifndef _CANLIB_H_
157 #define _CANLIB_H_
158 
159 #include <stdlib.h>
160 
161 #include <stdint.h>
162 
163 #include "canstat.h"
164 
166 typedef int canHandle;
167 
168 # define canINVALID_HANDLE (-1)
169 
170 
172 
173 typedef struct canNotifyData {
174  void *tag;
176  union {
177  struct {
178  unsigned long time;
179  } busErr;
180  struct {
181  long id;
182  unsigned long time;
183  } rx;
184  struct {
185  long id;
186  unsigned long time;
187  } tx;
188  struct {
189  unsigned char busStatus;
190  unsigned char txErrorCounter;
191  unsigned char rxErrorCounter;
192  unsigned long time;
193  } status;
194  } info;
195 } canNotifyData;
196 
197 
207 // The canWANT_xxx names are also obsolete, use canOPEN_xxx instead for new developments.
208 #define canWANT_EXCLUSIVE 0x0008
209 #define canWANT_EXTENDED 0x0010
210 #define canWANT_VIRTUAL 0x0020
211 
224 #define canOPEN_EXCLUSIVE 0x0008
225 
237 #define canOPEN_REQUIRE_EXTENDED 0x0010
238 
246 # define canOPEN_ACCEPT_VIRTUAL 0x0020
247 
256 # define canOPEN_OVERRIDE_EXCLUSIVE 0x0040
257 
274 # define canOPEN_REQUIRE_INIT_ACCESS 0x0080
275 
287 # define canOPEN_NO_INIT_ACCESS 0x0100
288 
300 # define canOPEN_ACCEPT_LARGE_DLC 0x0200 // DLC can be greater than 8
301 
308 # define canOPEN_CAN_FD 0x0400
309 
323 # define canOPEN_CAN_FD_NONISO 0x0800
324 
325 
329 # define canOPEN_INTERNAL_L 0x1000
330 
342 #define canFILTER_ACCEPT 1
343 #define canFILTER_REJECT 2
344 
345 #define canFILTER_SET_CODE_STD 3
346 
347 #define canFILTER_SET_MASK_STD 4
348 
349 #define canFILTER_SET_CODE_EXT 5
350 
351 #define canFILTER_SET_MASK_EXT 6
352 
353 #define canFILTER_NULL_MASK 0L
354 
370 #define canDRIVER_NORMAL 4
371 
378 #define canDRIVER_SILENT 1
379 
383 #define canDRIVER_SELFRECEPTION 8
384 
388 #define canDRIVER_OFF 0
389 
412 #define canBITRATE_1M (-1)
413 
414 #define canBITRATE_500K (-2)
415 
416 #define canBITRATE_250K (-3)
417 
418 #define canBITRATE_125K (-4)
419 
420 #define canBITRATE_100K (-5)
421 
422 #define canBITRATE_62K (-6)
423 
424 #define canBITRATE_50K (-7)
425 
426 #define canBITRATE_83K (-8)
427 
428 #define canBITRATE_10K (-9)
429 
430 // CAN FD Bit Rates
434 #define canFD_BITRATE_500K_80P (-1000)
435 
438 #define canFD_BITRATE_1M_80P (-1001)
439 
442 #define canFD_BITRATE_2M_80P (-1002)
443 
446 #define canFD_BITRATE_2M_60P (-1007)
447 
450 #define canFD_BITRATE_4M_80P (-1003)
451 
454 #define canFD_BITRATE_8M_60P (-1004)
455 
458 #define canFD_BITRATE_8M_80P (-1005)
459 
462 #define canFD_BITRATE_8M_70P (-1006)
463 
465 #define BAUD_1M (-1)
466 
467 #define BAUD_500K (-2)
468 
469 #define BAUD_250K (-3)
470 
471 #define BAUD_125K (-4)
472 
473 #define BAUD_100K (-5)
474 
475 #define BAUD_62K (-6)
476 
477 #define BAUD_50K (-7)
478 
479 #define BAUD_83K (-8)
480 
483 //
484 // Define CANLIBAPI unless it's done already.
485 // (canlib.c provides its own definitions of CANLIBAPI, DLLIMPORT
486 // and DLLEXPORT before including this file.)
487 //
488 #ifndef CANLIBAPI
489 # define CANLIBAPI
490 #endif /* CANLIBAPI */
491 
492 
493 #ifdef __cplusplus
494 extern "C" {
495 #endif /* __cplusplus */
496 
518 void CANLIBAPI canInitializeLibrary (void);
519 
541 canStatus CANLIBAPI canEnumHardwareEx (int *channelCount);
542 
567 canStatus CANLIBAPI canClose (const CanHandle hnd);
568 
593 canStatus CANLIBAPI canBusOn (const CanHandle hnd);
594 
615 canStatus CANLIBAPI canBusOff (const CanHandle hnd);
616 
666 canStatus CANLIBAPI canSetBusParams (const CanHandle hnd,
667  long freq,
668  unsigned int tseg1,
669  unsigned int tseg2,
670  unsigned int sjw,
671  unsigned int noSamp,
672  unsigned int syncmode);
673 
703 typedef struct kvBusParamsTq {
704  int tq;
705  int phase1;
706  int phase2;
707  int sjw;
708  int prop;
709  int prescaler;
710 } kvBusParamsTq;
711 
737  canStatus CANLIBAPI canSetBusParamsTq(const CanHandle hnd,
738  const kvBusParamsTq nominal);
739 
773 canStatus CANLIBAPI canSetBusParamsFd (const CanHandle hnd,
774  long freq_brs,
775  unsigned int tseg1_brs,
776  unsigned int tseg2_brs,
777  unsigned int sjw_brs);
778 
805 canStatus CANLIBAPI canSetBusParamsFdTq(const CanHandle hnd,
806  const kvBusParamsTq arbitration,
807  const kvBusParamsTq data);
808 
809 
841 canStatus CANLIBAPI canGetBusParams (const CanHandle hnd,
842  long *freq,
843  unsigned int *tseg1,
844  unsigned int *tseg2,
845  unsigned int *sjw,
846  unsigned int *noSamp,
847  unsigned int *syncmode);
848 
868 canStatus CANLIBAPI canGetBusParamsTq(const CanHandle hnd,
869  kvBusParamsTq *nominal);
870 
893 canStatus CANLIBAPI canGetBusParamsFd(const CanHandle hnd,
894  long *freq_brs,
895  unsigned int *tseg1_brs,
896  unsigned int *tseg2_brs,
897  unsigned int *sjw_brs);
898 
919 canStatus CANLIBAPI canGetBusParamsFdTq(const CanHandle hnd,
920  kvBusParamsTq *nominal,
921  kvBusParamsTq *data);
922 
947 canStatus CANLIBAPI canSetBusOutputControl (const CanHandle hnd,
948  const unsigned int drivertype);
949 
984 canStatus CANLIBAPI canGetBusOutputControl (const CanHandle hnd,
985  unsigned int *drivertype);
986 
1029 canStatus CANLIBAPI canAccept (const CanHandle hnd,
1030  const long envelope,
1031  const unsigned int flag);
1032 
1056 canStatus CANLIBAPI canReadStatus (const CanHandle hnd,
1057  unsigned long *const flags);
1058 
1095 canStatus CANLIBAPI canReadErrorCounters (const CanHandle hnd,
1096  unsigned int *txErr,
1097  unsigned int *rxErr,
1098  unsigned int *ovErr);
1099 
1141 canStatus CANLIBAPI canWrite (const CanHandle hnd,
1142  long id,
1143  void *msg,
1144  unsigned int dlc,
1145  unsigned int flag);
1146 
1174 canStatus CANLIBAPI canWriteSync (const CanHandle hnd, unsigned long timeout);
1175 
1229 canStatus CANLIBAPI canRead (const CanHandle hnd,
1230  long *id,
1231  void *msg,
1232  unsigned int *dlc,
1233  unsigned int *flag,
1234  unsigned long *time);
1287 canStatus CANLIBAPI canReadWait (const CanHandle hnd,
1288  long *id,
1289  void *msg,
1290  unsigned int *dlc,
1291  unsigned int *flag,
1292  unsigned long *time,
1293  unsigned long timeout);
1294 
1346 canStatus CANLIBAPI canReadSpecific (const CanHandle hnd, long id, void * msg,
1347  unsigned int * dlc, unsigned int * flag,
1348  unsigned long * time);
1349 
1380 canStatus CANLIBAPI canReadSync (const CanHandle hnd, unsigned long timeout);
1381 
1413 canStatus CANLIBAPI canReadSyncSpecific (const CanHandle hnd,
1414  long id,
1415  unsigned long timeout);
1416 
1462 canStatus CANLIBAPI canReadSpecificSkip (const CanHandle hnd,
1463  long id,
1464  void * msg,
1465  unsigned int * dlc,
1466  unsigned int * flag,
1467  unsigned long * time);
1468 
1489 canStatus CANLIBAPI canSetNotify (const CanHandle hnd,
1490  void (*callback)(canNotifyData *),
1491  unsigned int notifyFlags,
1492  void *tag);
1493 
1507 canStatus CANLIBAPI canGetRawHandle (const CanHandle hnd, void *pvFd);
1508 
1543 canStatus CANLIBAPI canTranslateBaud (long *const freq,
1544  unsigned int *const tseg1,
1545  unsigned int *const tseg2,
1546  unsigned int *const sjw,
1547  unsigned int *const nosamp,
1548  unsigned int *const syncMode);
1549 
1572 canStatus CANLIBAPI kvBitrateToBusParamsTq (const canHandle hnd,
1573  int freq,
1574  kvBusParamsTq *nominal);
1575 
1601 canStatus CANLIBAPI kvBitrateToBusParamsFdTq (const canHandle hnd,
1602  int freqA,
1603  int freqD,
1604  kvBusParamsTq *arbitration,
1605  kvBusParamsTq *data);
1606 
1629 canStatus CANLIBAPI canGetErrorText (canStatus err, char *buf, unsigned int bufsiz);
1630 
1660 unsigned short CANLIBAPI canGetVersion (void);
1661 
1690 canStatus CANLIBAPI canIoCtl (const CanHandle hnd,
1691  unsigned int func,
1692  void *buf,
1693  unsigned int buflen);
1694 
1695 
1701 canStatus CANLIBAPI canReadTimer (const CanHandle hnd, unsigned long *time);
1702 
1753 CanHandle CANLIBAPI canOpenChannel (int channel, int flags);
1754 
1775 canStatus CANLIBAPI canGetNumberOfChannels (int *channelCount);
1776 
1777 
1785 #define kvREMOTE_TYPE_NOT_REMOTE 0
1786 #define kvREMOTE_TYPE_WLAN 1
1787 #define kvREMOTE_TYPE_LAN 2
1788 
1797 #define kvLOGGER_TYPE_NOT_A_LOGGER 0
1798 #define kvLOGGER_TYPE_V1 1
1799 #define kvLOGGER_TYPE_V2 2
1800 
1833 canStatus CANLIBAPI canGetChannelData (int channel,
1834  int item,
1835  void *buffer,
1836  size_t bufsize);
1837 
1856 #define canCHANNELDATA_CHANNEL_CAP 1
1857 
1867 #define canCHANNELDATA_TRANS_CAP 2
1868 
1877 #define canCHANNELDATA_CHANNEL_FLAGS 3 // available, etc
1878 
1887 #define canCHANNELDATA_CARD_TYPE 4
1888 
1898 #define canCHANNELDATA_CARD_NUMBER 5
1899 
1907 #define canCHANNELDATA_CHAN_NO_ON_CARD 6
1908 
1918 #define canCHANNELDATA_CARD_SERIAL_NO 7
1919 
1929 #define canCHANNELDATA_TRANS_SERIAL_NO 8
1930 
1941 #define canCHANNELDATA_CARD_FIRMWARE_REV 9
1942 
1953 #define canCHANNELDATA_CARD_HARDWARE_REV 10
1954 
1964 #define canCHANNELDATA_CARD_UPC_NO 11
1965 
1976 #define canCHANNELDATA_TRANS_UPC_NO 12
1977 
1995 #define canCHANNELDATA_CHANNEL_NAME 13
1996 
2012 # define canCHANNELDATA_DLL_FILE_VERSION 14
2013 
2029 # define canCHANNELDATA_DLL_PRODUCT_VERSION 15
2030 
2046 # define canCHANNELDATA_DLL_FILETYPE 16
2047 
2056 # define canCHANNELDATA_TRANS_TYPE 17
2057 
2081 # define canCHANNELDATA_DEVICE_PHYSICAL_POSITION 18
2082 
2095 # define canCHANNELDATA_UI_NUMBER 19
2096 
2120 # define canCHANNELDATA_TIMESYNC_ENABLED 20
2121 
2136 # define canCHANNELDATA_DRIVER_FILE_VERSION 21
2137 
2152 # define canCHANNELDATA_DRIVER_PRODUCT_VERSION 22
2153 
2162 # define canCHANNELDATA_MFGNAME_UNICODE 23
2163 
2171 # define canCHANNELDATA_MFGNAME_ASCII 24
2172 
2181 # define canCHANNELDATA_DEVDESCR_UNICODE 25
2182 
2190 # define canCHANNELDATA_DEVDESCR_ASCII 26
2191 
2202 # define canCHANNELDATA_DRIVER_NAME 27
2203 
2216 # define canCHANNELDATA_CHANNEL_QUALITY 28
2217 
2226 # define canCHANNELDATA_ROUNDTRIP_TIME 29
2227 
2236 # define canCHANNELDATA_BUS_TYPE 30
2237 
2250 # define canCHANNELDATA_DEVNAME_ASCII 31
2251 
2262 # define canCHANNELDATA_TIME_SINCE_LAST_SEEN 32
2263 
2273 # define canCHANNELDATA_REMOTE_OPERATIONAL_MODE 33
2274 
2283 # define canCHANNELDATA_REMOTE_PROFILE_NAME 34
2284 
2293 # define canCHANNELDATA_REMOTE_HOST_NAME 35
2294 
2303 # define canCHANNELDATA_REMOTE_MAC 36
2304 
2313 # define canCHANNELDATA_MAX_BITRATE 37
2314 
2325 # define canCHANNELDATA_CHANNEL_CAP_MASK 38
2326 
2338 #define canCHANNELDATA_CUST_CHANNEL_NAME 39
2339 
2349 # define canCHANNELDATA_IS_REMOTE 40
2350 
2359 # define canCHANNELDATA_REMOTE_TYPE 41
2360 
2369 # define canCHANNELDATA_LOGGER_TYPE 42
2370 
2380 # define canCHANNELDATA_HW_STATUS 43
2381 
2391 # define canCHANNELDATA_FEATURE_EAN 44
2392 
2399 #define canCHANNELDATA_BUS_PARAM_LIMITS 45
2400 
2407 #define canCHANNELDATA_CLOCK_INFO 46
2408 
2429 #define canCHANNELDATA_CHANNEL_CAP_EX 47
2430 
2443 typedef struct kvClockInfo {
2444  int version;
2449 }kvClockInfo;
2450 
2465 typedef struct kvBusParamLimits {
2466  int version;
2472 
2483 #define canCHANNEL_IS_EXCLUSIVE 0x0001
2484 
2486 #define canCHANNEL_IS_OPEN 0x0002
2487 
2490 #define canCHANNEL_IS_CANFD 0x0004
2491 
2492 //#define canCHANNEL_IS_CANFD_NON_ISO 0x0008 Reserved for when needed
2493 
2496 #define canCHANNEL_IS_LIN 0x0010
2497 
2500 #define canCHANNEL_IS_LIN_MASTER 0x0020
2501 
2504 #define canCHANNEL_IS_LIN_SLAVE 0x0040
2505 
2506 
2525 #define canHWTYPE_NONE 0
2526 #define canHWTYPE_VIRTUAL 1
2527 #define canHWTYPE_LAPCAN 2
2528 #define canHWTYPE_CANPARI 3
2529 #define canHWTYPE_PCCAN 8
2530 #define canHWTYPE_PCICAN 9
2531 #define canHWTYPE_USBCAN 11
2532 #define canHWTYPE_PCICAN_II 40
2533 #define canHWTYPE_USBCAN_II 42
2534 #define canHWTYPE_SIMULATED 44
2535 #define canHWTYPE_ACQUISITOR 46
2536 #define canHWTYPE_LEAF 48
2537 #define canHWTYPE_PC104_PLUS 50
2538 #define canHWTYPE_PCICANX_II 52
2539 #define canHWTYPE_MEMORATOR_II 54
2540 #define canHWTYPE_MEMORATOR_PRO 54
2541 #define canHWTYPE_USBCAN_PRO 56
2542 #define canHWTYPE_IRIS 58
2543 #define canHWTYPE_BLACKBIRD 58
2544 #define canHWTYPE_MEMORATOR_LIGHT 60
2545 #define canHWTYPE_MINIHYDRA 62
2546 #define canHWTYPE_EAGLE 62
2547 #define canHWTYPE_BAGEL 64
2548 #define canHWTYPE_BLACKBIRD_V2 64
2549 #define canHWTYPE_MINIPCIE 66
2550 #define canHWTYPE_USBCAN_KLINE 68
2551 #define canHWTYPE_ETHERCAN 70
2552 #define canHWTYPE_USBCAN_LIGHT 72
2553 #define canHWTYPE_USBCAN_PRO2 74
2554 #define canHWTYPE_PCIE_V2 76
2555 #define canHWTYPE_MEMORATOR_PRO2 78
2556 #define canHWTYPE_LEAF2 80
2557 #define canHWTYPE_MEMORATOR_V2 82
2558 #define canHWTYPE_CANLINHYBRID 84
2559 #define canHWTYPE_DINRAIL 86
2560 #define canHWTYPE_U100 88
2561 
2562 
2571 #define canCHANNEL_CAP_EXTENDED_CAN 0x00000001L
2572 #define canCHANNEL_CAP_BUS_STATISTICS 0x00000002L
2573 #define canCHANNEL_CAP_ERROR_COUNTERS 0x00000004L
2574 #define canCHANNEL_CAP_RESERVED_2 0x00000008L
2575 #define canCHANNEL_CAP_GENERATE_ERROR 0x00000010L
2576 #define canCHANNEL_CAP_GENERATE_OVERLOAD 0x00000020L
2577 #define canCHANNEL_CAP_TXREQUEST 0x00000040L
2578 #define canCHANNEL_CAP_TXACKNOWLEDGE 0x00000080L
2579 #define canCHANNEL_CAP_VIRTUAL 0x00010000L
2580 #define canCHANNEL_CAP_SIMULATED 0x00020000L
2581 #define canCHANNEL_CAP_RESERVED_1 0x00040000L
2582 #define canCHANNEL_CAP_CAN_FD 0x00080000L
2583 #define canCHANNEL_CAP_CAN_FD_NONISO 0x00100000L
2584 #define canCHANNEL_CAP_SILENT_MODE 0x00200000L
2585 #define canCHANNEL_CAP_SINGLE_SHOT 0x00400000L
2586 #define canCHANNEL_CAP_LOGGER 0x00800000L
2587 #define canCHANNEL_CAP_REMOTE_ACCESS 0x01000000L
2588 #define canCHANNEL_CAP_SCRIPT 0x02000000L
2589 #define canCHANNEL_CAP_LIN_HYBRID 0x04000000L
2590 #define canCHANNEL_CAP_IO_API 0x08000000L
2591 #define canCHANNEL_CAP_CANTEGRITY 0x10000000L
2592 
2593 
2599 #define canCHANNEL_CAP_EX_BUSPARAMS_TQ 0x0000000000000001L
2600 
2601 
2613 #define canCHANNEL_OPMODE_NONE 1
2614 
2618 #define canCHANNEL_OPMODE_INFRASTRUCTURE 2
2619 
2623 #define canCHANNEL_OPMODE_RESERVED 3
2624 
2628 #define canCHANNEL_OPMODE_ADHOC 4
2629 
2639 #define canDRIVER_CAP_HIGHSPEED 0x00000001L
2640 
2666 #define canIOCTL_PREFER_EXT 1
2667 
2680 #define canIOCTL_PREFER_STD 2
2681 
2698 #define canIOCTL_CLEAR_ERROR_COUNTERS 5
2699 
2713 #define canIOCTL_SET_TIMER_SCALE 6
2714 
2734 #define canIOCTL_SET_TXACK 7
2735 
2748 #define canIOCTL_GET_RX_BUFFER_LEVEL 8
2749 
2762 #define canIOCTL_GET_TX_BUFFER_LEVEL 9
2763 
2773 #define canIOCTL_FLUSH_RX_BUFFER 10
2774 
2784 #define canIOCTL_FLUSH_TX_BUFFER 11
2785 
2794 #define canIOCTL_GET_TIMER_SCALE 12
2795 
2811 #define canIOCTL_SET_TXRQ 13
2812 
2813 
2820 #define canIOCTL_SET_BYPASS_MODE 15
2821 
2827 #define canIOCTL_SET_WAKEUP 16
2828 
2838 # define canIOCTL_GET_DRIVERHANDLE 17
2839 
2845 # define canIOCTL_MAP_RXQUEUE 18
2846 
2852 # define canIOCTL_GET_WAKEUP 19
2853 
2865 # define canIOCTL_SET_REPORT_ACCESS_ERRORS 20
2866 
2874 # define canIOCTL_GET_REPORT_ACCESS_ERRORS 21
2875 
2885 # define canIOCTL_CONNECT_TO_VIRTUAL_BUS 22
2886 
2896 # define canIOCTL_DISCONNECT_FROM_VIRTUAL_BUS 23
2897 
2907 # define canIOCTL_SET_USER_IOPORT 24
2908 
2919 # define canIOCTL_GET_USER_IOPORT 25
2920 
2926 # define canIOCTL_SET_BUFFER_WRAPAROUND_MODE 26
2927 
2944 # define canIOCTL_SET_RX_QUEUE_SIZE 27
2945 
2951 # define canIOCTL_SET_USB_THROTTLE 28
2952 
2958 # define canIOCTL_GET_USB_THROTTLE 29
2959 
2974 # define canIOCTL_SET_BUSON_TIME_AUTO_RESET 30
2975 
2987 # define canIOCTL_GET_TXACK 31
2988 
3003 # define canIOCTL_SET_LOCAL_TXECHO 32
3004 
3020 # define canIOCTL_SET_ERROR_FRAMES_REPORTING 33
3021 
3035 # define canIOCTL_GET_CHANNEL_QUALITY 34
3036 
3048 # define canIOCTL_GET_ROUNDTRIP_TIME 35
3049 
3058 # define canIOCTL_GET_BUS_TYPE 36
3059 
3072 # define canIOCTL_GET_DEVNAME_ASCII 37
3073 
3085 # define canIOCTL_GET_TIME_SINCE_LAST_SEEN 38
3086 
3100 # define canIOCTL_GET_TREF_LIST 39
3101 
3123 # define canIOCTL_TX_INTERVAL 40
3124 
3136 # define canIOCTL_SET_BRLIMIT 43
3137 
3143 # define canIOCTL_SET_USB_THROTTLE_SCALED 41
3144 
3159 # define canIOCTL_SET_THROTTLE_SCALED 41
3160 
3166 # define canIOCTL_GET_USB_THROTTLE_SCALED 42
3167 
3182 # define canIOCTL_GET_THROTTLE_SCALED 42
3183 
3191 # define canIOCTL_RESET_OVERRUN_COUNT 44
3192 
3201 # define canIOCTL_LIN_MODE 45
3202 
3203 
3219 # define canIOCTL_SET_LOCAL_TXACK 46
3220 
3223 typedef struct {
3224  unsigned int portNo;
3225  unsigned int portValue;
3227 
3228 
3269 canStatus CANLIBAPI canSetBusParamsC200 (const CanHandle hnd, unsigned char btr0, unsigned char btr1);
3270 
3271 
3272 
3308 canStatus CANLIBAPI canSetDriverMode (const CanHandle hnd, int lineMode, int resNet);
3309 
3346 canStatus CANLIBAPI canGetDriverMode (const CanHandle hnd, int *lineMode, int *resNet);
3347 
3367 #define canVERSION_CANLIB32_VERSION 0
3368 
3379 #define canVERSION_CANLIB32_PRODVER 1
3380 
3392 #define canVERSION_CANLIB32_PRODVER32 2
3393 
3404 #define canVERSION_CANLIB32_BETA 3
3405 
3425 unsigned int CANLIBAPI canGetVersionEx (unsigned int itemCode);
3426 
3427 
3447 canStatus CANLIBAPI canObjBufFreeAll (const CanHandle hnd);
3448 
3469 canStatus CANLIBAPI canObjBufAllocate (const CanHandle hnd, int type);
3470 
3479 #define canOBJBUF_TYPE_AUTO_RESPONSE 0x01
3480 #define canOBJBUF_TYPE_PERIODIC_TX 0x02
3481 
3503 canStatus CANLIBAPI canObjBufFree (const CanHandle hnd, int idx);
3504 
3505 // Writes CAN data to the object buffer with the specified index.
3506 
3532 canStatus CANLIBAPI canObjBufWrite (const CanHandle hnd,
3533  int idx,
3534  int id,
3535  void* msg,
3536  unsigned int dlc,
3537  unsigned int flags);
3538 
3564 canStatus CANLIBAPI canObjBufSetFilter (const CanHandle hnd,
3565  int idx,
3566  unsigned int code,
3567  unsigned int mask);
3568 
3589 canStatus CANLIBAPI canObjBufSetFlags (const CanHandle hnd,
3590  int idx,
3591  unsigned int flags);
3592 
3610 # define canOBJBUF_AUTO_RESPONSE_RTR_ONLY 0x01
3611 
3633 canStatus CANLIBAPI canObjBufSetPeriod (const CanHandle hnd,
3634  int idx,
3635  unsigned int period);
3636 
3657 canStatus CANLIBAPI canObjBufSetMsgCount (const CanHandle hnd,
3658  int idx,
3659  unsigned int count);
3660 
3680 canStatus CANLIBAPI canObjBufEnable (const CanHandle hnd, int idx);
3681 
3701 canStatus CANLIBAPI canObjBufDisable (const CanHandle hnd, int idx);
3702 
3726 canStatus CANLIBAPI canObjBufSendBurst (const CanHandle hnd,
3727  int idx,
3728  unsigned int burstlen);
3729 
3730 
3753 canStatus CANLIBAPI canResetBus (const CanHandle hnd);
3754 
3795 canStatus CANLIBAPI canWriteWait (const CanHandle hnd,
3796  long id,
3797  void *msg,
3798  unsigned int dlc,
3799  unsigned int flag,
3800  unsigned long timeout);
3801 
3802 
3828 canStatus CANLIBAPI canUnloadLibrary (void);
3829 
3891 canStatus CANLIBAPI canSetAcceptanceFilter (const CanHandle hnd,
3892  unsigned int code,
3893  unsigned int mask,
3894  int is_extended);
3918 canStatus CANLIBAPI canFlushReceiveQueue (const CanHandle hnd);
3919 
3944 canStatus CANLIBAPI canFlushTransmitQueue (const CanHandle hnd);
3945 
3946 
3955 #define kvLED_ACTION_ALL_LEDS_ON 0
3956 #define kvLED_ACTION_ALL_LEDS_OFF 1
3957 #define kvLED_ACTION_LED_0_ON 2
3958 #define kvLED_ACTION_LED_0_OFF 3
3959 #define kvLED_ACTION_LED_1_ON 4
3960 #define kvLED_ACTION_LED_1_OFF 5
3961 #define kvLED_ACTION_LED_2_ON 6
3962 #define kvLED_ACTION_LED_2_OFF 7
3963 #define kvLED_ACTION_LED_3_ON 8
3964 #define kvLED_ACTION_LED_3_OFF 9
3965 #define kvLED_ACTION_LED_4_ON 10
3966 #define kvLED_ACTION_LED_4_OFF 11
3967 #define kvLED_ACTION_LED_5_ON 12
3968 #define kvLED_ACTION_LED_5_OFF 13
3969 #define kvLED_ACTION_LED_6_ON 14
3970 #define kvLED_ACTION_LED_6_OFF 15
3971 #define kvLED_ACTION_LED_7_ON 16
3972 #define kvLED_ACTION_LED_7_OFF 17
3973 #define kvLED_ACTION_LED_8_ON 18
3974 #define kvLED_ACTION_LED_8_OFF 19
3975 #define kvLED_ACTION_LED_9_ON 20
3976 #define kvLED_ACTION_LED_9_OFF 21
3977 #define kvLED_ACTION_LED_10_ON 22
3978 #define kvLED_ACTION_LED_10_OFF 23
3979 #define kvLED_ACTION_LED_11_ON 24
3980 #define kvLED_ACTION_LED_11_OFF 25
3981 
3982 
4005 canStatus CANLIBAPI kvFlashLeds (const CanHandle hnd, int action, int timeout);
4006 
4026 canStatus CANLIBAPI canRequestChipStatus (const CanHandle hnd);
4027 
4054 canStatus CANLIBAPI canRequestBusStatistics (const CanHandle hnd);
4055 
4061 typedef struct canBusStatistics_s {
4062  unsigned long stdData;
4063  unsigned long stdRemote;
4064  unsigned long extData;
4065  unsigned long extRemote;
4066  unsigned long errFrame;
4067 
4072  unsigned long busLoad;
4073  unsigned long overruns;
4075 
4098 canStatus CANLIBAPI canGetBusStatistics (const CanHandle hnd,
4099  canBusStatistics *stat,
4100  size_t bufsiz);
4101 
4102 
4123 canStatus CANLIBAPI kvAnnounceIdentityEx (const CanHandle hnd,
4124  int type,
4125  void *buf,
4126  size_t bufsiz);
4127 
4149 canStatus CANLIBAPI canGetHandleData (const CanHandle hnd,
4150  int item,
4151  void *buffer,
4152  size_t bufsize);
4153 
4155 typedef void *kvTimeDomain;
4156 
4159 
4164 typedef struct kvTimeDomainData_s {
4170 
4199 kvStatus CANLIBAPI kvTimeDomainCreate (kvTimeDomain *domain);
4200 
4223 kvStatus CANLIBAPI kvTimeDomainDelete (kvTimeDomain domain);
4224 
4250 kvStatus CANLIBAPI kvTimeDomainResetTime (kvTimeDomain domain);
4251 
4276 kvStatus CANLIBAPI kvTimeDomainGetData (kvTimeDomain domain,
4277  kvTimeDomainData *data,
4278  size_t bufsiz);
4279 
4302 kvStatus CANLIBAPI kvTimeDomainAddHandle(kvTimeDomain domain,
4303  const CanHandle hnd);
4304 
4326 kvStatus CANLIBAPI kvTimeDomainRemoveHandle (kvTimeDomain domain,
4327  const CanHandle hnd);
4328 
4346 typedef void (CANLIBAPI *kvCallback_t) (CanHandle hnd, void* context, unsigned int notifyEvent);
4380 kvStatus CANLIBAPI kvSetNotifyCallback (const CanHandle hnd,
4381  kvCallback_t callback,
4382  void* context,
4383  unsigned int notifyFlags);
4384 
4398 #define kvBUSTYPE_NONE 0
4399 
4404 #define kvBUSTYPE_PCI 1
4405 
4410 #define kvBUSTYPE_PCMCIA 2
4411 
4416 #define kvBUSTYPE_USB 3
4417 
4422 #define kvBUSTYPE_WLAN 4
4423 
4428 #define kvBUSTYPE_PCI_EXPRESS 5
4429 
4434 #define kvBUSTYPE_ISA 6
4435 
4440 #define kvBUSTYPE_VIRTUAL 7
4441 
4446 #define kvBUSTYPE_PC104_PLUS 8
4447 
4452 #define kvBUSTYPE_LAN 9
4453 
4469 #define kvBUSTYPE_GROUP_VIRTUAL 1
4470 
4475 #define kvBUSTYPE_GROUP_LOCAL 2
4476 
4481 #define kvBUSTYPE_GROUP_REMOTE 3
4482 
4486 #define kvBUSTYPE_GROUP_INTERNAL 4
4487 
4541 kvStatus CANLIBAPI kvGetSupportedInterfaceInfo (int index,
4542  char *hwName,
4543  size_t nameLen,
4544  int *hwType,
4545  int *hwBusType);
4546 
4571 kvStatus CANLIBAPI kvReadDeviceCustomerData (const CanHandle hnd,
4572  int userNumber,
4573  int itemNumber,
4574  void *data,
4575  size_t bufsiz);
4576 
4590 #define kvENVVAR_TYPE_INT 1
4591 
4597 #define kvENVVAR_TYPE_FLOAT 2
4598 
4604 #define kvENVVAR_TYPE_STRING 3
4605 
4621 #define kvEVENT_TYPE_KEY 1
4622 
4630  typedef int64_t kvEnvHandle;
4631 
4651 kvStatus CANLIBAPI kvScriptStart (const CanHandle hnd, int slotNo);
4652 
4659 #define kvSCRIPT_STOP_NORMAL 0
4660 #define kvSCRIPT_STOP_FORCED -9
4684 kvStatus CANLIBAPI kvScriptStop (const CanHandle hnd, int slotNo, int mode);
4685 
4705 kvStatus CANLIBAPI kvScriptUnload (const CanHandle hnd, int slotNo);
4706 
4731 kvStatus CANLIBAPI kvScriptSendEvent (const CanHandle hnd,
4732  int slotNo,
4733  int eventType,
4734  int eventNo,
4735  unsigned int data);
4736 
4761 kvEnvHandle CANLIBAPI kvScriptEnvvarOpen (const CanHandle hnd,
4762  const char* envvarName,
4763  int *envvarType,
4764  int *envvarSize); // returns scriptHandle
4765 
4783 kvStatus CANLIBAPI kvScriptEnvvarClose (kvEnvHandle eHnd);
4784 
4805 kvStatus CANLIBAPI kvScriptEnvvarSetInt (kvEnvHandle eHnd, int val);
4806 
4828 kvStatus CANLIBAPI kvScriptEnvvarGetInt (kvEnvHandle eHnd, int *val);
4829 
4852 kvStatus CANLIBAPI kvScriptEnvvarSetFloat (kvEnvHandle eHnd, float val);
4853 
4877 kvStatus CANLIBAPI kvScriptEnvvarGetFloat (kvEnvHandle eHnd, float *val);
4878 
4905 kvStatus CANLIBAPI kvScriptEnvvarSetData (kvEnvHandle eHnd,
4906  const void *buf,
4907  int start_index,
4908  int data_len);
4909 
4935 kvStatus CANLIBAPI kvScriptEnvvarGetData (kvEnvHandle eHnd,
4936  void *buf,
4937  int start_index,
4938  int data_len);
4939 
4963 kvStatus CANLIBAPI kvScriptLoadFileOnDevice (const CanHandle hnd,
4964  int slotNo,
4965  char *localFile);
4966 
4995 kvStatus CANLIBAPI kvScriptLoadFile (const CanHandle hnd,
4996  int slotNo,
4997  char *filePathOnPC);
4998 
4999 
5013 #define kvSCRIPT_REQUEST_TEXT_UNSUBSCRIBE 1
5014 
5018 #define kvSCRIPT_REQUEST_TEXT_SUBSCRIBE 2
5019 
5023 #define kvSCRIPT_REQUEST_TEXT_ALL_SLOTS 255
5024 
5048 kvStatus CANLIBAPI kvScriptRequestText(const CanHandle hnd,
5049  unsigned int slot,
5050  unsigned int request);
5051 
5052 
5053 
5076 kvStatus CANLIBAPI kvScriptGetText(const CanHandle hnd,
5077  int *slot,
5078  unsigned long *time,
5079  unsigned int *flags,
5080  char *buf,
5081  size_t bufsize);
5082 
5089 #define kvSCRIPT_STATUS_LOADED 1
5090 #define kvSCRIPT_STATUS_RUNNING 2
5111 kvStatus CANLIBAPI kvScriptStatus(const CanHandle hnd,
5112  int slot,
5113  unsigned int *status);
5114 
5115 
5134 kvStatus CANLIBAPI kvScriptGetMaxEnvvarSize(int hnd, int *envvarSize);
5135 
5166 kvStatus CANLIBAPI kvScriptTxeGetData(const char *filePathOnPC,
5167  int item,
5168  void *buffer,
5169  unsigned int *bufsize);
5170 
5196 #define canTXEDATA_FILE_VERSION 1
5197 
5213 #define canTXEDATA_COMPILER_VERSION 2
5214 
5233 #define canTXEDATA_DATE 3
5234 
5245 #define canTXEDATA_DESCRIPTION 4
5246 
5260 #define canTXEDATA_SOURCE 5
5261 
5271 #define canTXEDATA_SIZE_OF_CODE 6
5272 
5282 #define canTXEDATA_IS_ENCRYPTED 7
5283 
5284 
5311 kvStatus CANLIBAPI kvFileCopyToDevice (const CanHandle hnd,
5312  char *hostFileName,
5313  char *deviceFileName);
5314 
5337 kvStatus CANLIBAPI kvFileCopyFromDevice (const CanHandle hnd,
5338  char *deviceFileName,
5339  char *hostFileName);
5340 
5362 kvStatus CANLIBAPI kvFileDelete (const CanHandle hnd, char *deviceFileName);
5363 
5386 kvStatus CANLIBAPI kvFileGetName (const CanHandle hnd,
5387  int fileNo,
5388  char *name,
5389  int namelen);
5390 
5410 kvStatus CANLIBAPI kvFileGetCount (const CanHandle hnd, int *count);
5411 
5434 kvStatus CANLIBAPI kvFileGetSystemData (const CanHandle hnd,
5435  int itemCode,
5436  int *result);
5437 
5456 kvStatus CANLIBAPI kvFileDiskFormat(const CanHandle hnd);
5457 
5475 #define kvDEVICE_MODE_INTERFACE 0x00
5476 
5481 #define kvDEVICE_MODE_LOGGER 0x01
5482 
5507 kvStatus CANLIBAPI kvDeviceSetMode (const CanHandle hnd, int mode);
5508 
5531 kvStatus CANLIBAPI kvDeviceGetMode (const CanHandle hnd, int *result);
5532 
5533 
5558 kvStatus CANLIBAPI kvReadTimer (const CanHandle hnd, unsigned int *time);
5582 kvStatus CANLIBAPI kvReadTimer64 (const CanHandle hnd, uint64_t *time);
5583 
5600 #define kvIO_INFO_GET_MODULE_TYPE 1
5601 
5607 #define kvIO_INFO_GET_DIRECTION 2
5608 
5614 #define kvIO_INFO_GET_PIN_TYPE 4
5615 
5621 #define kvIO_INFO_GET_NUMBER_OF_BITS 5
5622 
5630 #define kvIO_INFO_GET_RANGE_MIN 6
5631 
5639 #define kvIO_INFO_GET_RANGE_MAX 7
5640 
5648 #define kvIO_INFO_GET_DI_LOW_HIGH_FILTER 8
5649 
5657 #define kvIO_INFO_GET_DI_HIGH_LOW_FILTER 9
5658 
5666 #define kvIO_INFO_GET_AI_LP_FILTER_ORDER 10
5667 
5676 #define kvIO_INFO_GET_AI_HYSTERESIS 11
5677 
5683 #define kvIO_INFO_GET_MODULE_NUMBER 14
5684 
5690 #define kvIO_INFO_GET_SERIAL_NUMBER 15
5691 
5699 #define kvIO_INFO_GET_FW_VERSION 16
5700 
5721 #define kvIO_INFO_SET_DI_LOW_HIGH_FILTER 8
5722 
5730 #define kvIO_INFO_SET_DI_HIGH_LOW_FILTER 9
5731 
5739 #define kvIO_INFO_SET_AI_LP_FILTER_ORDER 10
5740 
5749 #define kvIO_INFO_SET_AI_HYSTERESIS 11
5750 
5767 #define kvIO_MODULE_TYPE_DIGITAL 1
5768 
5772 #define kvIO_MODULE_TYPE_ANALOG 2
5773 
5777 #define kvIO_MODULE_TYPE_RELAY 3
5778 
5782 #define kvIO_MODULE_TYPE_INTERNAL 4
5783 
5798 #define kvIO_PIN_TYPE_DIGITAL 1
5799 
5803 #define kvIO_PIN_TYPE_ANALOG 2
5804 
5808 #define kvIO_PIN_TYPE_RELAY 3
5809 
5824 #define kvIO_PIN_DIRECTION_IN 4
5825 
5829 #define kvIO_PIN_DIRECTION_OUT 8
5830 
5852 canStatus CANLIBAPI kvIoGetNumberOfPins (const CanHandle hnd, unsigned int *pinCount);
5853 
5870 canStatus CANLIBAPI kvIoConfirmConfig (const CanHandle hnd);
5871 
5891 canStatus CANLIBAPI kvIoPinGetInfo (const CanHandle hnd, unsigned int pin, int item, void *buffer, const unsigned int bufsize);
5892 
5912 canStatus CANLIBAPI kvIoPinSetInfo (const CanHandle hnd, unsigned int pin, int item, const void *buffer, const unsigned int bufsize);
5913 
5931 canStatus CANLIBAPI kvIoPinSetDigital (const CanHandle hnd, unsigned int pin, unsigned int value);
5932 
5952 canStatus CANLIBAPI kvIoPinGetDigital (const CanHandle hnd, unsigned int pin, unsigned int *value);
5953 
5975 canStatus CANLIBAPI kvIoPinGetOutputDigital (const CanHandle hnd, unsigned int pin, unsigned int *value);
5976 
5994 canStatus CANLIBAPI kvIoPinSetRelay (const CanHandle hnd, unsigned int pin, unsigned int value);
5995 
6015 canStatus CANLIBAPI kvIoPinGetOutputRelay (const CanHandle hnd, unsigned int pin, unsigned int *value);
6016 
6034 canStatus CANLIBAPI kvIoPinSetAnalog (const CanHandle hnd, unsigned int pin, float value);
6035 
6053 canStatus CANLIBAPI kvIoPinGetAnalog (const CanHandle hnd, unsigned int pin, float* value);
6054 
6074 canStatus CANLIBAPI kvIoPinGetOutputAnalog (const CanHandle hnd, unsigned int pin, float* value);
6075 
6081 typedef struct {
6082  int type;
6083  unsigned char DO1 : 1;
6084  unsigned char DO2 : 1;
6085  unsigned char DO3 : 1;
6086  unsigned char DO4 : 1;
6087  unsigned char DO5 : 1;
6088  unsigned char DO6 : 1;
6089  unsigned char DO7 : 1;
6090  unsigned char DO8 : 1;
6091  unsigned char DO9 : 1;
6092  unsigned char DO10: 1;
6093  unsigned char DO11: 1;
6094  unsigned char DO12: 1;
6095  unsigned char DO13: 1;
6096  unsigned char DO14: 1;
6097  unsigned char DO15: 1;
6098  unsigned char DO16: 1;
6099  unsigned char DI1 : 1;
6100  unsigned char DI2 : 1;
6101  unsigned char DI3 : 1;
6102  unsigned char DI4 : 1;
6103  unsigned char DI5 : 1;
6104  unsigned char DI6 : 1;
6105  unsigned char DI7 : 1;
6106  unsigned char DI8 : 1;
6107  unsigned char DI9 : 1;
6108  unsigned char DI10: 1;
6109  unsigned char DI11: 1;
6110  unsigned char DI12: 1;
6111  unsigned char DI13: 1;
6112  unsigned char DI14: 1;
6113  unsigned char DI15: 1;
6114  unsigned char DI16: 1;
6116 
6117 
6123 typedef struct {
6124  int type;
6125  unsigned char DO: 1;
6126  unsigned char DI: 1;
6128 
6129 
6136 typedef struct {
6137  int type;
6138  unsigned char RO1 : 1;
6139  unsigned char RO2 : 1;
6140  unsigned char RO3 : 1;
6141  unsigned char RO4 : 1;
6142  unsigned char RO5 : 1;
6143  unsigned char RO6 : 1;
6144  unsigned char RO7 : 1;
6145  unsigned char RO8 : 1;
6146  unsigned char DI1 : 1;
6147  unsigned char DI2 : 1;
6148  unsigned char DI3 : 1;
6149  unsigned char DI4 : 1;
6150  unsigned char DI5 : 1;
6151  unsigned char DI6 : 1;
6152  unsigned char DI7 : 1;
6153  unsigned char DI8 : 1;
6154 } kvIoModuleRelay;
6155 
6162 typedef struct {
6163  int type;
6164  float AO1;
6165  float AO2;
6166  float AO3;
6167  float AO4;
6168  float AI1;
6169  float AI2;
6170  float AI3;
6171  float AI4;
6173 
6174 
6197 canStatus CANLIBAPI kvIoGetModulePins (const CanHandle hnd, unsigned int module, void *buffer, const unsigned int bufsize);
6198 
6199 
6223 canStatus CANLIBAPI kvIoSetModulePins (const CanHandle hnd, unsigned int module, const void *buffer, const unsigned int bufsize);
6224 
6225 
6226 #ifdef __cplusplus
6227 }
6228 #endif /* __cplusplus */
6229 
6230 #include "obsolete.h"
6231 
6232 #endif /* _CANLIB_H_ */
struct kvClockInfo kvClockInfo
Definitions which are retained for compatibility.
unsigned char DI10
Definition: canlib.h:6108
kvStatus kvScriptEnvvarGetFloat(kvEnvHandle eHnd, float *val)
int phase1
Definition: canlib.h:705
unsigned long stdRemote
Number of received standard (11-bit identifiers) remote frames.
Definition: canlib.h:4063
unsigned char DI5
Definition: canlib.h:6103
canStatus canGetBusParamsFd(const CanHandle hnd, long *freq_brs, unsigned int *tseg1_brs, unsigned int *tseg2_brs, unsigned int *sjw_brs)
canStatus canWriteSync(const CanHandle hnd, unsigned long timeout)
kvStatus kvFileGetSystemData(const CanHandle hnd, int itemCode, int *result)
unsigned char busStatus
Definition: canlib.h:189
unsigned char DI12
Definition: canlib.h:6110
unsigned char RO3
Definition: canlib.h:6140
canStatus canGetBusOutputControl(const CanHandle hnd, unsigned int *drivertype)
kvStatus kvTimeDomainDelete(kvTimeDomain domain)
float AI2
Definition: canlib.h:6169
unsigned char DI8
Definition: canlib.h:6106
canStatus canGetDriverMode(const CanHandle hnd, int *lineMode, int *resNet)
struct canNotifyData::@0::@2 rx
unsigned char DO15
Definition: canlib.h:6097
void canInitializeLibrary(void)
canStatus canGetBusParamsFdTq(const CanHandle hnd, kvBusParamsTq *nominal, kvBusParamsTq *data)
canStatus kvIoPinGetInfo(const CanHandle hnd, unsigned int pin, int item, void *buffer, const unsigned int bufsize)
unsigned char DO8
Definition: canlib.h:6090
canStatus canReadStatus(const CanHandle hnd, unsigned long *const flags)
kvStatus kvTimeDomainCreate(kvTimeDomain *domain)
unsigned char DI9
Definition: canlib.h:6107
unsigned int portNo
Port number used in e.g. canIOCTL_SET_USER_IOPORT.
Definition: canlib.h:3224
int64_t kvEnvHandle
Definition: canlib.h:4630
int accuracy_ppm
Definition: canlib.h:2448
int nNonMagiSyncCards
number of non MagiSync™ interfaces
Definition: canlib.h:4167
unsigned char RO2
Definition: canlib.h:6139
canStatus kvIoGetNumberOfPins(const CanHandle hnd, unsigned int *pinCount)
canStatus canRequestBusStatistics(const CanHandle hnd)
kvStatus kvDeviceSetMode(const CanHandle hnd, int mode)
void * kvTimeDomain
Definition: canlib.h:4155
unsigned char DI7
Definition: canlib.h:6105
unsigned char DO
Definition: canlib.h:6125
unsigned char rxErrorCounter
Definition: canlib.h:191
unsigned char DO2
Definition: canlib.h:6084
unsigned long extRemote
Number of received extended (29-bit identifiers) remote frames.
Definition: canlib.h:4065
canStatus canClose(const CanHandle hnd)
unsigned char RO5
Definition: canlib.h:6142
int power_of_ten
Definition: canlib.h:2447
kvStatus kvFileGetCount(const CanHandle hnd, int *count)
struct canNotifyData canNotifyData
canStatus canTranslateBaud(long *const freq, unsigned int *const tseg1, unsigned int *const tseg2, unsigned int *const sjw, unsigned int *const nosamp, unsigned int *const syncMode)
int type
Definition: canlib.h:6163
canStatus canObjBufSetMsgCount(const CanHandle hnd, int idx, unsigned int count)
canStatus kvFlashLeds(const CanHandle hnd, int action, int timeout)
canStatus canSetAcceptanceFilter(const CanHandle hnd, unsigned int code, unsigned int mask, int is_extended)
unsigned char DI13
Definition: canlib.h:6111
int canHandle
Definition: canlib.h:166
unsigned char DI14
Definition: canlib.h:6112
unsigned char DI1
Definition: canlib.h:6146
canStatus canObjBufDisable(const CanHandle hnd, int idx)
void * tag
Definition: canlib.h:174
unsigned char RO4
Definition: canlib.h:6141
canStatus canGetBusParams(const CanHandle hnd, long *freq, unsigned int *tseg1, unsigned int *tseg2, unsigned int *sjw, unsigned int *noSamp, unsigned int *syncmode)
float AI3
Definition: canlib.h:6170
kvStatus kvScriptEnvvarGetInt(kvEnvHandle eHnd, int *val)
Definitions for the CANLIB API.
kvStatus kvScriptGetMaxEnvvarSize(int hnd, int *envvarSize)
Definition: canlib.h:6136
Definition: canlib.h:6081
canStatus kvIoPinSetInfo(const CanHandle hnd, unsigned int pin, int item, const void *buffer, const unsigned int bufsize)
kvStatus kvFileGetName(const CanHandle hnd, int fileNo, char *name, int namelen)
Definition: canlib.h:6162
canStatus canSetBusOutputControl(const CanHandle hnd, const unsigned int drivertype)
int tq
Definition: canlib.h:704
int type
Definition: canlib.h:6137
Definition: canlib.h:2465
int type
Definition: canlib.h:6082
int eventType
Definition: canlib.h:175
float AO3
Definition: canlib.h:6166
canStatus kvIoPinSetRelay(const CanHandle hnd, unsigned int pin, unsigned int value)
canStatus kvIoPinGetDigital(const CanHandle hnd, unsigned int pin, unsigned int *value)
int type
Definition: canlib.h:6124
kvStatus kvScriptEnvvarSetInt(kvEnvHandle eHnd, int val)
canStatus canObjBufSendBurst(const CanHandle hnd, int idx, unsigned int burstlen)
canStatus canGetRawHandle(const CanHandle hnd, void *pvFd)
canStatus kvIoPinGetOutputAnalog(const CanHandle hnd, unsigned int pin, float *value)
unsigned int canGetVersionEx(unsigned int itemCode)
unsigned char RO8
Definition: canlib.h:6145
canStatus canBusOn(const CanHandle hnd)
Definition: canlib.h:6123
long id
Definition: canlib.h:181
unsigned char DI
Definition: canlib.h:6126
int sjw
Definition: canlib.h:707
canStatus canWriteWait(const CanHandle hnd, long id, void *msg, unsigned int dlc, unsigned int flag, unsigned long timeout)
canStatus kvIoSetModulePins(const CanHandle hnd, unsigned int module, const void *buffer, const unsigned int bufsize)
kvStatus kvReadDeviceCustomerData(const CanHandle hnd, int userNumber, int itemNumber, void *data, size_t bufsiz)
canStatus canWrite(const CanHandle hnd, long id, void *msg, unsigned int dlc, unsigned int flag)
unsigned char DI3
Definition: canlib.h:6148
canStatus canObjBufWrite(const CanHandle hnd, int idx, int id, void *msg, unsigned int dlc, unsigned int flags)
kvEnvHandle kvScriptEnvvarOpen(const CanHandle hnd, const char *envvarName, int *envvarType, int *envvarSize)
Definition: canlib.h:173
struct kvTimeDomainData_s kvTimeDomainData
kvStatus kvScriptTxeGetData(const char *filePathOnPC, int item, void *buffer, unsigned int *bufsize)
struct kvBusParamsTq kvBusParamsTq
kvStatus kvScriptEnvvarClose(kvEnvHandle eHnd)
Definition: canlib.h:2443
canStatus canFlushReceiveQueue(const CanHandle hnd)
canStatus kvIoGetModulePins(const CanHandle hnd, unsigned int module, void *buffer, const unsigned int bufsize)
kvStatus kvScriptLoadFile(const CanHandle hnd, int slotNo, char *filePathOnPC)
float AI4
Definition: canlib.h:6171
unsigned int portValue
Port value used in e.g. canIOCTL_SET_USER_IOPORT.
Definition: canlib.h:3225
kvBusParamsTq arbitration_max
Definition: canlib.h:2468
unsigned short canGetVersion(void)
unsigned char DI1
Definition: canlib.h:6099
unsigned char DI2
Definition: canlib.h:6100
int phase2
Definition: canlib.h:706
unsigned long errFrame
Number of error frames.
Definition: canlib.h:4066
int prop
Definition: canlib.h:708
canStatus kvIoPinSetAnalog(const CanHandle hnd, unsigned int pin, float value)
canStatus canReadWait(const CanHandle hnd, long *id, void *msg, unsigned int *dlc, unsigned int *flag, unsigned long *time, unsigned long timeout)
canStatus canReadSyncSpecific(const CanHandle hnd, long id, unsigned long timeout)
float AO4
Definition: canlib.h:6167
canStatus canFlushTransmitQueue(const CanHandle hnd)
kvStatus kvReadTimer64(const CanHandle hnd, uint64_t *time)
canStatus kvBitrateToBusParamsTq(const canHandle hnd, int freq, kvBusParamsTq *nominal)
unsigned char DO10
Definition: canlib.h:6092
kvStatus kvTimeDomainResetTime(kvTimeDomain domain)
unsigned char DO3
Definition: canlib.h:6085
kvBusParamsTq data_min
Definition: canlib.h:2469
canStatus canAccept(const CanHandle hnd, const long envelope, const unsigned int flag)
CanHandle canOpenChannel(int channel, int flags)
kvStatus kvScriptEnvvarSetFloat(kvEnvHandle eHnd, float val)
unsigned long extData
Number of received extended (29-bit identifiers) data frames.
Definition: canlib.h:4064
float AO1
Definition: canlib.h:6164
Definition: canlib.h:703
kvStatus kvReadTimer(const CanHandle hnd, unsigned int *time)
canStatus canObjBufEnable(const CanHandle hnd, int idx)
int denominator
Definition: canlib.h:2446
kvStatus kvScriptRequestText(const CanHandle hnd, unsigned int slot, unsigned int request)
kvStatus kvSetNotifyCallback(const CanHandle hnd, kvCallback_t callback, void *context, unsigned int notifyFlags)
unsigned char DO16
Definition: canlib.h:6098
kvStatus kvScriptSendEvent(const CanHandle hnd, int slotNo, int eventType, int eventNo, unsigned int data)
canStatus kvBitrateToBusParamsFdTq(const canHandle hnd, int freqA, int freqD, kvBusParamsTq *arbitration, kvBusParamsTq *data)
kvStatus kvTimeDomainGetData(kvTimeDomain domain, kvTimeDomainData *data, size_t bufsiz)
kvStatus kvScriptStart(const CanHandle hnd, int slotNo)
kvStatus kvTimeDomainRemoveHandle(kvTimeDomain domain, const CanHandle hnd)
kvStatus kvFileCopyFromDevice(const CanHandle hnd, char *deviceFileName, char *hostFileName)
unsigned char DO4
Definition: canlib.h:6086
unsigned char DI8
Definition: canlib.h:6153
unsigned char DI6
Definition: canlib.h:6104
canStatus canSetNotify(const CanHandle hnd, void(*callback)(canNotifyData *), unsigned int notifyFlags, void *tag)
unsigned char txErrorCounter
Definition: canlib.h:190
canStatus kvIoPinGetAnalog(const CanHandle hnd, unsigned int pin, float *value)
unsigned char DO1
Definition: canlib.h:6083
canStatus canSetBusParamsFdTq(const CanHandle hnd, const kvBusParamsTq arbitration, const kvBusParamsTq data)
canStatus canObjBufSetFlags(const CanHandle hnd, int idx, unsigned int flags)
kvStatus kvFileDelete(const CanHandle hnd, char *deviceFileName)
unsigned char RO7
Definition: canlib.h:6144
unsigned char RO1
Definition: canlib.h:6138
unsigned char DI16
Definition: canlib.h:6114
kvBusParamsTq arbitration_min
Definition: canlib.h:2467
unsigned char DI5
Definition: canlib.h:6150
void(* kvCallback_t)(CanHandle hnd, void *context, unsigned int notifyEvent)
Definition: canlib.h:4346
int prescaler
Definition: canlib.h:709
canStatus canSetBusParamsC200(const CanHandle hnd, unsigned char btr0, unsigned char btr1)
int nMagiSyncGroups
number of MagiSync™ groups
Definition: canlib.h:4165
canStatus canReadSpecificSkip(const CanHandle hnd, long id, void *msg, unsigned int *dlc, unsigned int *flag, unsigned long *time)
kvStatus kvScriptGetText(const CanHandle hnd, int *slot, unsigned long *time, unsigned int *flags, char *buf, size_t bufsize)
struct canBusStatistics_s canBusStatistics
canStatus canSetBusParamsFd(const CanHandle hnd, long freq_brs, unsigned int tseg1_brs, unsigned int tseg2_brs, unsigned int sjw_brs)
canStatus
Definition: canstat.h:84
unsigned char DI11
Definition: canlib.h:6109
struct kvBusParamLimits kvBusParamLimits
kvStatus kvDeviceGetMode(const CanHandle hnd, int *result)
canStatus kvIoPinGetOutputDigital(const CanHandle hnd, unsigned int pin, unsigned int *value)
unsigned char RO6
Definition: canlib.h:6143
canStatus canReadErrorCounters(const CanHandle hnd, unsigned int *txErr, unsigned int *rxErr, unsigned int *ovErr)
canStatus kvIoConfirmConfig(const CanHandle hnd)
unsigned long stdData
Number of received standard (11-bit identifiers) data frames.
Definition: canlib.h:4062
canStatus canSetDriverMode(const CanHandle hnd, int lineMode, int resNet)
unsigned long overruns
The number of overruns detected by the hardware, firmware or driver.
Definition: canlib.h:4073
kvStatus kvTimeDomainAddHandle(kvTimeDomain domain, const CanHandle hnd)
kvStatus kvFileCopyToDevice(const CanHandle hnd, char *hostFileName, char *deviceFileName)
Definition: canlib.h:4164
unsigned char DI3
Definition: canlib.h:6101
canStatus canReadTimer(const CanHandle hnd, unsigned long *time)
unsigned char DO7
Definition: canlib.h:6089
canStatus kvIoPinSetDigital(const CanHandle hnd, unsigned int pin, unsigned int value)
unsigned char DI4
Definition: canlib.h:6102
canStatus canGetBusStatistics(const CanHandle hnd, canBusStatistics *stat, size_t bufsiz)
canStatus canBusOff(const CanHandle hnd)
canStatus canReadSpecific(const CanHandle hnd, long id, void *msg, unsigned int *dlc, unsigned int *flag, unsigned long *time)
float AI1
Definition: canlib.h:6168
canStatus canGetErrorText(canStatus err, char *buf, unsigned int bufsiz)
kvBusParamsTq data_max
Definition: canlib.h:2470
unsigned long busLoad
Definition: canlib.h:4072
unsigned char DI7
Definition: canlib.h:6152
unsigned char DO13
Definition: canlib.h:6095
canStatus canRequestChipStatus(const CanHandle hnd)
int version
Definition: canlib.h:2444
Definition: canlib.h:4061
canStatus canEnumHardwareEx(int *channelCount)
unsigned char DI4
Definition: canlib.h:6149
kvStatus kvScriptLoadFileOnDevice(const CanHandle hnd, int slotNo, char *localFile)
canStatus canUnloadLibrary(void)
canStatus kvIoPinGetOutputRelay(const CanHandle hnd, unsigned int pin, unsigned int *value)
struct canNotifyData::@0::@1 busErr
canHandle CanHandle
Definition: canlib.h:171
kvStatus kvScriptEnvvarSetData(kvEnvHandle eHnd, const void *buf, int start_index, int data_len)
canStatus kvStatus
Definition: canlib.h:4158
Definition: canlib.h:3223
canStatus kvAnnounceIdentityEx(const CanHandle hnd, int type, void *buf, size_t bufsiz)
union canNotifyData::@0 info
canStatus canResetBus(const CanHandle hnd)
canStatus canObjBufAllocate(const CanHandle hnd, int type)
unsigned char DI2
Definition: canlib.h:6147
int nNonMagiSyncedMembers
number of non MagiSync™ members
Definition: canlib.h:4168
canStatus canSetBusParamsTq(const CanHandle hnd, const kvBusParamsTq nominal)
unsigned char DO6
Definition: canlib.h:6088
canStatus canGetNumberOfChannels(int *channelCount)
canStatus canGetHandleData(const CanHandle hnd, int item, void *buffer, size_t bufsize)
kvStatus kvFileDiskFormat(const CanHandle hnd)
kvStatus kvScriptEnvvarGetData(kvEnvHandle eHnd, void *buf, int start_index, int data_len)
unsigned char DO9
Definition: canlib.h:6091
unsigned char DO14
Definition: canlib.h:6096
unsigned long time
Definition: canlib.h:178
canStatus canGetBusParamsTq(const CanHandle hnd, kvBusParamsTq *nominal)
unsigned char DO5
Definition: canlib.h:6087
canStatus canReadSync(const CanHandle hnd, unsigned long timeout)
float AO2
Definition: canlib.h:6165
int version
Definition: canlib.h:2466
int numerator
Definition: canlib.h:2445
kvStatus kvScriptUnload(const CanHandle hnd, int slotNo)
canStatus canObjBufSetPeriod(const CanHandle hnd, int idx, unsigned int period)
unsigned char DI6
Definition: canlib.h:6151
canStatus canObjBufFreeAll(const CanHandle hnd)
canStatus canIoCtl(const CanHandle hnd, unsigned int func, void *buf, unsigned int buflen)
unsigned char DI15
Definition: canlib.h:6113
struct canNotifyData::@0::@4 status
canStatus canSetBusParams(const CanHandle hnd, long freq, unsigned int tseg1, unsigned int tseg2, unsigned int sjw, unsigned int noSamp, unsigned int syncmode)
canStatus canObjBufSetFilter(const CanHandle hnd, int idx, unsigned int code, unsigned int mask)
struct canNotifyData::@0::@3 tx
unsigned char DO11
Definition: canlib.h:6093
kvStatus kvGetSupportedInterfaceInfo(int index, char *hwName, size_t nameLen, int *hwType, int *hwBusType)
canStatus canRead(const CanHandle hnd, long *id, void *msg, unsigned int *dlc, unsigned int *flag, unsigned long *time)
int nMagiSyncedMembers
number of MagiSync™ members
Definition: canlib.h:4166
unsigned char DO12
Definition: canlib.h:6094