├── macosx ├── k8055.h ├── k8055.cpp ├── English.lproj │ ├── InfoPlist.strings │ └── locversion.plist ├── install.sh ├── Info.plist └── k8055.xcodeproj │ └── project.pbxproj ├── AUTHORS ├── Makefile.am ├── src ├── Makefile.am ├── k8055.h ├── test_k8055.c ├── k8055mqtt.c └── k8055.c ├── .gitignore ├── configure.ac ├── autogen.sh ├── README.md └── COPYING /macosx/k8055.h: -------------------------------------------------------------------------------- 1 | /* add your code here */ -------------------------------------------------------------------------------- /macosx/k8055.cpp: -------------------------------------------------------------------------------- 1 | /* add your code here */ -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Nicholas J. Humfrey 2 | -------------------------------------------------------------------------------- /Makefile.am: -------------------------------------------------------------------------------- 1 | AUTOMAKE_OPTIONS = foreign 2 | ACLOCAL_AMFLAGS = -I build-scripts 3 | SUBDIRS = src . 4 | -------------------------------------------------------------------------------- /macosx/English.lproj/InfoPlist.strings: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/njh/k8055mqtt/main/macosx/English.lproj/InfoPlist.strings -------------------------------------------------------------------------------- /src/Makefile.am: -------------------------------------------------------------------------------- 1 | AM_CFLAGS = $(LIBUSB_CFLAGS) 2 | 3 | bin_PROGRAMS = k8055mqtt 4 | k8055mqtt_LDADD = $(LIBUSB_LIBS) -lmosquitto 5 | k8055mqtt_SOURCES = k8055mqtt.c k8055.c k8055.h 6 | 7 | noinst_PROGRAMS = test_k8055 8 | test_k8055_LDADD = $(LIBUSB_LIBS) 9 | test_k8055_SOURCES = test_k8055.c k8055.c k8055.h 10 | -------------------------------------------------------------------------------- /macosx/English.lproj/locversion.plist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | LprojCompatibleVersion 6 | 288.1 7 | LprojLocale 8 | en 9 | LprojRevisionLevel 10 | 1 11 | LprojVersion 12 | 307 13 | 14 | 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .deps 2 | .libs 3 | *.a 4 | *.gz 5 | *.la 6 | *.lo 7 | *.o 8 | aclocal.m4 9 | autom4te.cache 10 | build-scripts/*.m4 11 | build-scripts/config.guess 12 | build-scripts/config.sub 13 | build-scripts/depcomp 14 | build-scripts/install-sh 15 | build-scripts/ltmain.sh 16 | build-scripts/missing 17 | config.cache 18 | config.log 19 | config.status 20 | configure 21 | libtool 22 | Makefile 23 | Makefile.in 24 | stamp-h1 25 | 26 | macosx/k8055.xcodeproj/*.mode1v3 27 | macosx/k8055.xcodeproj/*.pbxuser 28 | 29 | src/k8055mqtt 30 | src/test_k8055 31 | src/config.h 32 | src/config.h.in 33 | src/config.h.in~ 34 | -------------------------------------------------------------------------------- /macosx/install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | INSTALLED="/Library/Extensions/k8055.kext" 4 | 5 | # Uninstall previous extension 6 | if [ -e $INSTALLED ]; then 7 | sudo kextunload -verbose $INSTALLED 8 | sudo rm -Rf $INSTALLED 9 | fi 10 | 11 | # Compile new extension 12 | xcodebuild -project k8055.xcodeproj -target k8055 -configuration Deployment clean build 13 | 14 | if [ ! -e "build/Deployment/k8055.kext" ]; then 15 | echo "Failed to build extension" 16 | exit -1 17 | fi 18 | 19 | 20 | # Install new extension 21 | sudo cp -R build/Deployment/k8055.kext $INSTALLED 22 | sudo chown -R root:wheel $INSTALLED 23 | sudo kextload -verbose $INSTALLED 24 | -------------------------------------------------------------------------------- /src/k8055.h: -------------------------------------------------------------------------------- 1 | #ifndef K8055_H 2 | #define K8055_H 3 | 4 | typedef struct k8055_s k8055_t; 5 | 6 | k8055_t* k8055_device_open(int card_address); 7 | int k8055_device_reset(k8055_t* dev); 8 | int k8055_device_poll(k8055_t* dev); 9 | int k8055_device_close(k8055_t* dev); 10 | 11 | void k8055_digital_out_set(k8055_t* dev, int value); 12 | int k8055_digital_out_get(k8055_t* dev); 13 | int k8055_digital_out_get_channel(k8055_t* dev, int channel); 14 | void k8055_digital_out_set_channel(k8055_t* dev, int channel); 15 | void k8055_digital_out_clear_channel(k8055_t* dev, int channel); 16 | 17 | int k8055_digital_in_get(k8055_t* dev); 18 | int k8055_counter_get(k8055_t* dev, int channel); 19 | int k8055_counter_reset(k8055_t* dev, int channel); 20 | 21 | void k8055_analogue_out_set(k8055_t* dev, int channel, int value); 22 | int k8055_analogue_out_get(k8055_t* dev, int channel); 23 | 24 | int k8055_analogue_in_get(k8055_t* dev, int channel); 25 | 26 | 27 | #endif 28 | -------------------------------------------------------------------------------- /src/test_k8055.c: -------------------------------------------------------------------------------- 1 | 2 | #include 3 | 4 | #include "k8055.h" 5 | 6 | 7 | int main(int argc, char *params[]) 8 | { 9 | k8055_t *dev = k8055_device_open(0); 10 | int i; 11 | 12 | if (dev) { 13 | printf("Successfully opened K8055 device.\n"); 14 | } 15 | 16 | k8055_device_reset(dev); 17 | k8055_counter_reset(dev, 1); 18 | k8055_counter_reset(dev, 2); 19 | 20 | for(i=1; i<=8; i++) { 21 | k8055_digital_out_set_channel(dev, i); 22 | k8055_device_poll(dev); 23 | sleep(1); 24 | k8055_digital_out_clear_channel(dev, i); 25 | k8055_device_poll(dev); 26 | 27 | printf("Digital: 0x%2.2x\n", k8055_digital_in_get(dev)); 28 | printf("Analogue: %d, %d\n", k8055_analogue_in_get(dev, 1), k8055_analogue_in_get(dev, 2)); 29 | printf("Counters: %d, %d\n", k8055_counter_get(dev, 1), k8055_counter_get(dev, 2)); 30 | } 31 | 32 | k8055_digital_out_set(dev, 0x00); 33 | k8055_device_poll(dev); 34 | 35 | k8055_device_close(dev); 36 | } 37 | -------------------------------------------------------------------------------- /configure.ac: -------------------------------------------------------------------------------- 1 | dnl Require autoconf version >= 2.60 2 | AC_PREREQ(2.60) 3 | 4 | 5 | dnl ############# Initialization 6 | 7 | AC_INIT([k8055mqtt], [0.1], [njh@aelius.com], k8055mqtt) 8 | 9 | AC_CONFIG_SRCDIR([src/k8055mqtt.c]) 10 | AC_CONFIG_AUX_DIR(build-scripts) 11 | AC_CONFIG_MACRO_DIR(build-scripts) 12 | AM_INIT_AUTOMAKE([1.10]) 13 | 14 | 15 | dnl ############# Compiler and tools Checks 16 | 17 | AC_PROG_CC 18 | AC_PROG_INSTALL 19 | AC_PROG_LN_S 20 | 21 | AC_C_BIGENDIAN 22 | AC_C_INLINE 23 | AC_C_CONST 24 | 25 | 26 | dnl ############## Header and function checks 27 | 28 | AC_HEADER_STDC 29 | AC_CHECK_HEADERS([stdlib.h]) 30 | AC_FUNC_MALLOC 31 | AC_FUNC_REALLOC 32 | 33 | 34 | dnl ############## Check for packages we depend upon 35 | 36 | PKG_CHECK_MODULES(LIBUSB, libusb-1.0 >= 1.0.8) 37 | 38 | AC_CHECK_LIB([mosquitto], [mosquitto_lib_init],, AC_ERROR([Misssing mosquitto client library])) 39 | AC_CHECK_FUNC([mosquitto_connack_string],, AC_ERROR([Misssing the mosquitto_connack_string function])) 40 | AC_CHECK_FUNC([mosquitto_log_callback_set],, AC_ERROR([Misssing the mosquitto_log_callback_set function])) 41 | AC_CHECK_HEADERS([mosquitto.h], [], [AC_ERROR([Missing mosquitto header file])]) 42 | 43 | 44 | dnl ############## Output files 45 | 46 | AC_CONFIG_HEADERS([src/config.h]) 47 | 48 | AC_CONFIG_FILES([ 49 | Makefile 50 | src/Makefile 51 | ]) 52 | 53 | AC_OUTPUT 54 | -------------------------------------------------------------------------------- /autogen.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # Run this to set up the build system: configure, makefiles, etc. 3 | 4 | package="k8055mqtt" 5 | 6 | srcdir=`dirname $0` 7 | test -z "$srcdir" && srcdir=. 8 | 9 | cd "$srcdir" 10 | DIE=0 11 | 12 | (autoconf --version) < /dev/null > /dev/null 2>&1 || { 13 | echo 14 | echo "You must have autoconf installed to compile $package." 15 | echo "Download the appropriate package for your distribution," 16 | echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/autoconf" 17 | DIE=1 18 | } 19 | (automake --version) < /dev/null > /dev/null 2>&1 || { 20 | echo 21 | echo "You must have automake installed to compile $package." 22 | echo "Download the appropriate package for your distribution," 23 | echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/automake" 24 | DIE=1 25 | } 26 | 27 | if test "$DIE" -eq 1; then 28 | exit 1 29 | fi 30 | 31 | # Do some cleanup 32 | rm -f config.cache config.log config.guess config.sub configure 33 | 34 | # Because GIT doesn't support empty directories 35 | if [ ! -d "$srcdir/build-scripts" ]; then 36 | mkdir "$srcdir/build-scripts" 37 | fi 38 | 39 | echo "Generating configuration files for $package, please wait...." 40 | 41 | echo " aclocal $ACLOCAL_FLAGS" 42 | aclocal $ACLOCAL_FLAGS 43 | echo " autoheader" 44 | autoheader 45 | echo " automake --add-missing" 46 | automake --add-missing --force --copy 47 | echo " autoconf" 48 | autoconf 49 | 50 | ./configure 51 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | k8055mqtt 2 | ========= 3 | 4 | Self contained MQTT daemon for controlling the the [Velleman K8055] / [VM110] Board. 5 | 6 | 7 | Requirements 8 | ------------ 9 | 10 | * [libusb] version 1.0.8 or higher 11 | * [mosquitto] library version 0.14 or higher 12 | 13 | 14 | Usage 15 | ----- 16 | 17 | k8055mqtt version 0.1 18 | 19 | Usage: k8055mqtt [options] 20 | -h the MQTT server to connect to (required) 21 | -p the MQTT port to connect to (default 1883) 22 | -t the MQTT topic prefix (default k8055) 23 | -? This help message. 24 | 25 | 26 | Examples 27 | -------- 28 | 29 | Starting the daemon: 30 | 31 | ./src/k8055mqtt -h test.mosquitto.org 32 | 33 | Turn on digital output 1: 34 | 35 | mosquitto_pub -h test.mosquitto.org -t k8055/digital/out/1 -m 1 36 | 37 | Turn off all digital outputs: 38 | 39 | mosquitto_pub -h test.mosquitto.org -t k8055/digital/out -m 0x00 40 | 41 | Set analogue output channel 1 to 50%: 42 | 43 | mosquitto_pub -h test.mosquitto.org -t k8055/analogue/out/1 -m 127 44 | 45 | 46 | Installation 47 | ------------ 48 | 49 | k8055mqtt uses a standard automake build process: 50 | 51 | ./configure 52 | make 53 | make install 54 | 55 | 56 | Credits 57 | ------- 58 | 59 | k8055mqtt is based on [libk8055] by Sven Lindberg and Pjetur G. Hjaltason. 60 | 61 | The Mac OS X Kernel Extension is from [k8055 for Mac OS X and Linux] by Julien Etelain and Edward Nys. 62 | 63 | 64 | License 65 | ------- 66 | 67 | This program is free software: you can redistribute it and/or modify 68 | it under the terms of the [GNU General Public License] as published by 69 | the Free Software Foundation, either version 3 of the License, or 70 | (at your option) any later version. 71 | 72 | This program is distributed in the hope that it will be useful, 73 | but WITHOUT ANY WARRANTY; without even the implied warranty of 74 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 75 | GNU General Public License for more details. 76 | 77 | 78 | [Velleman]: http://www.velleman.eu/ 79 | [Velleman K8055]: http://www.velleman.eu/products/view/?id=351346 80 | [VM110]: http://www.velleman.eu/products/view/?id=351980 81 | [libusb]: http://libusb.org/ 82 | [mosquitto]: http://mosquitto.org/ 83 | [k8055 for Mac OS X and Linux]: http://soft.pmad.net/k8055/ 84 | [libk8055]: http://libk8055.sourceforge.net/ 85 | [GNU General Public License]: http://www.gnu.org/licenses/gpl.html 86 | -------------------------------------------------------------------------------- /macosx/Info.plist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | CFBundleDevelopmentRegion 6 | English 7 | CFBundleIconFile 8 | 9 | CFBundleIdentifier 10 | com.utbm.driver.k8055 11 | CFBundleInfoDictionaryVersion 12 | 6.0 13 | CFBundlePackageType 14 | KEXT 15 | CFBundleSignature 16 | ???? 17 | CFBundleVersion 18 | 1.0.0d1 19 | IOKitPersonalities 20 | 21 | K8055 Card1 22 | 23 | CFBundleIdentifier 24 | com.apple.kpi.iokit 25 | IOClass 26 | IOService 27 | IOProbeScore 28 | 11000 29 | IOProviderClass 30 | IOUSBInterface 31 | bConfigurationValue 32 | 1 33 | bInterfaceNumber 34 | 0 35 | idProduct 36 | 21760 37 | idVendor 38 | 4303 39 | 40 | K8055 Card2 41 | 42 | CFBundleIdentifier 43 | com.apple.kpi.iokit 44 | IOClass 45 | IOService 46 | IOProbeScore 47 | 11000 48 | IOProviderClass 49 | IOUSBInterface 50 | bConfigurationValue 51 | 1 52 | bInterfaceNumber 53 | 0 54 | idProduct 55 | 21761 56 | idVendor 57 | 4303 58 | 59 | K8055 Card3 60 | 61 | CFBundleIdentifier 62 | com.apple.kpi.iokit 63 | IOClass 64 | IOService 65 | IOProbeScore 66 | 11000 67 | IOProviderClass 68 | IOUSBInterface 69 | bConfigurationValue 70 | 1 71 | bInterfaceNumber 72 | 0 73 | idProduct 74 | 21762 75 | idVendor 76 | 4303 77 | 78 | K8055 Card4 79 | 80 | CFBundleIdentifier 81 | com.apple.kpi.iokit 82 | IOClass 83 | IOService 84 | IOProbeScore 85 | 11000 86 | IOProviderClass 87 | IOUSBInterface 88 | bConfigurationValue 89 | 1 90 | bInterfaceNumber 91 | 0 92 | idProduct 93 | 21763 94 | idVendor 95 | 4303 96 | 97 | 98 | OSBundleLibraries 99 | 100 | com.apple.iokit.IOUSBFamily 101 | 1.8 102 | com.apple.kpi.iokit 103 | 9.0 104 | 105 | OSBundleRequired 106 | Root 107 | 108 | 109 | -------------------------------------------------------------------------------- /src/k8055mqtt.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | 8 | #include 9 | #include "k8055.h" 10 | #include "config.h" 11 | 12 | #define MAX_TOPIC_LEN (127) 13 | #define DEFAULT_MQTT_PORT (1883) 14 | #define DEFAULT_KEEP_ALIVE (60) 15 | #define DEFAULT_PREFIX "k8055" 16 | #define DEFAULT_CLIENT_ID "k8055" 17 | 18 | struct mosquitto *mosq = NULL; 19 | char *mqtt_prefix = DEFAULT_PREFIX; 20 | char *mqtt_client_id = DEFAULT_CLIENT_ID; 21 | int mqtt_connected = 0; 22 | int keep_running = 1; 23 | int exit_code = EXIT_SUCCESS; 24 | k8055_t *dev = NULL; 25 | 26 | 27 | 28 | static void connect_callback(struct mosquitto *mosq, void *obj, int rc) 29 | { 30 | if(!rc){ 31 | printf("Connected to MQTT server.\n"); 32 | mqtt_connected = 1; 33 | } else { 34 | const char *str = mosquitto_connack_string(rc); 35 | fprintf(stderr, "Connection Refused: %s\n", str); 36 | mqtt_connected = 0; 37 | } 38 | } 39 | 40 | 41 | static void disconnect_callback(struct mosquitto *mosq, void *obj, int rc) 42 | { 43 | mqtt_connected = 0; 44 | 45 | // FIXME: re-establish the connection 46 | // FIXME: keep count of re-connects 47 | } 48 | 49 | static void message_callback(struct mosquitto *mosq, void *obj, const struct mosquitto_message *mesg) 50 | { 51 | size_t prefix_len = strlen(mqtt_prefix); 52 | size_t topic_len = 0; 53 | char* topic = NULL; 54 | int value = 0; 55 | 56 | // Check that the topic prefix matches 57 | if (strncmp(mesg->topic, mqtt_prefix, prefix_len) != 0) { 58 | printf("Topic didn't match: %s\n", mesg->topic); 59 | return; 60 | } else { 61 | topic = mesg->topic + prefix_len; 62 | topic_len = strlen(topic); 63 | } 64 | 65 | // Check the topic name 66 | if (topic_len == 12 && strncmp(topic, "/digital/out", topic_len) == 0) { 67 | if (sscanf((char*)mesg->payload, "%i", &value) == 1) { 68 | printf("Setting digital to: 0x%2.2x\n", value); 69 | k8055_digital_out_set(dev, value); 70 | } 71 | } else if (topic_len == 14 && strncmp(topic, "/digital/out/", 13) == 0) { 72 | if (sscanf((char*)mesg->payload, "%i", &value) == 1) { 73 | int channel = atoi(&topic[13]); 74 | printf("Setting digital channel %d to: %d\n", channel, value); 75 | if (value) { 76 | k8055_digital_out_set_channel(dev, channel); 77 | } else { 78 | k8055_digital_out_clear_channel(dev, channel); 79 | } 80 | } 81 | } else if (topic_len == 15 && strncmp(topic, "/analogue/out/", 14) == 0) { 82 | if (sscanf((char*)mesg->payload, "%i", &value) == 1) { 83 | int channel = atoi(&topic[14]); 84 | printf("Setting analogue channel %d to: %d\n", channel, value); 85 | k8055_analogue_out_set(dev, channel, value); 86 | } 87 | } else if (topic_len == 10 && strncmp(topic, "/counter/", 9) == 0) { 88 | if (strncmp((char*)mesg->payload, "reset", 5)==0) { 89 | int channel = atoi(&topic[9]); 90 | printf("Resettting counter %d\n", channel); 91 | k8055_counter_reset(dev, channel); 92 | } 93 | } else { 94 | printf("Unhandled message to %s: %s\n", topic, (char*)mesg->payload); 95 | } 96 | } 97 | 98 | static void log_callback(struct mosquitto *mosq, void *obj, int level, const char *str) 99 | { 100 | printf("LOG: %s\n", str); 101 | } 102 | 103 | static mqtt_subscribe(struct mosquitto *mosq, const char* topic) 104 | { 105 | int mid, res; 106 | 107 | res = mosquitto_subscribe(mosq, &mid, topic, 0); 108 | // FIXME: check for success 109 | // FIXME: wait for acknowledgement 110 | } 111 | 112 | static struct mosquitto * mqtt_initialise(const char* host, int port) 113 | { 114 | struct mosquitto *mosq = NULL; 115 | char subscribe_path[MAX_TOPIC_LEN+1]; 116 | int res = 0; 117 | 118 | // Create a new MQTT client 119 | mosq = mosquitto_new(mqtt_client_id, true, NULL); 120 | if (!mosq) { 121 | fprintf(stderr, "Failed to initialise MQTT client.\n"); 122 | return NULL; 123 | } 124 | 125 | // FIXME: add support for username and password 126 | 127 | // Setup callbacks 128 | mosquitto_log_callback_set(mosq, log_callback); 129 | mosquitto_connect_callback_set(mosq, connect_callback); 130 | mosquitto_disconnect_callback_set(mosq, disconnect_callback); 131 | mosquitto_message_callback_set(mosq, message_callback); 132 | 133 | printf("Connecting to %s:%d...\n", host, port); 134 | res = mosquitto_connect(mosq, host, port, DEFAULT_KEEP_ALIVE); 135 | if (res) { 136 | fprintf(stderr, "Unable to connect (%d).\n", res); 137 | mosquitto_destroy(mosq); 138 | return NULL; 139 | } 140 | 141 | // Wait until connected 142 | while (!mqtt_connected) { 143 | // FIXME: add timeout 144 | int res = mosquitto_loop(mosq, 500, 1); 145 | if (res != MOSQ_ERR_SUCCESS) exit(EXIT_FAILURE); 146 | } 147 | 148 | // Subscribe to every message starting with prefix 149 | snprintf(subscribe_path, MAX_TOPIC_LEN, "%s/#", mqtt_prefix); 150 | mqtt_subscribe(mosq, subscribe_path); 151 | // FIXME: check for error 152 | 153 | return mosq; 154 | } 155 | 156 | static void termination_handler(int signum) 157 | { 158 | switch(signum) { 159 | case SIGHUP: printf("Received SIGHUP, exiting.\n"); break; 160 | case SIGTERM: printf("Received SIGTERM, exiting.\n"); break; 161 | case SIGINT: printf("Received SIGINT, exiting.\n"); break; 162 | } 163 | 164 | keep_running = 0; 165 | } 166 | 167 | static void usage() 168 | { 169 | printf("%s version %s\n\n", PACKAGE_NAME, PACKAGE_VERSION); 170 | printf("Usage: %s [options]\n", PACKAGE_TARNAME); 171 | printf(" -h the MQTT server to connect to (required)\n"); 172 | printf(" -p the MQTT port to connect to (default %d)\n", DEFAULT_MQTT_PORT); 173 | printf(" -t the MQTT topic prefix (default %s)\n", DEFAULT_PREFIX); 174 | printf(" -i the MQTT Client ID (default %s)\n", DEFAULT_CLIENT_ID); 175 | printf(" -? This help message.\n"); 176 | } 177 | 178 | 179 | int main(int argc, char **argv) 180 | { 181 | const char* mqtt_host = NULL; 182 | int mqtt_port = DEFAULT_MQTT_PORT; 183 | int res; 184 | int c; 185 | 186 | // Make stdout unbuffered for logging/debugging 187 | setbuf(stdout, NULL); 188 | 189 | // Parse Switches 190 | while ((c = getopt(argc, argv, "h:pt:i:?")) != EOF) { 191 | switch (c) { 192 | case 'h': 193 | mqtt_host = optarg; 194 | break; 195 | case 'p': 196 | mqtt_port = atoi(optarg); 197 | break; 198 | case 't': 199 | mqtt_prefix = optarg; 200 | break; 201 | case 'i': 202 | mqtt_client_id = optarg; 203 | break; 204 | case '?': 205 | default: 206 | usage(); 207 | exit(EXIT_SUCCESS); 208 | break; 209 | } 210 | } 211 | 212 | if (mqtt_host == NULL) { 213 | usage(); 214 | exit(EXIT_FAILURE); 215 | } 216 | 217 | // Setup signal handlers - so we exit cleanly 218 | signal(SIGTERM, termination_handler); 219 | signal(SIGINT, termination_handler); 220 | signal(SIGHUP, termination_handler); 221 | 222 | // Connect to the USB device 223 | dev = k8055_device_open(0); 224 | if (!dev) { 225 | fprintf(stderr, "Failed to initialise K8055 device.\n"); 226 | exit(EXIT_FAILURE); 227 | } 228 | 229 | // Create MQTT client 230 | mosq = mqtt_initialise(mqtt_host, mqtt_port); 231 | if (!mosq) exit(EXIT_FAILURE); 232 | 233 | while (keep_running) { 234 | // Wait for network packets for a maximum of 0.5s 235 | res = mosquitto_loop(mosq, 500, 1); 236 | 237 | // Write output changes and poll for inputs 238 | k8055_device_poll(dev); 239 | } 240 | 241 | // Clean up 242 | if (mosq) mosquitto_destroy(mosq); 243 | k8055_device_close(dev); 244 | 245 | // exit_code is non-zero if something went wrong 246 | return exit_code; 247 | } -------------------------------------------------------------------------------- /src/k8055.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | 9 | #include 10 | #include "k8055.h" 11 | 12 | /* 13 | This library is based on libk8055 by Sven Lindberg and Pjetur G. Hjaltason 14 | 15 | Input packet format 16 | 17 | +---+---+---+---+---+---+---+---+ 18 | |DIn|Sta|A1 |A2 | C1 | C2 | 19 | +---+---+---+---+---+---+---+---+ 20 | DIn = Digital input in high nibble, except for input 3 in 0x01 21 | Sta = Status, Board number + 1 22 | A1 = Analog input 1, 0-255 23 | A2 = Analog input 2, 0-255 24 | C1 = Counter 1, 16 bits (lsb) 25 | C2 = Counter 2, 16 bits (lsb) 26 | 27 | Output packet format 28 | 29 | +---+---+---+---+---+---+---+---+ 30 | |CMD|DIG|An1|An2|Rs1|Rs2|Dbv|Dbv| 31 | +---+---+---+---+---+---+---+---+ 32 | CMD = Command 33 | DIG = Digital output bitmask 34 | An1 = Analog output 1 value, 0-255 35 | An2 = Analog output 2 value, 0-255 36 | Rs1 = Reset counter 1, command 3 37 | Rs2 = Reset counter 3, command 4 38 | Dbv = Debounce value for counter 1 and 2, command 1 and 2 39 | 40 | Or split by commands 41 | 42 | Cmd 0, Reset ?? 43 | Cmd 1, Set debounce Counter 1 44 | +---+---+---+---+---+---+---+---+ 45 | |CMD| | | | | |Dbv| | 46 | +---+---+---+---+---+---+---+---+ 47 | Cmd 2, Set debounce Counter 2 48 | +---+---+---+---+---+---+---+---+ 49 | |CMD| | | | | | |Dbv| 50 | +---+---+---+---+---+---+---+---+ 51 | Cmd 3, Reset counter 1 52 | +---+---+---+---+---+---+---+---+ 53 | | 3 | | | | 00| | | | 54 | +---+---+---+---+---+---+---+---+ 55 | Cmd 4, Reset counter 2 56 | +---+---+---+---+---+---+---+---+ 57 | | 4 | | | | | 00| | | 58 | +---+---+---+---+---+---+---+---+ 59 | cmd 5, Set analog/digital 60 | +---+---+---+---+---+---+---+---+ 61 | | 5 |DIG|An1|An2| | | | | 62 | +---+---+---+---+---+---+---+---+ 63 | 64 | **/ 65 | 66 | 67 | #define K8055_VENDOR_ID (0x10cf) 68 | #define K8055_PRODUCT_ID (0x5500) 69 | #define K8055_INTERFACE (0x00) 70 | #define K8055_OUTPUT_ENDPOINT (0x01) 71 | #define K8055_INPUT_ENDPOINT (0x81) 72 | #define K8055_USB_TIMEOUT (22) 73 | 74 | #define K8055_CMD_RESET (0x00) 75 | #define K8055_CMD_SET_DEBOUNCE_1 (0x01) 76 | #define K8055_CMD_SET_DEBOUNCE_2 (0x01) 77 | #define K8055_CMD_RESET_COUNTER_1 (0x03) 78 | #define K8055_CMD_RESET_COUNTER_2 (0x04) 79 | #define K8055_CMD_SET_OUTPUT (0x05) 80 | 81 | 82 | struct k8055_s { 83 | libusb_context *usb_context; 84 | libusb_device_handle *usb_handle; 85 | uint8_t card_address; 86 | 87 | uint8_t digital_output; 88 | uint8_t digital_input; 89 | uint8_t analogue_outputs[2]; 90 | uint8_t analogue_inputs[2]; 91 | uint16_t counters[2]; 92 | 93 | uint8_t write_pending; 94 | }; 95 | 96 | 97 | k8055_t* k8055_device_open(int card_address) 98 | { 99 | k8055_t* dev = NULL; 100 | int product_id = K8055_PRODUCT_ID + card_address; 101 | 102 | if (card_address < 0 || card_address > 4) 103 | return NULL; 104 | 105 | dev = malloc(sizeof(k8055_t)); 106 | if (!dev) 107 | return NULL; 108 | 109 | // Initialise memory structure 110 | memset(dev, 0, sizeof(k8055_t)); 111 | 112 | // Initialise libusb 113 | libusb_init(&dev->usb_context); 114 | libusb_set_debug(dev->usb_context, 1); 115 | 116 | // Find the device 117 | dev->card_address = card_address; 118 | dev->usb_handle = libusb_open_device_with_vid_pid(dev->usb_context, K8055_VENDOR_ID, product_id); 119 | if (!dev->usb_handle) { 120 | fprintf(stderr, "libusb_open_device_with_vid_pid() error.\n"); 121 | k8055_device_close(dev); 122 | return NULL; 123 | } 124 | 125 | if (libusb_set_configuration(dev->usb_handle, 1)) { 126 | fprintf(stderr, "libusb_set_configuration() error.\n"); 127 | k8055_device_close(dev); 128 | return NULL; 129 | } 130 | 131 | if (libusb_kernel_driver_active(dev->usb_handle, K8055_INTERFACE)) { 132 | fprintf(stderr, "Kernel driver is active for device, attempting to detatch.\n"); 133 | if (libusb_detach_kernel_driver(dev->usb_handle, K8055_INTERFACE)) { 134 | fprintf(stderr, "libusb_detach_kernel_driver() error.\n"); 135 | k8055_device_close(dev); 136 | return NULL; 137 | } 138 | } 139 | 140 | if (libusb_claim_interface(dev->usb_handle, K8055_INTERFACE)) { 141 | fprintf(stderr, "libusb_claim_interface() error.\n"); 142 | k8055_device_close(dev); 143 | return NULL; 144 | } 145 | 146 | return dev; 147 | } 148 | 149 | static int k8055_device_write(k8055_t* dev, char data[8]) 150 | { 151 | int transferred = 0; 152 | int res = 0; 153 | 154 | res = libusb_interrupt_transfer(dev->usb_handle, K8055_OUTPUT_ENDPOINT, data, sizeof(data), &transferred, K8055_USB_TIMEOUT); 155 | if (res == 0 && transferred == sizeof(data)) { 156 | return 0; 157 | } else { 158 | fprintf(stderr, "k8055_device_write() failed.\n"); 159 | return -1; 160 | } 161 | } 162 | 163 | int k8055_device_reset(k8055_t* dev) 164 | { 165 | char data[8] = {K8055_CMD_RESET, 0, 0, 0, 0, 0, 0, 0}; 166 | return k8055_device_write(dev, data); 167 | } 168 | 169 | 170 | int k8055_device_close(k8055_t* dev) 171 | { 172 | if (dev) { 173 | if (dev->usb_handle) 174 | libusb_release_interface(dev->usb_handle, 0); 175 | if (dev->usb_handle) 176 | libusb_close(dev->usb_handle); 177 | if (dev->usb_context) 178 | libusb_exit(dev->usb_context); 179 | free(dev); 180 | } 181 | } 182 | 183 | 184 | int k8055_device_poll(k8055_t* dev) 185 | { 186 | unsigned char data[8] = {0,0,0,0,0,0,0,0}; 187 | int transferred = 0; 188 | int res; 189 | 190 | assert(dev != NULL); 191 | 192 | // Write if anything need updating 193 | if (dev->write_pending) { 194 | data[0] = K8055_CMD_SET_OUTPUT; 195 | data[1] = dev->digital_output; 196 | data[2] = dev->analogue_outputs[0]; 197 | data[3] = dev->analogue_outputs[1]; 198 | 199 | res = k8055_device_write(dev, data); 200 | if (res) return res; 201 | dev->write_pending = 0; 202 | } 203 | 204 | // Read in current state 205 | res = libusb_interrupt_transfer(dev->usb_handle, K8055_INPUT_ENDPOINT, 206 | data, sizeof(data), &transferred, K8055_USB_TIMEOUT); 207 | if (res == 0 && transferred == sizeof(data)) { 208 | dev->digital_input = (((data[0] >> 4) & 0x03) | /* Input 1 and 2 */ 209 | ((data[0] << 2) & 0x04) | /* Input 3 */ 210 | ((data[0] >> 3) & 0x18)); /* Input 4 and 5 */ 211 | dev->analogue_inputs[0] = data[2]; 212 | dev->analogue_inputs[1] = data[3]; 213 | dev->counters[0] = ((uint16_t)data[5] << 8) | data[4]; 214 | dev->counters[1] = ((uint16_t)data[7] << 8) | data[6]; 215 | } else { 216 | fprintf(stderr, "k8055_device_poll() failed to read.\n"); 217 | return -1; 218 | } 219 | 220 | return 0; 221 | } 222 | 223 | 224 | void k8055_digital_out_set(k8055_t* dev, int value) 225 | { 226 | assert(dev != NULL); 227 | dev->digital_output = value; 228 | dev->write_pending = 1; 229 | } 230 | 231 | 232 | int k8055_digital_out_get(k8055_t* dev) 233 | { 234 | assert(dev != NULL); 235 | return dev->digital_output; 236 | } 237 | 238 | 239 | int k8055_digital_out_get_channel(k8055_t* dev, int channel) 240 | { 241 | assert(dev != NULL); 242 | assert(channel > 0 && channel < 9); 243 | return (dev->digital_output & (0x1 << (channel-1))) ? 1 : 0; 244 | } 245 | 246 | 247 | void k8055_digital_out_set_channel(k8055_t* dev, int channel) 248 | { 249 | assert(dev != NULL); 250 | assert(channel > 0 && channel < 9); 251 | dev->digital_output |= (0x1 << (channel-1)); 252 | dev->write_pending = 1; 253 | } 254 | 255 | 256 | void k8055_digital_out_clear_channel(k8055_t* dev, int channel) 257 | { 258 | assert(dev != NULL); 259 | assert(channel > 0 && channel < 9); 260 | dev->digital_output &= ~(0x1 << (channel-1)); 261 | dev->write_pending = 1; 262 | } 263 | 264 | int k8055_digital_in_get(k8055_t* dev) 265 | { 266 | return dev->digital_input; 267 | } 268 | 269 | int k8055_counter_get(k8055_t* dev, int channel) 270 | { 271 | assert(dev != NULL); 272 | if (channel == 1) 273 | return dev->counters[0]; 274 | else if (channel = 2) 275 | return dev->counters[1]; 276 | 277 | return -1; 278 | } 279 | 280 | int k8055_counter_reset(k8055_t* dev, int channel) 281 | { 282 | unsigned char data[8] = {0,0,0,0,0,0,0,0}; 283 | 284 | if (channel == 1) { 285 | data[0] = K8055_CMD_RESET_COUNTER_1; 286 | data[4] = 0x00; 287 | } else if (channel == 2) { 288 | data[0] = K8055_CMD_RESET_COUNTER_2; 289 | data[5] = 0x00; 290 | } else { 291 | return -1; 292 | } 293 | 294 | return k8055_device_write(dev, data); 295 | } 296 | 297 | void k8055_analogue_out_set(k8055_t* dev, int channel, int value) 298 | { 299 | assert(dev != NULL); 300 | if (channel == 1) 301 | dev->analogue_outputs[0] = value; 302 | else if (channel = 2) 303 | dev->analogue_outputs[1] = value; 304 | dev->write_pending = 1; 305 | } 306 | 307 | int k8055_analogue_out_get(k8055_t* dev, int channel) 308 | { 309 | assert(dev != NULL); 310 | if (channel == 1) 311 | return dev->analogue_outputs[0]; 312 | else if (channel = 2) 313 | return dev->analogue_outputs[1]; 314 | 315 | return -1; 316 | } 317 | 318 | int k8055_analogue_in_get(k8055_t* dev, int channel) 319 | { 320 | assert(dev != NULL); 321 | if (channel == 1) 322 | return dev->analogue_outputs[0]; 323 | else if (channel = 2) 324 | return dev->analogue_outputs[1]; 325 | 326 | return -1; 327 | } 328 | -------------------------------------------------------------------------------- /macosx/k8055.xcodeproj/project.pbxproj: -------------------------------------------------------------------------------- 1 | // !$*UTF8*$! 2 | { 3 | archiveVersion = 1; 4 | classes = { 5 | }; 6 | objectVersion = 42; 7 | objects = { 8 | 9 | /* Begin PBXBuildFile section */ 10 | 32D94FC80562CBF700B6AF17 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = 089C167DFE841241C02AAC07 /* InfoPlist.strings */; }; 11 | 32D94FCA0562CBF700B6AF17 /* k8055.cpp in Sources */ = {isa = PBXBuildFile; fileRef = 1A224C3FFF42367911CA2CB7 /* k8055.cpp */; settings = {ATTRIBUTES = (); }; }; 12 | F94465280806A0E100539834 /* Info.plist in Resources */ = {isa = PBXBuildFile; fileRef = 32D94FCF0562CBF700B6AF17 /* Info.plist */; }; 13 | /* End PBXBuildFile section */ 14 | 15 | /* Begin PBXFileReference section */ 16 | 089C167EFE841241C02AAC07 /* English */ = {isa = PBXFileReference; fileEncoding = 10; lastKnownFileType = text.plist.strings; name = English; path = English.lproj/InfoPlist.strings; sourceTree = ""; }; 17 | 1A224C3EFF42367911CA2CB7 /* k8055.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = k8055.h; sourceTree = ""; }; 18 | 1A224C3FFF42367911CA2CB7 /* k8055.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = k8055.cpp; sourceTree = ""; }; 19 | 32D94FCF0562CBF700B6AF17 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 20 | 32D94FD00562CBF700B6AF17 /* k8055.kext */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; name = k8055.kext; path = "/tmp/MacOSX Projet XCode/build/Deployment/k8055.kext"; sourceTree = ""; }; 21 | /* End PBXFileReference section */ 22 | 23 | /* Begin PBXFrameworksBuildPhase section */ 24 | 32D94FCB0562CBF700B6AF17 /* Frameworks */ = { 25 | isa = PBXFrameworksBuildPhase; 26 | buildActionMask = 2147483647; 27 | files = ( 28 | ); 29 | runOnlyForDeploymentPostprocessing = 0; 30 | }; 31 | /* End PBXFrameworksBuildPhase section */ 32 | 33 | /* Begin PBXGroup section */ 34 | 089C166AFE841209C02AAC07 /* k8055 */ = { 35 | isa = PBXGroup; 36 | children = ( 37 | 247142CAFF3F8F9811CA285C /* Source */, 38 | 089C167CFE841241C02AAC07 /* Resources */, 39 | ); 40 | name = k8055; 41 | sourceTree = ""; 42 | }; 43 | 089C167CFE841241C02AAC07 /* Resources */ = { 44 | isa = PBXGroup; 45 | children = ( 46 | 32D94FCF0562CBF700B6AF17 /* Info.plist */, 47 | 089C167DFE841241C02AAC07 /* InfoPlist.strings */, 48 | ); 49 | name = Resources; 50 | sourceTree = ""; 51 | }; 52 | 247142CAFF3F8F9811CA285C /* Source */ = { 53 | isa = PBXGroup; 54 | children = ( 55 | 1A224C3EFF42367911CA2CB7 /* k8055.h */, 56 | 1A224C3FFF42367911CA2CB7 /* k8055.cpp */, 57 | ); 58 | name = Source; 59 | sourceTree = ""; 60 | }; 61 | /* End PBXGroup section */ 62 | 63 | /* Begin PBXHeadersBuildPhase section */ 64 | 32D94FC50562CBF700B6AF17 /* Headers */ = { 65 | isa = PBXHeadersBuildPhase; 66 | buildActionMask = 2147483647; 67 | files = ( 68 | ); 69 | runOnlyForDeploymentPostprocessing = 0; 70 | }; 71 | /* End PBXHeadersBuildPhase section */ 72 | 73 | /* Begin PBXNativeTarget section */ 74 | 32D94FC30562CBF700B6AF17 /* k8055 */ = { 75 | isa = PBXNativeTarget; 76 | buildConfigurationList = 62D9B6DD1300226C006D21D3 /* Build configuration list for PBXNativeTarget "k8055" */; 77 | buildPhases = ( 78 | 32D94FC40562CBF700B6AF17 /* ShellScript */, 79 | 32D94FC50562CBF700B6AF17 /* Headers */, 80 | 32D94FC70562CBF700B6AF17 /* Resources */, 81 | 32D94FC90562CBF700B6AF17 /* Sources */, 82 | 32D94FCB0562CBF700B6AF17 /* Frameworks */, 83 | 32D94FCC0562CBF700B6AF17 /* Rez */, 84 | 32D94FCD0562CBF700B6AF17 /* ShellScript */, 85 | ); 86 | buildRules = ( 87 | ); 88 | dependencies = ( 89 | ); 90 | name = k8055; 91 | productInstallPath = "$(SYSTEM_LIBRARY_DIR)/Extensions"; 92 | productName = k8055; 93 | productReference = 32D94FD00562CBF700B6AF17 /* k8055.kext */; 94 | productType = "com.apple.product-type.kernel-extension.iokit"; 95 | }; 96 | /* End PBXNativeTarget section */ 97 | 98 | /* Begin PBXProject section */ 99 | 089C1669FE841209C02AAC07 /* Project object */ = { 100 | isa = PBXProject; 101 | buildConfigurationList = 62D9B6DC1300226C006D21D3 /* Build configuration list for PBXProject "k8055" */; 102 | compatibilityVersion = "Xcode 2.4"; 103 | hasScannedForEncodings = 1; 104 | mainGroup = 089C166AFE841209C02AAC07 /* k8055 */; 105 | projectDirPath = ""; 106 | projectRoot = ""; 107 | targets = ( 108 | 32D94FC30562CBF700B6AF17 /* k8055 */, 109 | ); 110 | }; 111 | /* End PBXProject section */ 112 | 113 | /* Begin PBXResourcesBuildPhase section */ 114 | 32D94FC70562CBF700B6AF17 /* Resources */ = { 115 | isa = PBXResourcesBuildPhase; 116 | buildActionMask = 2147483647; 117 | files = ( 118 | 32D94FC80562CBF700B6AF17 /* InfoPlist.strings in Resources */, 119 | F94465280806A0E100539834 /* Info.plist in Resources */, 120 | ); 121 | runOnlyForDeploymentPostprocessing = 0; 122 | }; 123 | /* End PBXResourcesBuildPhase section */ 124 | 125 | /* Begin PBXRezBuildPhase section */ 126 | 32D94FCC0562CBF700B6AF17 /* Rez */ = { 127 | isa = PBXRezBuildPhase; 128 | buildActionMask = 2147483647; 129 | files = ( 130 | ); 131 | runOnlyForDeploymentPostprocessing = 0; 132 | }; 133 | /* End PBXRezBuildPhase section */ 134 | 135 | /* Begin PBXShellScriptBuildPhase section */ 136 | 32D94FC40562CBF700B6AF17 /* ShellScript */ = { 137 | isa = PBXShellScriptBuildPhase; 138 | buildActionMask = 2147483647; 139 | files = ( 140 | ); 141 | runOnlyForDeploymentPostprocessing = 0; 142 | shellPath = /bin/sh; 143 | shellScript = "script=\"${SYSTEM_DEVELOPER_DIR}/ProjectBuilder Extras/Kernel Extension Support/KEXTPreprocess\";\nif [ -x \"$script\" ]; then\n . \"$script\"\nfi"; 144 | }; 145 | 32D94FCD0562CBF700B6AF17 /* ShellScript */ = { 146 | isa = PBXShellScriptBuildPhase; 147 | buildActionMask = 2147483647; 148 | files = ( 149 | ); 150 | runOnlyForDeploymentPostprocessing = 0; 151 | shellPath = /bin/sh; 152 | shellScript = "script=\"${SYSTEM_DEVELOPER_DIR}/ProjectBuilder Extras/Kernel Extension Support/KEXTPostprocess\";\nif [ -x \"$script\" ]; then\n . \"$script\"\nfi"; 153 | }; 154 | /* End PBXShellScriptBuildPhase section */ 155 | 156 | /* Begin PBXSourcesBuildPhase section */ 157 | 32D94FC90562CBF700B6AF17 /* Sources */ = { 158 | isa = PBXSourcesBuildPhase; 159 | buildActionMask = 2147483647; 160 | files = ( 161 | 32D94FCA0562CBF700B6AF17 /* k8055.cpp in Sources */, 162 | ); 163 | runOnlyForDeploymentPostprocessing = 0; 164 | }; 165 | /* End PBXSourcesBuildPhase section */ 166 | 167 | /* Begin PBXVariantGroup section */ 168 | 089C167DFE841241C02AAC07 /* InfoPlist.strings */ = { 169 | isa = PBXVariantGroup; 170 | children = ( 171 | 089C167EFE841241C02AAC07 /* English */, 172 | ); 173 | name = InfoPlist.strings; 174 | sourceTree = ""; 175 | }; 176 | /* End PBXVariantGroup section */ 177 | 178 | /* Begin XCBuildConfiguration section */ 179 | 62D9B6D61300226C006D21D3 /* Development */ = { 180 | isa = XCBuildConfiguration; 181 | buildSettings = { 182 | }; 183 | name = Development; 184 | }; 185 | 62D9B6D71300226C006D21D3 /* Deployment */ = { 186 | isa = XCBuildConfiguration; 187 | buildSettings = { 188 | }; 189 | name = Deployment; 190 | }; 191 | 62D9B6D91300226C006D21D3 /* Development */ = { 192 | isa = XCBuildConfiguration; 193 | buildSettings = { 194 | ARCHS = "$(ARCHS_STANDARD_32_64_BIT_PRE_XCODE_3_1)"; 195 | ARCHS_STANDARD_32_64_BIT_PRE_XCODE_3_1 = "x86_64 i386 ppc"; 196 | COPY_PHASE_STRIP = NO; 197 | FRAMEWORK_SEARCH_PATHS = ""; 198 | GCC_DYNAMIC_NO_PIC = NO; 199 | GCC_ENABLE_FIX_AND_CONTINUE = YES; 200 | GCC_GENERATE_DEBUGGING_SYMBOLS = YES; 201 | GCC_OPTIMIZATION_LEVEL = 0; 202 | GCC_WARN_FOUR_CHARACTER_CONSTANTS = NO; 203 | GCC_WARN_UNKNOWN_PRAGMAS = NO; 204 | HEADER_SEARCH_PATHS = ""; 205 | INFOPLIST_FILE = Info.plist; 206 | INSTALL_PATH = "$(SYSTEM_LIBRARY_DIR)/Extensions"; 207 | LIBRARY_SEARCH_PATHS = ""; 208 | MODULE_NAME = com.MySoftwareCompany.driver.k8055; 209 | MODULE_VERSION = 1.0.0d1; 210 | OTHER_CFLAGS = ""; 211 | OTHER_LDFLAGS = ""; 212 | OTHER_REZFLAGS = ""; 213 | PRODUCT_NAME = k8055; 214 | SECTORDER_FLAGS = ""; 215 | WARNING_CFLAGS = "-Wmost"; 216 | WRAPPER_EXTENSION = kext; 217 | ZERO_LINK = YES; 218 | }; 219 | name = Development; 220 | }; 221 | 62D9B6DA1300226C006D21D3 /* Deployment */ = { 222 | isa = XCBuildConfiguration; 223 | buildSettings = { 224 | ARCHS = "$(ARCHS_STANDARD_32_64_BIT_PRE_XCODE_3_1)"; 225 | ARCHS_STANDARD_32_64_BIT_PRE_XCODE_3_1 = "x86_64 i386 ppc"; 226 | COPY_PHASE_STRIP = YES; 227 | FRAMEWORK_SEARCH_PATHS = ""; 228 | GCC_ENABLE_FIX_AND_CONTINUE = NO; 229 | GCC_WARN_FOUR_CHARACTER_CONSTANTS = NO; 230 | GCC_WARN_UNKNOWN_PRAGMAS = NO; 231 | HEADER_SEARCH_PATHS = ""; 232 | INFOPLIST_FILE = Info.plist; 233 | INSTALL_PATH = "$(SYSTEM_LIBRARY_DIR)/Extensions"; 234 | LIBRARY_SEARCH_PATHS = ""; 235 | MODULE_NAME = com.MySoftwareCompany.driver.k8055; 236 | MODULE_VERSION = 1.0.0d1; 237 | OTHER_CFLAGS = ""; 238 | OTHER_LDFLAGS = ""; 239 | OTHER_REZFLAGS = ""; 240 | PRODUCT_NAME = k8055; 241 | SECTORDER_FLAGS = ""; 242 | WARNING_CFLAGS = "-Wmost"; 243 | WRAPPER_EXTENSION = kext; 244 | ZERO_LINK = NO; 245 | }; 246 | name = Deployment; 247 | }; 248 | /* End XCBuildConfiguration section */ 249 | 250 | /* Begin XCConfigurationList section */ 251 | 62D9B6DC1300226C006D21D3 /* Build configuration list for PBXProject "k8055" */ = { 252 | isa = XCConfigurationList; 253 | buildConfigurations = ( 254 | 62D9B6D61300226C006D21D3 /* Development */, 255 | 62D9B6D71300226C006D21D3 /* Deployment */, 256 | ); 257 | defaultConfigurationIsVisible = 0; 258 | defaultConfigurationName = Development; 259 | }; 260 | 62D9B6DD1300226C006D21D3 /* Build configuration list for PBXNativeTarget "k8055" */ = { 261 | isa = XCConfigurationList; 262 | buildConfigurations = ( 263 | 62D9B6D91300226C006D21D3 /* Development */, 264 | 62D9B6DA1300226C006D21D3 /* Deployment */, 265 | ); 266 | defaultConfigurationIsVisible = 0; 267 | defaultConfigurationName = Development; 268 | }; 269 | /* End XCConfigurationList section */ 270 | }; 271 | rootObject = 089C1669FE841209C02AAC07 /* Project object */; 272 | } 273 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------