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 
128 #ifndef _CANLIB_H_
129 #define _CANLIB_H_
130 
131 #include <stdlib.h>
132 
133 #include <stdint.h>
134 
135 #include "canstat.h"
136 
138 typedef int canHandle;
139 
140 # define canINVALID_HANDLE (-1)
141 
144 
145 typedef struct canNotifyData {
146  void *tag;
148  union {
149  struct {
150  unsigned long time;
151  } busErr;
152  struct {
153  long id;
154  unsigned long time;
155  } rx;
156  struct {
157  long id;
158  unsigned long time;
159  } tx;
160  struct {
161  unsigned char busStatus;
162  unsigned char txErrorCounter;
163  unsigned char rxErrorCounter;
164  unsigned long time;
165  } status;
166  } info;
167 } canNotifyData;
168 
169 
179 // The canWANT_xxx names are also obsolete, use canOPEN_xxx instead for new developments.
180 #define canWANT_EXCLUSIVE 0x0008
181 #define canWANT_EXTENDED 0x0010
182 #define canWANT_VIRTUAL 0x0020
183 
189 #define canOPEN_EXCLUSIVE 0x0008
190 
202 #define canOPEN_REQUIRE_EXTENDED 0x0010
203 
211 # define canOPEN_ACCEPT_VIRTUAL 0x0020
212 
221 # define canOPEN_OVERRIDE_EXCLUSIVE 0x0040
222 
239 # define canOPEN_REQUIRE_INIT_ACCESS 0x0080
240 
252 # define canOPEN_NO_INIT_ACCESS 0x0100
253 
265 # define canOPEN_ACCEPT_LARGE_DLC 0x0200 // DLC can be greater than 8
266 
273 # define canOPEN_CAN_FD 0x0400
274 
288 # define canOPEN_CAN_FD_NONISO 0x0800
289 
290 
294 # define canOPEN_INTERNAL_L 0x1000
295 
307 #define canFILTER_ACCEPT 1
308 #define canFILTER_REJECT 2
309 
310 #define canFILTER_SET_CODE_STD 3
311 
312 #define canFILTER_SET_MASK_STD 4
313 
314 #define canFILTER_SET_CODE_EXT 5
315 
316 #define canFILTER_SET_MASK_EXT 6
317 
318 #define canFILTER_NULL_MASK 0L
319 
335 #define canDRIVER_NORMAL 4
336 
343 #define canDRIVER_SILENT 1
344 
348 #define canDRIVER_SELFRECEPTION 8
349 
353 #define canDRIVER_OFF 0
354 
377 #define canBITRATE_1M (-1)
378 
379 #define canBITRATE_500K (-2)
380 
381 #define canBITRATE_250K (-3)
382 
383 #define canBITRATE_125K (-4)
384 
385 #define canBITRATE_100K (-5)
386 
387 #define canBITRATE_62K (-6)
388 
389 #define canBITRATE_50K (-7)
390 
391 #define canBITRATE_83K (-8)
392 
393 #define canBITRATE_10K (-9)
394 
395 // CAN FD Bit Rates
399 #define canFD_BITRATE_500K_80P (-1000)
400 
403 #define canFD_BITRATE_1M_80P (-1001)
404 
407 #define canFD_BITRATE_2M_80P (-1002)
408 
411 #define canFD_BITRATE_4M_80P (-1003)
412 
415 #define canFD_BITRATE_8M_60P (-1004)
416 
418 #define BAUD_1M (-1)
419 
420 #define BAUD_500K (-2)
421 
422 #define BAUD_250K (-3)
423 
424 #define BAUD_125K (-4)
425 
426 #define BAUD_100K (-5)
427 
428 #define BAUD_62K (-6)
429 
430 #define BAUD_50K (-7)
431 
432 #define BAUD_83K (-8)
433 
436 //
437 // Define CANLIBAPI unless it's done already.
438 // (canlib.c provides its own definitions of CANLIBAPI, DLLIMPORT
439 // and DLLEXPORT before including this file.)
440 //
441 #ifndef CANLIBAPI
442 # define CANLIBAPI
443 #endif /* CANLIBAPI */
444 
445 
446 #ifdef __cplusplus
447 extern "C" {
448 #endif /* __cplusplus */
449 
471 void CANLIBAPI canInitializeLibrary (void);
472 
497 canStatus CANLIBAPI canClose (const CanHandle hnd);
498 
523 canStatus CANLIBAPI canBusOn (const CanHandle hnd);
524 
544 canStatus CANLIBAPI canBusOff (const CanHandle hnd);
545 
592 canStatus CANLIBAPI canSetBusParams (const CanHandle hnd,
593  long freq,
594  unsigned int tseg1,
595  unsigned int tseg2,
596  unsigned int sjw,
597  unsigned int noSamp,
598  unsigned int syncmode);
599 
631 canStatus CANLIBAPI canSetBusParamsFd(const CanHandle hnd,
632  long freq_brs,
633  unsigned int tseg1_brs,
634  unsigned int tseg2_brs,
635  unsigned int sjw_brs);
636 
637 
669 canStatus CANLIBAPI canGetBusParams (const CanHandle hnd,
670  long *freq,
671  unsigned int *tseg1,
672  unsigned int *tseg2,
673  unsigned int *sjw,
674  unsigned int *noSamp,
675  unsigned int *syncmode);
676 
677 
700 canStatus CANLIBAPI canGetBusParamsFd(const CanHandle hnd,
701  long *freq_brs,
702  unsigned int *tseg1_brs,
703  unsigned int *tseg2_brs,
704  unsigned int *sjw_brs);
729 canStatus CANLIBAPI canSetBusOutputControl (const CanHandle hnd,
730  const unsigned int drivertype);
731 
766 canStatus CANLIBAPI canGetBusOutputControl (const CanHandle hnd,
767  unsigned int *drivertype);
768 
809 canStatus CANLIBAPI canAccept (const CanHandle hnd,
810  const long envelope,
811  const unsigned int flag);
812 
836 canStatus CANLIBAPI canReadStatus (const CanHandle hnd,
837  unsigned long *const flags);
838 
875 canStatus CANLIBAPI canReadErrorCounters (const CanHandle hnd,
876  unsigned int *txErr,
877  unsigned int *rxErr,
878  unsigned int *ovErr);
879 
921 canStatus CANLIBAPI canWrite (const CanHandle hnd,
922  long id,
923  void *msg,
924  unsigned int dlc,
925  unsigned int flag);
926 
954 canStatus CANLIBAPI canWriteSync (const CanHandle hnd, unsigned long timeout);
955 
1007 canStatus CANLIBAPI canRead (const CanHandle hnd,
1008  long *id,
1009  void *msg,
1010  unsigned int *dlc,
1011  unsigned int *flag,
1012  unsigned long *time);
1061 canStatus CANLIBAPI canReadWait (const CanHandle hnd,
1062  long *id,
1063  void *msg,
1064  unsigned int *dlc,
1065  unsigned int *flag,
1066  unsigned long *time,
1067  unsigned long timeout);
1068 
1118 canStatus CANLIBAPI canReadSpecific (const CanHandle hnd, long id, void * msg,
1119  unsigned int * dlc, unsigned int * flag,
1120  unsigned long * time);
1121 
1152 canStatus CANLIBAPI canReadSync (const CanHandle hnd, unsigned long timeout);
1153 
1185 canStatus CANLIBAPI canReadSyncSpecific (const CanHandle hnd,
1186  long id,
1187  unsigned long timeout);
1188 
1232 canStatus CANLIBAPI canReadSpecificSkip (const CanHandle hnd,
1233  long id,
1234  void * msg,
1235  unsigned int * dlc,
1236  unsigned int * flag,
1237  unsigned long * time);
1238 
1259 canStatus CANLIBAPI canSetNotify (const CanHandle hnd,
1260  void (*callback)(canNotifyData *),
1261  unsigned int notifyFlags,
1262  void *tag);
1263 
1277 canStatus CANLIBAPI canGetRawHandle (const CanHandle hnd, void *pvFd);
1278 
1313 canStatus CANLIBAPI canTranslateBaud (long *const freq,
1314  unsigned int *const tseg1,
1315  unsigned int *const tseg2,
1316  unsigned int *const sjw,
1317  unsigned int *const nosamp,
1318  unsigned int *const syncMode);
1319 
1342 canStatus CANLIBAPI canGetErrorText (canStatus err, char *buf, unsigned int bufsiz);
1343 
1362 unsigned short CANLIBAPI canGetVersion (void);
1363 
1393 canStatus CANLIBAPI canIoCtl (const CanHandle hnd,
1394  unsigned int func,
1395  void *buf,
1396  unsigned int buflen);
1397 
1398 
1427 canStatus CANLIBAPI canReadTimer (const CanHandle hnd, unsigned long *time);
1428 
1479 CanHandle CANLIBAPI canOpenChannel (int channel, int flags);
1480 
1501 canStatus CANLIBAPI canGetNumberOfChannels (int *channelCount);
1502 
1503 
1511 #define kvREMOTE_TYPE_NOT_REMOTE 0
1512 #define kvREMOTE_TYPE_WLAN 1
1513 #define kvREMOTE_TYPE_LAN 2
1514 
1523 #define kvLOGGER_TYPE_NOT_A_LOGGER 0
1524 #define kvLOGGER_TYPE_V1 1
1525 #define kvLOGGER_TYPE_V2 2
1526 
1558 canStatus CANLIBAPI canGetChannelData (int channel,
1559  int item,
1560  void *buffer,
1561  size_t bufsize);
1562 
1581 #define canCHANNELDATA_CHANNEL_CAP 1
1582 
1592 #define canCHANNELDATA_TRANS_CAP 2
1593 
1599 #define canCHANNELDATA_CHANNEL_FLAGS 3 // available, etc
1600 
1609 #define canCHANNELDATA_CARD_TYPE 4
1610 
1620 #define canCHANNELDATA_CARD_NUMBER 5
1621 
1629 #define canCHANNELDATA_CHAN_NO_ON_CARD 6
1630 
1640 #define canCHANNELDATA_CARD_SERIAL_NO 7
1641 
1651 #define canCHANNELDATA_TRANS_SERIAL_NO 8
1652 
1663 #define canCHANNELDATA_CARD_FIRMWARE_REV 9
1664 
1675 #define canCHANNELDATA_CARD_HARDWARE_REV 10
1676 
1686 #define canCHANNELDATA_CARD_UPC_NO 11
1687 
1698 #define canCHANNELDATA_TRANS_UPC_NO 12
1699 
1715 #define canCHANNELDATA_CHANNEL_NAME 13
1716 
1733 # define canCHANNELDATA_DLL_FILE_VERSION 14
1734 
1751 # define canCHANNELDATA_DLL_PRODUCT_VERSION 15
1752 
1768 # define canCHANNELDATA_DLL_FILETYPE 16
1769 
1778 # define canCHANNELDATA_TRANS_TYPE 17
1779 
1803 # define canCHANNELDATA_DEVICE_PHYSICAL_POSITION 18
1804 
1817 # define canCHANNELDATA_UI_NUMBER 19
1818 
1842 # define canCHANNELDATA_TIMESYNC_ENABLED 20
1843 
1859 # define canCHANNELDATA_DRIVER_FILE_VERSION 21
1860 
1876 # define canCHANNELDATA_DRIVER_PRODUCT_VERSION 22
1877 
1886 # define canCHANNELDATA_MFGNAME_UNICODE 23
1887 
1895 # define canCHANNELDATA_MFGNAME_ASCII 24
1896 
1905 # define canCHANNELDATA_DEVDESCR_UNICODE 25
1906 
1914 # define canCHANNELDATA_DEVDESCR_ASCII 26
1915 
1926 # define canCHANNELDATA_DRIVER_NAME 27
1927 
1940 # define canCHANNELDATA_CHANNEL_QUALITY 28
1941 
1950 # define canCHANNELDATA_ROUNDTRIP_TIME 29
1951 
1960 # define canCHANNELDATA_BUS_TYPE 30
1961 
1973 # define canCHANNELDATA_DEVNAME_ASCII 31
1974 
1985 # define canCHANNELDATA_TIME_SINCE_LAST_SEEN 32
1986 
1996 # define canCHANNELDATA_REMOTE_OPERATIONAL_MODE 33
1997 
2006 # define canCHANNELDATA_REMOTE_PROFILE_NAME 34
2007 
2016 # define canCHANNELDATA_REMOTE_HOST_NAME 35
2017 
2026 # define canCHANNELDATA_REMOTE_MAC 36
2027 
2036 # define canCHANNELDATA_MAX_BITRATE 37
2037 
2048 # define canCHANNELDATA_CHANNEL_CAP_MASK 38
2049 
2059 # define canCHANNELDATA_IS_REMOTE 40
2060 
2069 # define canCHANNELDATA_REMOTE_TYPE 41
2070 
2079 # define canCHANNELDATA_LOGGER_TYPE 42
2080 
2090 # define canCHANNELDATA_HW_STATUS 43
2091 
2101 # define canCHANNELDATA_FEATURE_EAN 44
2102 
2111 #define canCHANNELDATA_CUST_CHANNEL_NAME 39
2112 
2126 #define canCHANNEL_IS_EXCLUSIVE 0x0001
2127 
2129 #define canCHANNEL_IS_OPEN 0x0002
2130 
2134 #define canCHANNEL_IS_CANFD 0x0004
2135 
2136 //#define canCHANNEL_IS_CANFD_NON_ISO 0x0008 Reserved for when needed
2137 
2156 #define canHWTYPE_NONE 0
2157 #define canHWTYPE_VIRTUAL 1
2158 #define canHWTYPE_LAPCAN 2
2159 #define canHWTYPE_CANPARI 3
2160 #define canHWTYPE_PCCAN 8
2161 #define canHWTYPE_PCICAN 9
2162 #define canHWTYPE_USBCAN 11
2163 #define canHWTYPE_PCICAN_II 40
2164 #define canHWTYPE_USBCAN_II 42
2165 #define canHWTYPE_SIMULATED 44
2166 #define canHWTYPE_ACQUISITOR 46
2167 #define canHWTYPE_LEAF 48
2168 #define canHWTYPE_PC104_PLUS 50
2169 #define canHWTYPE_PCICANX_II 52
2170 #define canHWTYPE_MEMORATOR_II 54
2171 #define canHWTYPE_MEMORATOR_PRO 54
2172 #define canHWTYPE_USBCAN_PRO 56
2173 #define canHWTYPE_IRIS 58
2174 #define canHWTYPE_BLACKBIRD 58
2175 #define canHWTYPE_MEMORATOR_LIGHT 60
2176 #define canHWTYPE_MINIHYDRA 62
2177 #define canHWTYPE_EAGLE 62
2178 #define canHWTYPE_BAGEL 64
2179 #define canHWTYPE_BLACKBIRD_V2 64
2180 #define canHWTYPE_MINIPCIE 66
2181 #define canHWTYPE_USBCAN_KLINE 68
2182 #define canHWTYPE_ETHERCAN 70
2183 #define canHWTYPE_USBCAN_LIGHT 72
2184 #define canHWTYPE_USBCAN_PRO2 74
2185 #define canHWTYPE_PCIE_V2 76
2186 #define canHWTYPE_MEMORATOR_PRO2 78
2187 #define canHWTYPE_LEAF2 80
2188 #define canHWTYPE_MEMORATOR_V2 82
2189 #define canHWTYPE_CANLINHYBRID 84
2190 
2191 
2200 #define canCHANNEL_CAP_EXTENDED_CAN 0x00000001L
2201 #define canCHANNEL_CAP_BUS_STATISTICS 0x00000002L
2202 #define canCHANNEL_CAP_ERROR_COUNTERS 0x00000004L
2203 #define canCHANNEL_CAP_CAN_DIAGNOSTICS 0x00000008L
2204 #define canCHANNEL_CAP_GENERATE_ERROR 0x00000010L
2205 #define canCHANNEL_CAP_GENERATE_OVERLOAD 0x00000020L
2206 #define canCHANNEL_CAP_TXREQUEST 0x00000040L
2207 #define canCHANNEL_CAP_TXACKNOWLEDGE 0x00000080L
2208 #define canCHANNEL_CAP_VIRTUAL 0x00010000L
2209 #define canCHANNEL_CAP_SIMULATED 0x00020000L
2210 #define canCHANNEL_CAP_RESERVED_1 0x00040000L
2211 #define canCHANNEL_CAP_CAN_FD 0x00080000L
2212 #define canCHANNEL_CAP_CAN_FD_NONISO 0x00100000L
2213 #define canCHANNEL_CAP_SILENT_MODE 0x00200000L
2214 #define canCHANNEL_CAP_SINGLE_SHOT 0x00400000L
2215 #define canCHANNEL_CAP_LOGGER 0x00800000L
2216 #define canCHANNEL_CAP_REMOTE_ACCESS 0x01000000L
2217 #define canCHANNEL_CAP_SCRIPT 0x02000000L
2218 #define canCHANNEL_CAP_LIN_HYBRID 0x04000000L
2219 
2220 
2233 #define canCHANNEL_OPMODE_NONE 1
2234 
2238 #define canCHANNEL_OPMODE_INFRASTRUCTURE 2
2239 
2243 #define canCHANNEL_OPMODE_RESERVED 3
2244 
2248 #define canCHANNEL_OPMODE_ADHOC 4
2249 
2259 #define canDRIVER_CAP_HIGHSPEED 0x00000001L
2260 
2285 #define canIOCTL_PREFER_EXT 1
2286 
2299 #define canIOCTL_PREFER_STD 2
2300 
2316 #define canIOCTL_CLEAR_ERROR_COUNTERS 5
2317 
2328 #define canIOCTL_SET_TIMER_SCALE 6
2329 
2345 #define canIOCTL_SET_TXACK 7
2346 
2359 #define canIOCTL_GET_RX_BUFFER_LEVEL 8
2360 
2373 #define canIOCTL_GET_TX_BUFFER_LEVEL 9
2374 
2384 #define canIOCTL_FLUSH_RX_BUFFER 10
2385 
2395 #define canIOCTL_FLUSH_TX_BUFFER 11
2396 
2405 #define canIOCTL_GET_TIMER_SCALE 12
2406 
2418 #define canIOCTL_SET_TXRQ 13
2419 
2420 
2427 #define canIOCTL_SET_BYPASS_MODE 15
2428 
2434 #define canIOCTL_SET_WAKEUP 16
2435 
2445 # define canIOCTL_GET_DRIVERHANDLE 17
2446 
2452 # define canIOCTL_MAP_RXQUEUE 18
2453 
2459 # define canIOCTL_GET_WAKEUP 19
2460 
2472 # define canIOCTL_SET_REPORT_ACCESS_ERRORS 20
2473 
2481 # define canIOCTL_GET_REPORT_ACCESS_ERRORS 21
2482 
2492 # define canIOCTL_CONNECT_TO_VIRTUAL_BUS 22
2493 
2503 # define canIOCTL_DISCONNECT_FROM_VIRTUAL_BUS 23
2504 
2514 # define canIOCTL_SET_USER_IOPORT 24
2515 
2526 # define canIOCTL_GET_USER_IOPORT 25
2527 
2533 # define canIOCTL_SET_BUFFER_WRAPAROUND_MODE 26
2534 
2551 # define canIOCTL_SET_RX_QUEUE_SIZE 27
2552 
2558 # define canIOCTL_SET_USB_THROTTLE 28
2559 
2565 # define canIOCTL_GET_USB_THROTTLE 29
2566 
2579 # define canIOCTL_SET_BUSON_TIME_AUTO_RESET 30
2580 
2592 # define canIOCTL_GET_TXACK 31
2593 
2608 # define canIOCTL_SET_LOCAL_TXECHO 32
2609 
2610 
2611 
2625 # define canIOCTL_GET_TREF_LIST 39
2626 
2648 # define canIOCTL_TX_INTERVAL 40
2649 
2660 # define canIOCTL_SET_BRLIMIT 43
2661 
2668 # define canIOCTL_RESET_OVERRUN_COUNT 44
2669 
2672 typedef struct {
2673  unsigned int portNo;
2674  unsigned int portValue;
2676 
2677 
2718 canStatus CANLIBAPI canSetBusParamsC200 (const CanHandle hnd, unsigned char btr0, unsigned char btr1);
2719 
2720 
2721 
2757 canStatus CANLIBAPI canSetDriverMode (const CanHandle hnd, int lineMode, int resNet);
2758 
2795 canStatus CANLIBAPI canGetDriverMode (const CanHandle hnd, int *lineMode, int *resNet);
2796 
2797 
2817 canStatus CANLIBAPI canObjBufFreeAll (const CanHandle hnd);
2818 
2839 canStatus CANLIBAPI canObjBufAllocate (const CanHandle hnd, int type);
2840 
2849 #define canOBJBUF_TYPE_AUTO_RESPONSE 0x01
2850 #define canOBJBUF_TYPE_PERIODIC_TX 0x02
2851 
2873 canStatus CANLIBAPI canObjBufFree (const CanHandle hnd, int idx);
2874 
2875 // Writes CAN data to the object buffer with the specified index.
2876 
2902 canStatus CANLIBAPI canObjBufWrite (const CanHandle hnd,
2903  int idx,
2904  int id,
2905  void* msg,
2906  unsigned int dlc,
2907  unsigned int flags);
2908 
2935 canStatus CANLIBAPI canObjBufSetFilter (const CanHandle hnd,
2936  int idx,
2937  unsigned int code,
2938  unsigned int mask);
2939 
2960 canStatus CANLIBAPI canObjBufSetFlags (const CanHandle hnd,
2961  int idx,
2962  unsigned int flags);
2963 
2981 # define canOBJBUF_AUTO_RESPONSE_RTR_ONLY 0x01
2982 
3004 canStatus CANLIBAPI canObjBufSetPeriod (const CanHandle hnd,
3005  int idx,
3006  unsigned int period);
3007 
3028 canStatus CANLIBAPI canObjBufSetMsgCount (const CanHandle hnd,
3029  int idx,
3030  unsigned int count);
3031 
3051 canStatus CANLIBAPI canObjBufEnable (const CanHandle hnd, int idx);
3052 
3072 canStatus CANLIBAPI canObjBufDisable (const CanHandle hnd, int idx);
3073 
3097 canStatus CANLIBAPI canObjBufSendBurst (const CanHandle hnd,
3098  int idx,
3099  unsigned int burstlen);
3100 
3101 
3124 canStatus CANLIBAPI canResetBus (const CanHandle hnd);
3125 
3162 canStatus CANLIBAPI canWriteWait (const CanHandle hnd,
3163  long id,
3164  void *msg,
3165  unsigned int dlc,
3166  unsigned int flag,
3167  unsigned long timeout);
3168 
3169 
3185 canStatus CANLIBAPI canUnloadLibrary (void);
3186 
3246 canStatus CANLIBAPI canSetAcceptanceFilter (const CanHandle hnd,
3247  unsigned int code,
3248  unsigned int mask,
3249  int is_extended);
3273 canStatus CANLIBAPI canFlushReceiveQueue (const CanHandle hnd);
3274 
3299 canStatus CANLIBAPI canFlushTransmitQueue (const CanHandle hnd);
3300 
3301 
3310 #define kvLED_ACTION_ALL_LEDS_ON 0
3311 #define kvLED_ACTION_ALL_LEDS_OFF 1
3312 #define kvLED_ACTION_LED_0_ON 2
3313 #define kvLED_ACTION_LED_0_OFF 3
3314 #define kvLED_ACTION_LED_1_ON 4
3315 #define kvLED_ACTION_LED_1_OFF 5
3316 #define kvLED_ACTION_LED_2_ON 6
3317 #define kvLED_ACTION_LED_2_OFF 7
3318 #define kvLED_ACTION_LED_3_ON 8
3319 #define kvLED_ACTION_LED_3_OFF 9
3320 #define kvLED_ACTION_LED_4_ON 10
3321 #define kvLED_ACTION_LED_4_OFF 11
3322 #define kvLED_ACTION_LED_5_ON 12
3323 #define kvLED_ACTION_LED_5_OFF 13
3324 #define kvLED_ACTION_LED_6_ON 14
3325 #define kvLED_ACTION_LED_6_OFF 15
3326 #define kvLED_ACTION_LED_7_ON 16
3327 #define kvLED_ACTION_LED_7_OFF 17
3328 #define kvLED_ACTION_LED_8_ON 18
3329 #define kvLED_ACTION_LED_8_OFF 19
3330 #define kvLED_ACTION_LED_9_ON 20
3331 #define kvLED_ACTION_LED_9_OFF 21
3332 #define kvLED_ACTION_LED_10_ON 22
3333 #define kvLED_ACTION_LED_10_OFF 23
3334 #define kvLED_ACTION_LED_11_ON 24
3335 #define kvLED_ACTION_LED_11_OFF 25
3336 
3337 
3360 canStatus CANLIBAPI kvFlashLeds (const CanHandle hnd, int action, int timeout);
3361 
3381 canStatus CANLIBAPI canRequestChipStatus (const CanHandle hnd);
3382 
3409 canStatus CANLIBAPI canRequestBusStatistics (const CanHandle hnd);
3410 
3416 typedef struct canBusStatistics_s {
3417  unsigned long stdData;
3418  unsigned long stdRemote;
3419  unsigned long extData;
3420  unsigned long extRemote;
3421  unsigned long errFrame;
3422 
3427  unsigned long busLoad;
3428  unsigned long overruns;
3430 
3453 canStatus CANLIBAPI canGetBusStatistics (const CanHandle hnd,
3454  canBusStatistics *stat,
3455  size_t bufsiz);
3456 
3457 
3478 canStatus CANLIBAPI canGetHandleData (const CanHandle hnd,
3479  int item,
3480  void *buffer,
3481  size_t bufsize);
3482 
3484 typedef void *kvTimeDomain;
3485 
3488 
3493 typedef struct kvTimeDomainData_s {
3499 
3528 kvStatus CANLIBAPI kvTimeDomainCreate (kvTimeDomain *domain);
3529 
3552 kvStatus CANLIBAPI kvTimeDomainDelete (kvTimeDomain domain);
3553 
3579 kvStatus CANLIBAPI kvTimeDomainResetTime (kvTimeDomain domain);
3580 
3605 kvStatus CANLIBAPI kvTimeDomainGetData (kvTimeDomain domain,
3606  kvTimeDomainData *data,
3607  size_t bufsiz);
3608 
3631 kvStatus CANLIBAPI kvTimeDomainAddHandle(kvTimeDomain domain,
3632  const CanHandle hnd);
3633 
3655 kvStatus CANLIBAPI kvTimeDomainRemoveHandle (kvTimeDomain domain,
3656  const CanHandle hnd);
3657 
3670 typedef void (CANLIBAPI *kvCallback_t) (CanHandle hnd, void* context, unsigned int notifyEvent);
3671 
3705 kvStatus CANLIBAPI kvSetNotifyCallback (const CanHandle hnd,
3706  kvCallback_t callback,
3707  void* context,
3708  unsigned int notifyFlags);
3709 
3723 #define kvBUSTYPE_NONE 0
3724 
3729 #define kvBUSTYPE_PCI 1
3730 
3735 #define kvBUSTYPE_PCMCIA 2
3736 
3741 #define kvBUSTYPE_USB 3
3742 
3747 #define kvBUSTYPE_WLAN 4
3748 
3753 #define kvBUSTYPE_PCI_EXPRESS 5
3754 
3759 #define kvBUSTYPE_ISA 6
3760 
3765 #define kvBUSTYPE_VIRTUAL 7
3766 
3771 #define kvBUSTYPE_PC104_PLUS 8
3772 
3777 #define kvBUSTYPE_LAN 9
3778 
3794 #define kvBUSTYPE_GROUP_VIRTUAL 1
3795 
3800 #define kvBUSTYPE_GROUP_LOCAL 2
3801 
3806 #define kvBUSTYPE_GROUP_REMOTE 3
3807 
3811 #define kvBUSTYPE_GROUP_INTERNAL 4
3812 
3866 kvStatus CANLIBAPI kvGetSupportedInterfaceInfo (int index,
3867  char *hwName,
3868  size_t nameLen,
3869  int *hwType,
3870  int *hwBusType);
3871 
3896 kvStatus CANLIBAPI kvReadDeviceCustomerData (const CanHandle hnd,
3897  int userNumber,
3898  int itemNumber,
3899  void *data,
3900  size_t bufsiz);
3901 
3915 #define kvENVVAR_TYPE_INT 1
3916 
3922 #define kvENVVAR_TYPE_FLOAT 2
3923 
3929 #define kvENVVAR_TYPE_STRING 3
3930 
3946 #define kvEVENT_TYPE_KEY 1
3947 
3955  typedef int64_t kvEnvHandle;
3956 
3976 kvStatus CANLIBAPI kvScriptStart (const CanHandle hnd, int slotNo);
3977 
3984 #define kvSCRIPT_STOP_NORMAL 0
3985 #define kvSCRIPT_STOP_FORCED -9
4009 kvStatus CANLIBAPI kvScriptStop (const CanHandle hnd, int slotNo, int mode);
4010 
4029 kvStatus CANLIBAPI kvScriptUnload (const CanHandle hnd, int slotNo);
4030 
4055 kvStatus CANLIBAPI kvScriptSendEvent (const CanHandle hnd,
4056  int slotNo,
4057  int eventType,
4058  int eventNo,
4059  unsigned int data);
4060 
4087 kvEnvHandle CANLIBAPI kvScriptEnvvarOpen (const CanHandle hnd,
4088  char* envvarName,
4089  int *envvarType,
4090  int *envvarSize); // returns scriptHandle
4091 
4111 kvStatus CANLIBAPI kvScriptEnvvarClose (kvEnvHandle eHnd);
4112 
4135 kvStatus CANLIBAPI kvScriptEnvvarSetInt (kvEnvHandle eHnd, int val);
4136 
4160 kvStatus CANLIBAPI kvScriptEnvvarGetInt (kvEnvHandle eHnd, int *val);
4161 
4184 kvStatus CANLIBAPI kvScriptEnvvarSetFloat (kvEnvHandle eHnd, float val);
4185 
4209 kvStatus CANLIBAPI kvScriptEnvvarGetFloat (kvEnvHandle eHnd, float *val);
4210 
4237 kvStatus CANLIBAPI kvScriptEnvvarSetData (kvEnvHandle eHnd,
4238  void *buf,
4239  int start_index,
4240  int data_len);
4241 
4267 kvStatus CANLIBAPI kvScriptEnvvarGetData (kvEnvHandle eHnd,
4268  void *buf,
4269  int start_index,
4270  int data_len);
4271 
4297 kvStatus CANLIBAPI kvScriptLoadFileOnDevice (const CanHandle hnd,
4298  int slotNo,
4299  char *localFile);
4300 
4324 kvStatus CANLIBAPI kvScriptLoadFile (const CanHandle hnd,
4325  int slotNo,
4326  char *filePathOnPC);
4327 
4328 
4329 
4336 #define kvSCRIPT_STATUS_LOADED 1
4337 #define kvSCRIPT_STATUS_RUNNING 2
4359 kvStatus CANLIBAPI kvScriptStatus(const CanHandle hnd,
4360  int slot,
4361  unsigned int *status);
4362 
4363 
4364 
4387 kvStatus CANLIBAPI kvFileCopyToDevice (const CanHandle hnd,
4388  char *hostFileName,
4389  char *deviceFileName);
4390 
4413 kvStatus CANLIBAPI kvFileCopyFromDevice (const CanHandle hnd,
4414  char *deviceFileName,
4415  char *hostFileName);
4416 
4438 kvStatus CANLIBAPI kvFileDelete (const CanHandle hnd, char *deviceFileName);
4439 
4462 kvStatus CANLIBAPI kvFileGetName (const CanHandle hnd,
4463  int fileNo,
4464  char *name,
4465  int namelen);
4466 
4486 kvStatus CANLIBAPI kvFileGetCount (const CanHandle hnd, int *count);
4487 
4510 kvStatus CANLIBAPI kvFileGetSystemData (const CanHandle hnd,
4511  int itemCode,
4512  int *result);
4513 
4531 #define kvDEVICE_MODE_INTERFACE 0x00
4532 
4537 #define kvDEVICE_MODE_LOGGER 0x01
4538 
4563 kvStatus CANLIBAPI kvDeviceSetMode (const CanHandle hnd, int mode);
4564 
4587 kvStatus CANLIBAPI kvDeviceGetMode (const CanHandle hnd, int *result);
4588 
4589 
4614 kvStatus CANLIBAPI kvReadTimer (const CanHandle hnd, unsigned int *time);
4638 kvStatus CANLIBAPI kvReadTimer64 (const CanHandle hnd, uint64_t *time);
4639 
4640 #ifdef __cplusplus
4641 }
4642 #endif /* __cplusplus */
4643 
4644 #include "obsolete.h"
4645 
4646 
4647 
4648 #endif /* _CANLIB_H_ */
Definitions which are retained for compatibility.
kvStatus kvScriptEnvvarGetFloat(kvEnvHandle eHnd, float *val)
unsigned long stdRemote
Number of received standard (11-bit identifiers) remote frames.
Definition: canlib.h:3418
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)
unsigned char busStatus
Definition: canlib.h:161
canStatus canGetBusOutputControl(const CanHandle hnd, unsigned int *drivertype)
kvStatus kvTimeDomainDelete(kvTimeDomain domain)
canStatus canGetDriverMode(const CanHandle hnd, int *lineMode, int *resNet)
struct canNotifyData::@0::@2 rx
void canInitializeLibrary(void)
canStatus canReadStatus(const CanHandle hnd, unsigned long *const flags)
kvStatus kvTimeDomainCreate(kvTimeDomain *domain)
unsigned int portNo
Port number used in e.g. canIOCTL_SET_USER_IOPORT.
Definition: canlib.h:2673
int64_t kvEnvHandle
Definition: canlib.h:3955
int nNonMagiSyncCards
number of non MagiSync™ interfaces
Definition: canlib.h:3496
kvStatus kvScriptEnvvarSetData(kvEnvHandle eHnd, void *buf, int start_index, int data_len)
canStatus canRequestBusStatistics(const CanHandle hnd)
kvStatus kvDeviceSetMode(const CanHandle hnd, int mode)
canStatus canReadTimer(const CanHandle hnd, unsigned long *time)
void * kvTimeDomain
Definition: canlib.h:3484
unsigned char rxErrorCounter
Definition: canlib.h:163
unsigned long extRemote
Number of received extended (29-bit identifiers) remote frames.
Definition: canlib.h:3420
canStatus canClose(const CanHandle hnd)
struct canNotifyData canNotifyData
kvStatus kvFileGetCount(const CanHandle hnd, int *count)
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)
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)
int canHandle
Definition: canlib.h:138
canStatus canObjBufDisable(const CanHandle hnd, int idx)
void * tag
Definition: canlib.h:146
canStatus canGetBusParams(const CanHandle hnd, long *freq, unsigned int *tseg1, unsigned int *tseg2, unsigned int *sjw, unsigned int *noSamp, unsigned int *syncmode)
kvStatus kvScriptEnvvarGetInt(kvEnvHandle eHnd, int *val)
Definitions for the CANLIB API.
canStatus canSetBusOutputControl(const CanHandle hnd, const unsigned int drivertype)
int eventType
Definition: canlib.h:147
kvStatus kvFileGetSystemData(const CanHandle hnd, int itemCode, int *result)
kvStatus kvScriptEnvvarSetInt(kvEnvHandle eHnd, int val)
canStatus canObjBufSendBurst(const CanHandle hnd, int idx, unsigned int burstlen)
canStatus canGetRawHandle(const CanHandle hnd, void *pvFd)
canStatus canBusOn(const CanHandle hnd)
long id
Definition: canlib.h:153
canStatus canWriteWait(const CanHandle hnd, long id, void *msg, unsigned int dlc, unsigned int flag, unsigned long timeout)
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)
canStatus canObjBufWrite(const CanHandle hnd, int idx, int id, void *msg, unsigned int dlc, unsigned int flags)
Definition: canlib.h:145
struct kvTimeDomainData_s kvTimeDomainData
kvStatus kvScriptEnvvarClose(kvEnvHandle eHnd)
canStatus canFlushReceiveQueue(const CanHandle hnd)
kvStatus kvScriptLoadFile(const CanHandle hnd, int slotNo, char *filePathOnPC)
unsigned int portValue
Port value used in e.g. canIOCTL_SET_USER_IOPORT.
Definition: canlib.h:2674
unsigned short canGetVersion(void)
unsigned long errFrame
Number of error frames.
Definition: canlib.h:3421
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)
canStatus canFlushTransmitQueue(const CanHandle hnd)
kvStatus kvReadTimer64(const CanHandle hnd, uint64_t *time)
kvStatus kvFileGetName(const CanHandle hnd, int fileNo, char *name, int namelen)
kvStatus kvTimeDomainResetTime(kvTimeDomain domain)
kvStatus kvFileDelete(const CanHandle hnd, char *deviceFileName)
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:3419
kvStatus kvReadTimer(const CanHandle hnd, unsigned int *time)
canStatus canObjBufEnable(const CanHandle hnd, int idx)
kvStatus kvSetNotifyCallback(const CanHandle hnd, kvCallback_t callback, void *context, unsigned int notifyFlags)
kvStatus kvScriptSendEvent(const CanHandle hnd, int slotNo, int eventType, int eventNo, unsigned int data)
kvStatus kvTimeDomainGetData(kvTimeDomain domain, kvTimeDomainData *data, size_t bufsiz)
kvStatus kvScriptStart(const CanHandle hnd, int slotNo)
kvStatus kvTimeDomainRemoveHandle(kvTimeDomain domain, const CanHandle hnd)
canStatus canSetNotify(const CanHandle hnd, void(*callback)(canNotifyData *), unsigned int notifyFlags, void *tag)
unsigned char txErrorCounter
Definition: canlib.h:162
canStatus canObjBufSetFlags(const CanHandle hnd, int idx, unsigned int flags)
kvEnvHandle kvScriptEnvvarOpen(const CanHandle hnd, char *envvarName, int *envvarType, int *envvarSize)
void(* kvCallback_t)(CanHandle hnd, void *context, unsigned int notifyEvent)
Definition: canlib.h:3670
canStatus canSetBusParamsC200(const CanHandle hnd, unsigned char btr0, unsigned char btr1)
int nMagiSyncGroups
number of MagiSync™ groups
Definition: canlib.h:3494
canStatus canReadSpecificSkip(const CanHandle hnd, long id, void *msg, unsigned int *dlc, unsigned int *flag, unsigned long *time)
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:80
kvStatus kvFileCopyFromDevice(const CanHandle hnd, char *deviceFileName, char *hostFileName)
kvStatus kvDeviceGetMode(const CanHandle hnd, int *result)
canStatus canReadErrorCounters(const CanHandle hnd, unsigned int *txErr, unsigned int *rxErr, unsigned int *ovErr)
unsigned long stdData
Number of received standard (11-bit identifiers) data frames.
Definition: canlib.h:3417
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:3428
kvStatus kvTimeDomainAddHandle(kvTimeDomain domain, const CanHandle hnd)
Definition: canlib.h:3493
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)
canStatus canGetErrorText(canStatus err, char *buf, unsigned int bufsiz)
unsigned long busLoad
Definition: canlib.h:3427
canStatus canRequestChipStatus(const CanHandle hnd)
Definition: canlib.h:3416
kvStatus kvScriptLoadFileOnDevice(const CanHandle hnd, int slotNo, char *localFile)
canStatus canUnloadLibrary(void)
struct canNotifyData::@0::@1 busErr
canHandle CanHandle
Definition: canlib.h:143
canStatus kvStatus
Definition: canlib.h:3487
Definition: canlib.h:2672
union canNotifyData::@0 info
canStatus canResetBus(const CanHandle hnd)
canStatus canObjBufAllocate(const CanHandle hnd, int type)
int nNonMagiSyncedMembers
number of non MagiSync™ members
Definition: canlib.h:3497
canStatus canGetNumberOfChannels(int *channelCount)
canStatus canGetHandleData(const CanHandle hnd, int item, void *buffer, size_t bufsize)
kvStatus kvScriptEnvvarGetData(kvEnvHandle eHnd, void *buf, int start_index, int data_len)
unsigned long time
Definition: canlib.h:150
kvStatus kvFileCopyToDevice(const CanHandle hnd, char *hostFileName, char *deviceFileName)
canStatus canReadSync(const CanHandle hnd, unsigned long timeout)
kvStatus kvScriptUnload(const CanHandle hnd, int slotNo)
canStatus canObjBufSetPeriod(const CanHandle hnd, int idx, unsigned int period)
canStatus canObjBufFreeAll(const CanHandle hnd)
canStatus canIoCtl(const CanHandle hnd, unsigned int func, void *buf, unsigned int buflen)
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
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:3495