canlib.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 
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 #define canHWTYPE_LEAF3 90
2562 
2563 
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 
3221 #define canIOCTL_SET_LOCAL_TXACK 46
3222 
3225 typedef struct {
3226  unsigned int portNo;
3227  unsigned int portValue;
3229 
3230 
3271 canStatus CANLIBAPI canSetBusParamsC200(const CanHandle hnd, unsigned char btr0, unsigned char btr1);
3272 
3273 
3274 
3310 canStatus CANLIBAPI canSetDriverMode(const CanHandle hnd, int lineMode, int resNet);
3311 
3348 canStatus CANLIBAPI canGetDriverMode(const CanHandle hnd, int *lineMode, int *resNet);
3349 
3369 #define canVERSION_CANLIB32_VERSION 0
3370 
3381 #define canVERSION_CANLIB32_PRODVER 1
3382 
3394 #define canVERSION_CANLIB32_PRODVER32 2
3395 
3406 #define canVERSION_CANLIB32_BETA 3
3407 
3427 unsigned int CANLIBAPI canGetVersionEx(unsigned int itemCode);
3428 
3429 
3449 canStatus CANLIBAPI canObjBufFreeAll(const CanHandle hnd);
3450 
3471 canStatus CANLIBAPI canObjBufAllocate(const CanHandle hnd, int type);
3472 
3481 #define canOBJBUF_TYPE_AUTO_RESPONSE 0x01
3482 #define canOBJBUF_TYPE_PERIODIC_TX 0x02
3483 
3505 canStatus CANLIBAPI canObjBufFree(const CanHandle hnd, int idx);
3506 
3507 // Writes CAN data to the object buffer with the specified index.
3508 
3534 canStatus CANLIBAPI canObjBufWrite(const CanHandle hnd,
3535  int idx,
3536  int id,
3537  void *msg,
3538  unsigned int dlc,
3539  unsigned int flags);
3540 
3566 canStatus CANLIBAPI canObjBufSetFilter(const CanHandle hnd,
3567  int idx,
3568  unsigned int code,
3569  unsigned int mask);
3570 
3591 canStatus CANLIBAPI canObjBufSetFlags(const CanHandle hnd,
3592  int idx,
3593  unsigned int flags);
3594 
3612 #define canOBJBUF_AUTO_RESPONSE_RTR_ONLY 0x01
3613 
3635 canStatus CANLIBAPI canObjBufSetPeriod(const CanHandle hnd,
3636  int idx,
3637  unsigned int period);
3638 
3659 canStatus CANLIBAPI canObjBufSetMsgCount(const CanHandle hnd,
3660  int idx,
3661  unsigned int count);
3662 
3682 canStatus CANLIBAPI canObjBufEnable(const CanHandle hnd, int idx);
3683 
3703 canStatus CANLIBAPI canObjBufDisable(const CanHandle hnd, int idx);
3704 
3728 canStatus CANLIBAPI canObjBufSendBurst(const CanHandle hnd,
3729  int idx,
3730  unsigned int burstlen);
3731 
3732 
3755 canStatus CANLIBAPI canResetBus(const CanHandle hnd);
3756 
3797 canStatus CANLIBAPI canWriteWait(const CanHandle hnd,
3798  long id,
3799  void *msg,
3800  unsigned int dlc,
3801  unsigned int flag,
3802  unsigned long timeout);
3803 
3804 
3830 canStatus CANLIBAPI canUnloadLibrary(void);
3831 
3893 canStatus CANLIBAPI canSetAcceptanceFilter(const CanHandle hnd,
3894  unsigned int code,
3895  unsigned int mask,
3896  int is_extended);
3920 canStatus CANLIBAPI canFlushReceiveQueue(const CanHandle hnd);
3921 
3946 canStatus CANLIBAPI canFlushTransmitQueue(const CanHandle hnd);
3947 
3948 
3957 #define kvLED_ACTION_ALL_LEDS_ON 0
3958 #define kvLED_ACTION_ALL_LEDS_OFF 1
3959 #define kvLED_ACTION_LED_0_ON 2
3960 #define kvLED_ACTION_LED_0_OFF 3
3961 #define kvLED_ACTION_LED_1_ON 4
3962 #define kvLED_ACTION_LED_1_OFF 5
3963 #define kvLED_ACTION_LED_2_ON 6
3964 #define kvLED_ACTION_LED_2_OFF 7
3965 #define kvLED_ACTION_LED_3_ON 8
3966 #define kvLED_ACTION_LED_3_OFF 9
3967 #define kvLED_ACTION_LED_4_ON 10
3968 #define kvLED_ACTION_LED_4_OFF 11
3969 #define kvLED_ACTION_LED_5_ON 12
3970 #define kvLED_ACTION_LED_5_OFF 13
3971 #define kvLED_ACTION_LED_6_ON 14
3972 #define kvLED_ACTION_LED_6_OFF 15
3973 #define kvLED_ACTION_LED_7_ON 16
3974 #define kvLED_ACTION_LED_7_OFF 17
3975 #define kvLED_ACTION_LED_8_ON 18
3976 #define kvLED_ACTION_LED_8_OFF 19
3977 #define kvLED_ACTION_LED_9_ON 20
3978 #define kvLED_ACTION_LED_9_OFF 21
3979 #define kvLED_ACTION_LED_10_ON 22
3980 #define kvLED_ACTION_LED_10_OFF 23
3981 #define kvLED_ACTION_LED_11_ON 24
3982 #define kvLED_ACTION_LED_11_OFF 25
3983 
3984 
4007 canStatus CANLIBAPI kvFlashLeds (const CanHandle hnd, int action, int timeout);
4008 
4028 canStatus CANLIBAPI canRequestChipStatus(const CanHandle hnd);
4029 
4056 canStatus CANLIBAPI canRequestBusStatistics (const CanHandle hnd);
4057 
4063 typedef struct canBusStatistics_s {
4064  unsigned long stdData;
4065  unsigned long stdRemote;
4066  unsigned long extData;
4067  unsigned long extRemote;
4068  unsigned long errFrame;
4069 
4074  unsigned long busLoad;
4075  unsigned long overruns;
4077 
4100 canStatus CANLIBAPI canGetBusStatistics(const CanHandle hnd,
4101  canBusStatistics *stat,
4102  size_t bufsiz);
4103 
4104 
4125 canStatus CANLIBAPI kvAnnounceIdentityEx(const CanHandle hnd,
4126  int type,
4127  void *buf,
4128  size_t bufsiz);
4129 
4151 canStatus CANLIBAPI canGetHandleData(const CanHandle hnd,
4152  int item,
4153  void *buffer,
4154  size_t bufsize);
4155 
4157 typedef void *kvTimeDomain;
4158 
4161 
4166 typedef struct kvTimeDomainData_s {
4172 
4201 kvStatus CANLIBAPI kvTimeDomainCreate(kvTimeDomain *domain);
4202 
4225 kvStatus CANLIBAPI kvTimeDomainDelete(kvTimeDomain domain);
4226 
4252 kvStatus CANLIBAPI kvTimeDomainResetTime(kvTimeDomain domain);
4253 
4278 kvStatus CANLIBAPI kvTimeDomainGetData(kvTimeDomain domain,
4279  kvTimeDomainData *data,
4280  size_t bufsiz);
4281 
4304 kvStatus CANLIBAPI kvTimeDomainAddHandle(kvTimeDomain domain,
4305  const CanHandle hnd);
4306 
4328 kvStatus CANLIBAPI kvTimeDomainRemoveHandle(kvTimeDomain domain,
4329  const CanHandle hnd);
4330 
4348 typedef void(CANLIBAPI *kvCallback_t)(CanHandle hnd, void *context, unsigned int notifyEvent);
4382 kvStatus CANLIBAPI kvSetNotifyCallback(const CanHandle hnd,
4383  kvCallback_t callback,
4384  void *context,
4385  unsigned int notifyFlags);
4386 
4400 #define kvBUSTYPE_NONE 0
4401 
4406 #define kvBUSTYPE_PCI 1
4407 
4412 #define kvBUSTYPE_PCMCIA 2
4413 
4418 #define kvBUSTYPE_USB 3
4419 
4424 #define kvBUSTYPE_WLAN 4
4425 
4430 #define kvBUSTYPE_PCI_EXPRESS 5
4431 
4436 #define kvBUSTYPE_ISA 6
4437 
4442 #define kvBUSTYPE_VIRTUAL 7
4443 
4448 #define kvBUSTYPE_PC104_PLUS 8
4449 
4454 #define kvBUSTYPE_LAN 9
4455 
4471 #define kvBUSTYPE_GROUP_VIRTUAL 1
4472 
4477 #define kvBUSTYPE_GROUP_LOCAL 2
4478 
4483 #define kvBUSTYPE_GROUP_REMOTE 3
4484 
4488 #define kvBUSTYPE_GROUP_INTERNAL 4
4489 
4543 kvStatus CANLIBAPI kvGetSupportedInterfaceInfo(int index,
4544  char *hwName,
4545  size_t nameLen,
4546  int *hwType,
4547  int *hwBusType);
4548 
4573 kvStatus CANLIBAPI kvReadDeviceCustomerData(const CanHandle hnd,
4574  int userNumber,
4575  int itemNumber,
4576  void *data,
4577  size_t bufsiz);
4578 
4592 #define kvENVVAR_TYPE_INT 1
4593 
4599 #define kvENVVAR_TYPE_FLOAT 2
4600 
4606 #define kvENVVAR_TYPE_STRING 3
4607 
4623 #define kvEVENT_TYPE_KEY 1
4624 
4632 typedef int64_t kvEnvHandle;
4633 
4653 kvStatus CANLIBAPI kvScriptStart(const CanHandle hnd, int slotNo);
4654 
4661 #define kvSCRIPT_STOP_NORMAL 0
4662 #define kvSCRIPT_STOP_FORCED -9
4686 kvStatus CANLIBAPI kvScriptStop(const CanHandle hnd, int slotNo, int mode);
4687 
4707 kvStatus CANLIBAPI kvScriptUnload(const CanHandle hnd, int slotNo);
4708 
4733 kvStatus CANLIBAPI kvScriptSendEvent(const CanHandle hnd,
4734  int slotNo,
4735  int eventType,
4736  int eventNo,
4737  unsigned int data);
4738 
4763 kvEnvHandle CANLIBAPI kvScriptEnvvarOpen(const CanHandle hnd,
4764  const char *envvarName,
4765  int *envvarType,
4766  int *envvarSize); // returns scriptHandle
4767 
4785 kvStatus CANLIBAPI kvScriptEnvvarClose(kvEnvHandle eHnd);
4786 
4807 kvStatus CANLIBAPI kvScriptEnvvarSetInt(kvEnvHandle eHnd, int val);
4808 
4830 kvStatus CANLIBAPI kvScriptEnvvarGetInt(kvEnvHandle eHnd, int *val);
4831 
4854 kvStatus CANLIBAPI kvScriptEnvvarSetFloat(kvEnvHandle eHnd, float val);
4855 
4879 kvStatus CANLIBAPI kvScriptEnvvarGetFloat(kvEnvHandle eHnd, float *val);
4880 
4907 kvStatus CANLIBAPI kvScriptEnvvarSetData(kvEnvHandle eHnd,
4908  const void *buf,
4909  int start_index,
4910  int data_len);
4911 
4937 kvStatus CANLIBAPI kvScriptEnvvarGetData(kvEnvHandle eHnd,
4938  void *buf,
4939  int start_index,
4940  int data_len);
4941 
4965 kvStatus CANLIBAPI kvScriptLoadFileOnDevice(const CanHandle hnd,
4966  int slotNo,
4967  char *localFile);
4968 
4997 kvStatus CANLIBAPI kvScriptLoadFile(const CanHandle hnd,
4998  int slotNo,
4999  char *filePathOnPC);
5000 
5001 
5015 #define kvSCRIPT_REQUEST_TEXT_UNSUBSCRIBE 1
5016 
5020 #define kvSCRIPT_REQUEST_TEXT_SUBSCRIBE 2
5021 
5025 #define kvSCRIPT_REQUEST_TEXT_ALL_SLOTS 255
5026 
5050 kvStatus CANLIBAPI kvScriptRequestText(const CanHandle hnd,
5051  unsigned int slot,
5052  unsigned int request);
5053 
5054 
5055 
5078 kvStatus CANLIBAPI kvScriptGetText(const CanHandle hnd,
5079  int *slot,
5080  unsigned long *time,
5081  unsigned int *flags,
5082  char *buf,
5083  size_t bufsize);
5084 
5091 #define kvSCRIPT_STATUS_LOADED 1
5092 #define kvSCRIPT_STATUS_RUNNING 2
5113 kvStatus CANLIBAPI kvScriptStatus(const CanHandle hnd,
5114  int slot,
5115  unsigned int *status);
5116 
5117 
5136 kvStatus CANLIBAPI kvScriptGetMaxEnvvarSize(int hnd, int *envvarSize);
5137 
5168 kvStatus CANLIBAPI kvScriptTxeGetData(const char *filePathOnPC,
5169  int item,
5170  void *buffer,
5171  unsigned int *bufsize);
5172 
5198 #define canTXEDATA_FILE_VERSION 1
5199 
5215 #define canTXEDATA_COMPILER_VERSION 2
5216 
5235 #define canTXEDATA_DATE 3
5236 
5247 #define canTXEDATA_DESCRIPTION 4
5248 
5262 #define canTXEDATA_SOURCE 5
5263 
5273 #define canTXEDATA_SIZE_OF_CODE 6
5274 
5284 #define canTXEDATA_IS_ENCRYPTED 7
5285 
5286 
5313 kvStatus CANLIBAPI kvFileCopyToDevice(const CanHandle hnd,
5314  char *hostFileName,
5315  char *deviceFileName);
5316 
5339 kvStatus CANLIBAPI kvFileCopyFromDevice(const CanHandle hnd,
5340  char *deviceFileName,
5341  char *hostFileName);
5342 
5364 kvStatus CANLIBAPI kvFileDelete(const CanHandle hnd, char *deviceFileName);
5365 
5388 kvStatus CANLIBAPI kvFileGetName(const CanHandle hnd,
5389  int fileNo,
5390  char *name,
5391  int namelen);
5392 
5412 kvStatus CANLIBAPI kvFileGetCount(const CanHandle hnd, int *count);
5413 
5436 kvStatus CANLIBAPI kvFileGetSystemData(const CanHandle hnd,
5437  int itemCode,
5438  int *result);
5439 
5458 kvStatus CANLIBAPI kvFileDiskFormat(const CanHandle hnd);
5459 
5477 #define kvDEVICE_MODE_INTERFACE 0x00
5478 
5483 #define kvDEVICE_MODE_LOGGER 0x01
5484 
5509 kvStatus CANLIBAPI kvDeviceSetMode(const CanHandle hnd, int mode);
5510 
5533 kvStatus CANLIBAPI kvDeviceGetMode(const CanHandle hnd, int *result);
5534 
5535 
5560 kvStatus CANLIBAPI kvReadTimer(const CanHandle hnd, unsigned int *time);
5584 kvStatus CANLIBAPI kvReadTimer64(const CanHandle hnd, uint64_t *time);
5585 
5602 #define kvIO_INFO_GET_MODULE_TYPE 1
5603 
5609 #define kvIO_INFO_GET_DIRECTION 2
5610 
5616 #define kvIO_INFO_GET_PIN_TYPE 4
5617 
5623 #define kvIO_INFO_GET_NUMBER_OF_BITS 5
5624 
5632 #define kvIO_INFO_GET_RANGE_MIN 6
5633 
5641 #define kvIO_INFO_GET_RANGE_MAX 7
5642 
5650 #define kvIO_INFO_GET_DI_LOW_HIGH_FILTER 8
5651 
5659 #define kvIO_INFO_GET_DI_HIGH_LOW_FILTER 9
5660 
5668 #define kvIO_INFO_GET_AI_LP_FILTER_ORDER 10
5669 
5678 #define kvIO_INFO_GET_AI_HYSTERESIS 11
5679 
5685 #define kvIO_INFO_GET_MODULE_NUMBER 14
5686 
5692 #define kvIO_INFO_GET_SERIAL_NUMBER 15
5693 
5701 #define kvIO_INFO_GET_FW_VERSION 16
5702 
5723 #define kvIO_INFO_SET_DI_LOW_HIGH_FILTER 8
5724 
5732 #define kvIO_INFO_SET_DI_HIGH_LOW_FILTER 9
5733 
5741 #define kvIO_INFO_SET_AI_LP_FILTER_ORDER 10
5742 
5751 #define kvIO_INFO_SET_AI_HYSTERESIS 11
5752 
5769 #define kvIO_MODULE_TYPE_DIGITAL 1
5770 
5774 #define kvIO_MODULE_TYPE_ANALOG 2
5775 
5779 #define kvIO_MODULE_TYPE_RELAY 3
5780 
5784 #define kvIO_MODULE_TYPE_INTERNAL 4
5785 
5800 #define kvIO_PIN_TYPE_DIGITAL 1
5801 
5805 #define kvIO_PIN_TYPE_ANALOG 2
5806 
5810 #define kvIO_PIN_TYPE_RELAY 3
5811 
5826 #define kvIO_PIN_DIRECTION_IN 4
5827 
5831 #define kvIO_PIN_DIRECTION_OUT 8
5832 
5854 canStatus CANLIBAPI kvIoGetNumberOfPins(const CanHandle hnd, unsigned int *pinCount);
5855 
5872 canStatus CANLIBAPI kvIoConfirmConfig(const CanHandle hnd);
5873 
5893 canStatus CANLIBAPI kvIoPinGetInfo(const CanHandle hnd, unsigned int pin, int item, void *buffer, const unsigned int bufsize);
5894 
5914 canStatus CANLIBAPI kvIoPinSetInfo(const CanHandle hnd, unsigned int pin, int item, const void *buffer, const unsigned int bufsize);
5915 
5933 canStatus CANLIBAPI kvIoPinSetDigital(const CanHandle hnd, unsigned int pin, unsigned int value);
5934 
5954 canStatus CANLIBAPI kvIoPinGetDigital(const CanHandle hnd, unsigned int pin, unsigned int *value);
5955 
5977 canStatus CANLIBAPI kvIoPinGetOutputDigital(const CanHandle hnd, unsigned int pin, unsigned int *value);
5978 
5996 canStatus CANLIBAPI kvIoPinSetRelay(const CanHandle hnd, unsigned int pin, unsigned int value);
5997 
6017 canStatus CANLIBAPI kvIoPinGetOutputRelay(const CanHandle hnd, unsigned int pin, unsigned int *value);
6018 
6036 canStatus CANLIBAPI kvIoPinSetAnalog(const CanHandle hnd, unsigned int pin, float value);
6037 
6055 canStatus CANLIBAPI kvIoPinGetAnalog(const CanHandle hnd, unsigned int pin, float *value);
6056 
6076 canStatus CANLIBAPI kvIoPinGetOutputAnalog(const CanHandle hnd, unsigned int pin, float *value);
6077 
6083 typedef struct {
6084  int type;
6085  unsigned char DO1 : 1;
6086  unsigned char DO2 : 1;
6087  unsigned char DO3 : 1;
6088  unsigned char DO4 : 1;
6089  unsigned char DO5 : 1;
6090  unsigned char DO6 : 1;
6091  unsigned char DO7 : 1;
6092  unsigned char DO8 : 1;
6093  unsigned char DO9 : 1;
6094  unsigned char DO10: 1;
6095  unsigned char DO11: 1;
6096  unsigned char DO12: 1;
6097  unsigned char DO13: 1;
6098  unsigned char DO14: 1;
6099  unsigned char DO15: 1;
6100  unsigned char DO16: 1;
6101  unsigned char DI1 : 1;
6102  unsigned char DI2 : 1;
6103  unsigned char DI3 : 1;
6104  unsigned char DI4 : 1;
6105  unsigned char DI5 : 1;
6106  unsigned char DI6 : 1;
6107  unsigned char DI7 : 1;
6108  unsigned char DI8 : 1;
6109  unsigned char DI9 : 1;
6110  unsigned char DI10: 1;
6111  unsigned char DI11: 1;
6112  unsigned char DI12: 1;
6113  unsigned char DI13: 1;
6114  unsigned char DI14: 1;
6115  unsigned char DI15: 1;
6116  unsigned char DI16: 1;
6118 
6119 
6125 typedef struct {
6126  int type;
6127  unsigned char DO: 1;
6128  unsigned char DI: 1;
6130 
6131 
6138 typedef struct {
6139  int type;
6140  unsigned char RO1 : 1;
6141  unsigned char RO2 : 1;
6142  unsigned char RO3 : 1;
6143  unsigned char RO4 : 1;
6144  unsigned char RO5 : 1;
6145  unsigned char RO6 : 1;
6146  unsigned char RO7 : 1;
6147  unsigned char RO8 : 1;
6148  unsigned char DI1 : 1;
6149  unsigned char DI2 : 1;
6150  unsigned char DI3 : 1;
6151  unsigned char DI4 : 1;
6152  unsigned char DI5 : 1;
6153  unsigned char DI6 : 1;
6154  unsigned char DI7 : 1;
6155  unsigned char DI8 : 1;
6156 } kvIoModuleRelay;
6157 
6164 typedef struct {
6165  int type;
6166  float AO1;
6167  float AO2;
6168  float AO3;
6169  float AO4;
6170  float AI1;
6171  float AI2;
6172  float AI3;
6173  float AI4;
6175 
6176 
6199 canStatus CANLIBAPI kvIoGetModulePins(const CanHandle hnd, unsigned int module, void *buffer, const unsigned int bufsize);
6200 
6201 
6225 canStatus CANLIBAPI kvIoSetModulePins(const CanHandle hnd, unsigned int module, const void *buffer, const unsigned int bufsize);
6226 
6227 
6228 #ifdef __cplusplus
6229 }
6230 #endif /* __cplusplus */
6231 
6232 #include "obsolete.h"
6233 
6234 #endif /* _CANLIB_H_ */
struct kvClockInfo kvClockInfo
Definitions which are retained for compatibility.
unsigned char DI10
Definition: canlib.h:6110
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:4065
unsigned char DI5
Definition: canlib.h:6105
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:6112
unsigned char RO3
Definition: canlib.h:6142
canStatus canGetBusOutputControl(const CanHandle hnd, unsigned int *drivertype)
kvStatus kvTimeDomainDelete(kvTimeDomain domain)
float AI2
Definition: canlib.h:6171
unsigned char DI8
Definition: canlib.h:6108
canStatus canGetDriverMode(const CanHandle hnd, int *lineMode, int *resNet)
struct canNotifyData::@0::@2 rx
unsigned char DO15
Definition: canlib.h:6099
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:6092
canStatus canReadStatus(const CanHandle hnd, unsigned long *const flags)
kvStatus kvTimeDomainCreate(kvTimeDomain *domain)
unsigned char DI9
Definition: canlib.h:6109
unsigned int portNo
Port number used in e.g. canIOCTL_SET_USER_IOPORT.
Definition: canlib.h:3226
int64_t kvEnvHandle
Definition: canlib.h:4632
int accuracy_ppm
Definition: canlib.h:2448
int nNonMagiSyncCards
number of non MagiSync™ interfaces
Definition: canlib.h:4169
unsigned char RO2
Definition: canlib.h:6141
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:4157
unsigned char DI7
Definition: canlib.h:6107
unsigned char DO
Definition: canlib.h:6127
unsigned char rxErrorCounter
Definition: canlib.h:191
unsigned char DO2
Definition: canlib.h:6086
unsigned long extRemote
Number of received extended (29-bit identifiers) remote frames.
Definition: canlib.h:4067
canStatus canClose(const CanHandle hnd)
unsigned char RO5
Definition: canlib.h:6144
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:6165
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:6113
int canHandle
Definition: canlib.h:166
unsigned char DI14
Definition: canlib.h:6114
unsigned char DI1
Definition: canlib.h:6148
canStatus canObjBufDisable(const CanHandle hnd, int idx)
void * tag
Definition: canlib.h:174
unsigned char RO4
Definition: canlib.h:6143
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:6172
kvStatus kvScriptEnvvarGetInt(kvEnvHandle eHnd, int *val)
Definitions for the CANLIB API.
kvStatus kvScriptGetMaxEnvvarSize(int hnd, int *envvarSize)
Definition: canlib.h:6138
Definition: canlib.h:6083
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:6164
canStatus canSetBusOutputControl(const CanHandle hnd, const unsigned int drivertype)
int tq
Definition: canlib.h:704
int type
Definition: canlib.h:6139
Definition: canlib.h:2465
int type
Definition: canlib.h:6084
int eventType
Definition: canlib.h:175
float AO3
Definition: canlib.h:6168
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:6126
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:6147
canStatus canBusOn(const CanHandle hnd)
Definition: canlib.h:6125
long id
Definition: canlib.h:181
unsigned char DI
Definition: canlib.h:6128
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:6150
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:6173
unsigned int portValue
Port value used in e.g. canIOCTL_SET_USER_IOPORT.
Definition: canlib.h:3227
kvBusParamsTq arbitration_max
Definition: canlib.h:2468
unsigned short canGetVersion(void)
unsigned char DI1
Definition: canlib.h:6101
unsigned char DI2
Definition: canlib.h:6102
int phase2
Definition: canlib.h:706
unsigned long errFrame
Number of error frames.
Definition: canlib.h:4068
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:6169
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:6094
kvStatus kvTimeDomainResetTime(kvTimeDomain domain)
unsigned char DO3
Definition: canlib.h:6087
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:4066
float AO1
Definition: canlib.h:6166
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:6100
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:6088
unsigned char DI8
Definition: canlib.h:6155
unsigned char DI6
Definition: canlib.h:6106
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:6085
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:6146
unsigned char RO1
Definition: canlib.h:6140
unsigned char DI16
Definition: canlib.h:6116
kvBusParamsTq arbitration_min
Definition: canlib.h:2467
unsigned char DI5
Definition: canlib.h:6152
void(* kvCallback_t)(CanHandle hnd, void *context, unsigned int notifyEvent)
Definition: canlib.h:4348
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:4167
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:6111
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:6145
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:4064
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:4075
kvStatus kvTimeDomainAddHandle(kvTimeDomain domain, const CanHandle hnd)
kvStatus kvFileCopyToDevice(const CanHandle hnd, char *hostFileName, char *deviceFileName)
Definition: canlib.h:4166
unsigned char DI3
Definition: canlib.h:6103
canStatus canReadTimer(const CanHandle hnd, unsigned long *time)
unsigned char DO7
Definition: canlib.h:6091
canStatus kvIoPinSetDigital(const CanHandle hnd, unsigned int pin, unsigned int value)
unsigned char DI4
Definition: canlib.h:6104
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:6170
canStatus canGetErrorText(canStatus err, char *buf, unsigned int bufsiz)
kvBusParamsTq data_max
Definition: canlib.h:2470
unsigned long busLoad
Definition: canlib.h:4074
unsigned char DI7
Definition: canlib.h:6154
unsigned char DO13
Definition: canlib.h:6097
canStatus canRequestChipStatus(const CanHandle hnd)
int version
Definition: canlib.h:2444
Definition: canlib.h:4063
canStatus canEnumHardwareEx(int *channelCount)
unsigned char DI4
Definition: canlib.h:6151
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:4160
Definition: canlib.h:3225
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:6149
int nNonMagiSyncedMembers
number of non MagiSync™ members
Definition: canlib.h:4170
canStatus canSetBusParamsTq(const CanHandle hnd, const kvBusParamsTq nominal)
unsigned char DO6
Definition: canlib.h:6090
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:6093
unsigned char DO14
Definition: canlib.h:6098
unsigned long time
Definition: canlib.h:178
canStatus canGetBusParamsTq(const CanHandle hnd, kvBusParamsTq *nominal)
unsigned char DO5
Definition: canlib.h:6089
canStatus canReadSync(const CanHandle hnd, unsigned long timeout)
float AO2
Definition: canlib.h:6167
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:6153
canStatus canObjBufFreeAll(const CanHandle hnd)
canStatus canIoCtl(const CanHandle hnd, unsigned int func, void *buf, unsigned int buflen)
unsigned char DI15
Definition: canlib.h:6115
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:6095
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:4168
unsigned char DO12
Definition: canlib.h:6096