├── THANKS ├── .gitignore ├── install.sh ├── Makefile ├── README.md ├── test └── test.c ├── atsha204-i2c.h ├── atsha204-i2c.c └── LICENSE /THANKS: -------------------------------------------------------------------------------- 1 | Mihai Cristea, REDANS SRL, mihai _AT_ redans -DOT- eu 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.tmp_versions/ 2 | *.cmd 3 | *.ko 4 | *.o 5 | 6 | /Module.symvers 7 | /atsha204-i2c.mod.c 8 | /atsha204-i2c.mod.o 9 | /atsha204-i2c.o 10 | /hwcrypt.mod.c 11 | /hwcrypt.mod.o 12 | /hwcrypt.o 13 | /modules.order 14 | /test/test 15 | /test/test.o 16 | /TAGS 17 | /cov-int/ 18 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | sudo make modules_install 4 | sudo rmmod atsha204-i2c 5 | sudo insmod atsha204-i2c.ko 6 | #0x60 = ATECC108, 0x64 = ATSHA204 7 | #echo atsha204-i2c 0x60 | sudo tee /sys/class/i2c-adapter/i2c-1/new_device 8 | echo atsha204-i2c 0x64 | sudo tee /sys/class/i2c-adapter/i2c-1/new_device 9 | sudo chgrp i2c /dev/atsha0 10 | sudo chmod 664 /dev/atsha0 11 | test/test 12 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | obj-m := atsha204-i2c.o 2 | KDIR ?= /lib/modules/`uname -r`/build 3 | MDIR ?= /lib/modules/`uname -r`/kernel/drivers/char/ 4 | SRC = atsha204-i2c.c atsha204-i2c.h 5 | # Enable CFLAG to run DEBUG MODE 6 | #CFLAGS_atsha204-i2c.o := -DDEBUG 7 | 8 | all: 9 | make -C $(KDIR) M=$$PWD modules 10 | # make testing code 11 | gcc -c $$PWD/test/test.c 12 | gcc $$PWD/test/test.c -o $$PWD/test/test 13 | 14 | clean: 15 | make -C $(KDIR) M=$$PWD clean 16 | -rm -rf $$PWD/test/test.o $$PWD/test/test TAGS 17 | 18 | install: 19 | sudo cp atsha204-i2c.ko $(MDIR) 20 | -sudo insmod atsha204-i2c.ko 21 | -echo atsha204-i2c 0x60 | sudo tee /sys/class/i2c-adapter/i2c-1/new_device 22 | sudo chgrp i2c /dev/atsha0 23 | sudo chmod 664 /dev/atsha0 24 | 25 | 26 | check: 27 | ./test/test 28 | 29 | modules_install: 30 | cp atsha204-i2c.ko $(MDIR) 31 | 32 | TAGS: 33 | etags $(SRC) 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | atsha204-i2c 3 | ======= 4 | 5 | 6 | Coverity Scan Build Status 8 | [![Stories in Ready](https://badge.waffle.io/cryptotronix/atsha204-i2c.png?label=ready&title=Ready)](https://waffle.io/cryptotronix/atsha204-i2c) 9 | 10 | 11 | Kernel module for Atmel's ATSHA204 I2C device. 12 | 13 | This software is in ***ALPHA***. It is subject to drastic refactoring 14 | at will by the author. 15 | 16 | This module provides the following features: 17 | 18 | - An I2C driver [working] 19 | - Sysfs for serial number [working] 20 | - Char device for random data [working] 21 | 22 | 23 | SYSFS 24 | ---- 25 | 26 | The systfs looks like this: 27 | 28 | ``` 29 | |-- configlocked 30 | |-- configzone 31 | |-- datalocked 32 | |-- driver -> ../../../../../bus/i2c/drivers/atsha204-i2c 33 | |-- misc 34 | | `-- atsha0 35 | | |-- dev 36 | | |-- device -> ../../../1-0060 37 | | |-- power 38 | | | |-- autosuspend_delay_ms 39 | | | |-- control 40 | | | |-- runtime_active_time 41 | | | |-- runtime_status 42 | | | `-- runtime_suspended_time 43 | | |-- subsystem -> ../../../../../../../class/misc 44 | | `-- uevent 45 | |-- modalias 46 | |-- name 47 | |-- power 48 | | |-- autosuspend_delay_ms 49 | | |-- control 50 | | |-- runtime_active_time 51 | | |-- runtime_status 52 | | `-- runtime_suspended_time 53 | |-- serialnum 54 | |-- subsystem -> ../../../../../bus/i2c 55 | `-- uevent 56 | ``` 57 | 58 | The unique features are: configlocked, configzone, datalocked, and 59 | serialnum. 60 | 61 | configlocked & datalocked return a 1 or 0 where 1 indicates that zone 62 | is "locked". 63 | 64 | serial number returns the chip's unique serial number. 65 | 66 | configzone dumps the chip's entire configuration zone. 67 | 68 | RANDOM 69 | ----- 70 | 71 | This driver plugs into /dev/hwrng. See the /dev/hwrng [documentation](https://www.kernel.org/doc/Documentation/hw_random.txt) 72 | for how to use / switch random number generators. 73 | 74 | /dev/atshaX 75 | ------ 76 | 77 | The driver handles the communication layer. It expects commands in the 78 | format: 79 | 80 | ``` 81 | [Opcode (1)][Param1 (1)][Param2 (2)][[Data (x)]] 82 | ``` 83 | 84 | The number indicate the number of bytes. Data is optional. The data 85 | must be written to the fd in one shot. The driver will pre-pend the 86 | length and append the crc. 87 | 88 | The driver will perform a write AND a read as there are specific 89 | timing constraints when the data must be read. The read data is cached 90 | until the user reads the data. The user receives the message ONLY, the 91 | single byte size and crc are removed. 92 | -------------------------------------------------------------------------------- /test/test.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | 13 | static char buf[] = {0x1B, 0x01, 0x00, 0x00}; 14 | static char recv_buf[32]; 15 | const char *filename = "/dev/atsha0"; 16 | 17 | void print_hex(const char *str, const uint8_t *hex, 18 | const int len) 19 | { 20 | 21 | int i; 22 | 23 | printf("%s : ", str); 24 | 25 | for (i = 0; i < len; i++) 26 | { 27 | if (i > 0) printf(" "); 28 | printf("0x%02X", hex[i]); 29 | } 30 | 31 | printf("\n"); 32 | 33 | } 34 | 35 | int test_single_byte_read(int fd) 36 | { 37 | int i; 38 | int rc = 0; 39 | 40 | printf("Starting single byte read test\n"); 41 | 42 | if(sizeof(buf) != write(fd,buf,sizeof(buf))){ 43 | perror("Write failed\n"); 44 | exit(1); 45 | } 46 | else{ 47 | printf("Wrote %lu bytes\n", sizeof(buf)); 48 | } 49 | 50 | for (i = 0; i < sizeof(recv_buf); i++){ 51 | rc = read(fd, &recv_buf[i], 1); 52 | if (rc < 0){ 53 | perror("Read failed\n"); 54 | exit(1); 55 | } 56 | } 57 | 58 | print_hex("Received data", recv_buf, sizeof(recv_buf)); 59 | rc = 0; 60 | 61 | return rc; 62 | 63 | } 64 | 65 | int test_multiple_open() 66 | { 67 | int rc = -1; 68 | 69 | rc = open(filename, O_RDWR); 70 | perror("Multiple open:"); 71 | 72 | if (rc != 0) { 73 | /* success */ 74 | rc = 0; 75 | } 76 | 77 | return rc; 78 | } 79 | 80 | int main() 81 | { 82 | int file; 83 | int rc = 0; 84 | 85 | //static char buf[] = {0x03, 0x07, 0x1B, 0x01, 0x00, 0x00, 0x27, 86 | //0x47}; 87 | 88 | 89 | 90 | if ((file = open(filename, O_RDWR)) < 0) { 91 | /* ERROR HANDLING: you can check errno to see what went wrong */ 92 | perror("Failed to open the i2c bus"); 93 | exit(1); 94 | } 95 | 96 | if(sizeof(buf) != write(file,buf,sizeof(buf))){ 97 | perror("Write failed\n"); 98 | exit(1); 99 | } 100 | else{ 101 | printf("Wrote %lu bytes\n", sizeof(buf)); 102 | } 103 | 104 | if (sizeof(recv_buf) != read(file,recv_buf,sizeof(recv_buf))){ 105 | perror("Read failed\n"); 106 | exit(1); 107 | } 108 | else{ 109 | printf("Read %lu bytes\n", sizeof(recv_buf)); 110 | print_hex("Received data", recv_buf, sizeof(recv_buf)); 111 | } 112 | 113 | if (test_single_byte_read(file) != 0){ 114 | printf("Single byte read failed\n"); 115 | rc = 1; 116 | goto close_exit; 117 | } 118 | 119 | if (test_multiple_open()){ 120 | printf("Multiple open failed\n"); 121 | rc = 1; 122 | goto close_exit; 123 | } 124 | 125 | close_exit: 126 | 127 | close(file); 128 | 129 | return rc; 130 | } 131 | -------------------------------------------------------------------------------- /atsha204-i2c.h: -------------------------------------------------------------------------------- 1 | /* -*- mode: c; c-file-style: "linux" -*- */ 2 | /* 3 | * I2C Driver for Atmel ATSHA204 over I2C 4 | * 5 | * Copyright (C) 2014 Josh Datko, Cryptotronix, jbd@cryptotronix.com 6 | * 7 | * This program is free software; you can redistribute it and/or modify it 8 | * under the terms of the GNU General Public License version 2 as 9 | * published by the Free Software Foundation. 10 | */ 11 | #ifndef _ATSHA204_I2C_H_ 12 | #define _ATSHA204_I2C_H_ 13 | 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | 20 | #define ATSHA204_I2C_VERSION "0.1" 21 | #define ATSHA204_SLEEP 0x01 22 | #define ATSHA204_RNG_NAME "atsha-rng" 23 | 24 | struct atsha204_chip { 25 | struct device *dev; 26 | 27 | int dev_num; 28 | char devname[7]; 29 | unsigned long is_open; 30 | 31 | struct i2c_client *client; 32 | struct miscdevice miscdev; 33 | struct mutex transaction_mutex; 34 | }; 35 | 36 | struct atsha204_cmd_metadata { 37 | int expected_rec_len; 38 | int actual_rec_len; 39 | unsigned long usleep; 40 | }; 41 | 42 | struct atsha204_buffer { 43 | u8 *ptr; 44 | int len; 45 | }; 46 | 47 | struct atsha204_file_priv { 48 | struct atsha204_chip *chip; 49 | struct atsha204_cmd_metadata meta; 50 | 51 | struct atsha204_buffer buf; 52 | }; 53 | 54 | static const struct i2c_device_id atsha204_i2c_id[] = { 55 | {"atsha204-i2c", 0}, 56 | { } 57 | }; 58 | 59 | 60 | /* I2C detection */ 61 | int atsha204_i2c_probe(struct i2c_client *client, 62 | const struct i2c_device_id *id); 63 | 64 | int atsha204_i2c_remove(struct i2c_client *client); 65 | 66 | /* Device registration */ 67 | struct atsha204_chip *atsha204_i2c_register_hardware(struct device *dev, 68 | struct i2c_client *client); 69 | int atsha204_i2c_add_device(struct atsha204_chip *chip); 70 | void atsha204_i2c_del_device(struct atsha204_chip *chip); 71 | int atsha204_i2c_release(struct inode *inode, struct file *filep); 72 | int atsha204_i2c_open(struct inode *inode, struct file *filep); 73 | 74 | /* atsha204 crc functions */ 75 | u16 atsha204_crc16(const u8 *buf, const u8 len); 76 | bool atsha204_check_rsp_crc16(const u8 *buf, const u8 len); 77 | int atsha204_i2c_validate_rsp(const struct atsha204_buffer *packet, 78 | struct atsha204_buffer *rsp); 79 | void atsha204_i2c_crc_command(u8 *cmd, int len); 80 | 81 | /* sysfs functions */ 82 | int atsha204_sysfs_add_device(struct atsha204_chip *chip); 83 | void atsha204_sysfs_del_device(struct atsha204_chip *chip); 84 | 85 | /* atsha204 specific functions */ 86 | int atsha204_i2c_wakeup(const struct i2c_client *client); 87 | int atsha204_i2c_idle(const struct i2c_client *client); 88 | int atsha204_i2c_transmit(const struct i2c_client *client, 89 | const char __user *buf, size_t len); 90 | int atsha204_i2c_transaction(struct atsha204_chip *chip, 91 | const u8* to_send, size_t to_send_len, 92 | struct atsha204_buffer *buf); 93 | int atsha204_i2c_get_random(u8 *to_fill, const size_t max); 94 | 95 | void atsha204_set_params(struct atsha204_cmd_metadata *cmd, 96 | int expected_rec_len, 97 | unsigned long usleep) 98 | { 99 | cmd->expected_rec_len = expected_rec_len; 100 | cmd->usleep = usleep; 101 | } 102 | 103 | static int atsha204_i2c_rng_read(struct hwrng *rng, void *data, 104 | size_t max, bool wait) 105 | { 106 | return atsha204_i2c_get_random(data, max); 107 | } 108 | 109 | static struct hwrng atsha204_i2c_rng = { 110 | .name = ATSHA204_RNG_NAME, 111 | .read = atsha204_i2c_rng_read, 112 | }; 113 | 114 | /* Validation functions */ 115 | int validate_write_size(const size_t count); 116 | 117 | #endif /* _ATSHA204_I2C_H_ */ 118 | -------------------------------------------------------------------------------- /atsha204-i2c.c: -------------------------------------------------------------------------------- 1 | /* -*- mode: c; c-file-style: "linux" -*- */ 2 | /* 3 | * I2C Driver for Atmel ATSHA204 over I2C 4 | * 5 | * Copyright (C) 2014 Josh Datko, Cryptotronix, jbd@cryptotronix.com 6 | * 7 | * This program is free software; you can redistribute it and/or modify it 8 | * under the terms of the GNU General Public License version 2 as 9 | * published by the Free Software Foundation. 10 | */ 11 | #include 12 | #include 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include "atsha204-i2c.h" 26 | 27 | struct atsha204_chip *global_chip = NULL; 28 | static atomic_t atsha204_avail = ATOMIC_INIT(1); 29 | 30 | int atsha204_i2c_get_random(u8 *to_fill, const size_t max) 31 | { 32 | int rc; 33 | struct atsha204_buffer recv = {0,0}; 34 | int rnd_len; 35 | 36 | const u8 rand_cmd[] = {0x03, 0x07, 0x1b, 0x01, 0x00, 0x00, 0x27, 0x47}; 37 | 38 | rc = atsha204_i2c_transaction(global_chip, rand_cmd, sizeof(rand_cmd), 39 | &recv); 40 | if (sizeof(rand_cmd) == rc){ 41 | 42 | if (!atsha204_check_rsp_crc16(recv.ptr, recv.len)){ 43 | rc = -EBADMSG; 44 | dev_err(global_chip->dev, "%s\n", "Bad CRC on Random"); 45 | } 46 | else{ 47 | rnd_len = (max > recv.len - 3) ? recv.len - 3 : max; 48 | memcpy(to_fill, &recv.ptr[1], rnd_len); 49 | rc = rnd_len; 50 | dev_info(global_chip->dev, "%s: %d\n", 51 | "Returning randoom bytes", rc); 52 | } 53 | 54 | } 55 | 56 | return rc; 57 | 58 | 59 | } 60 | 61 | int atsha204_i2c_transaction(struct atsha204_chip *chip, 62 | const u8* to_send, size_t to_send_len, 63 | struct atsha204_buffer *buf) 64 | 65 | 66 | { 67 | int rc; 68 | u8 status_packet[4]; 69 | u8 *recv_buf; 70 | int total_sleep = 60; 71 | int packet_len; 72 | 73 | mutex_lock(&chip->transaction_mutex); 74 | 75 | dev_dbg(chip->dev, "%s\n", "About to send to device."); 76 | print_hex_dump_bytes("Sending : ", DUMP_PREFIX_OFFSET, 77 | to_send, to_send_len); 78 | 79 | 80 | /* Begin i2c transactions */ 81 | if ((rc = atsha204_i2c_wakeup(chip->client))) 82 | goto out; 83 | 84 | if ((rc = i2c_master_send(chip->client, to_send, to_send_len)) 85 | != to_send_len) 86 | goto out; 87 | 88 | /* Poll for the response */ 89 | while (4 != i2c_master_recv(chip->client, status_packet, 4) 90 | && total_sleep > 0){ 91 | total_sleep = total_sleep - 4; 92 | msleep(4); 93 | } 94 | 95 | packet_len = status_packet[0]; 96 | /* The device is awake and we don't want to hit the watchdog 97 | timer, so don't allow sleeps here*/ 98 | recv_buf = kmalloc(packet_len, GFP_ATOMIC); 99 | memcpy(recv_buf, status_packet, sizeof(status_packet)); 100 | rc = i2c_master_recv(chip->client, recv_buf + 4, packet_len - 4); 101 | 102 | atsha204_i2c_idle(chip->client); 103 | 104 | /* Store the entire packet. Other functions must check the CRC 105 | and strip of the length byte */ 106 | buf->ptr = recv_buf; 107 | buf->len = packet_len; 108 | 109 | dev_dbg(chip->dev, "%s\n", "Received from device."); 110 | print_hex_dump_bytes("Received: ", DUMP_PREFIX_OFFSET, 111 | recv_buf, packet_len); 112 | 113 | rc = to_send_len; 114 | out: 115 | mutex_unlock(&chip->transaction_mutex); 116 | return rc; 117 | 118 | } 119 | 120 | 121 | u16 atsha204_crc16(const u8 *buf, const u8 len) 122 | { 123 | u8 i; 124 | u16 crc16 = 0; 125 | 126 | for (i = 0; i < len; i++) { 127 | u8 shift; 128 | 129 | for (shift = 0x01; shift > 0x00; shift <<= 1) { 130 | u8 data_bit = (buf[i] & shift) ? 1 : 0; 131 | u8 crc_bit = crc16 >> 15; 132 | 133 | crc16 <<= 1; 134 | 135 | if ((data_bit ^ crc_bit) != 0) 136 | crc16 ^= 0x8005; 137 | } 138 | } 139 | 140 | return cpu_to_le16(crc16); 141 | } 142 | 143 | bool atsha204_crc16_matches(const u8 *buf, const u8 len, const u16 crc) 144 | { 145 | u16 crc_calc = atsha204_crc16(buf,len); 146 | return (crc == crc_calc) ? true : false; 147 | } 148 | 149 | bool atsha204_check_rsp_crc16(const u8 *buf, const u8 len) 150 | { 151 | u16 *rec_crc = &buf[len - 2]; 152 | return atsha204_crc16_matches(buf, len - 2, cpu_to_le16(*rec_crc)); 153 | } 154 | 155 | int atsha204_i2c_validate_rsp(const struct atsha204_buffer *packet, 156 | struct atsha204_buffer *rsp) 157 | { 158 | int rc; 159 | 160 | if (packet->len < 4) 161 | goto out_bad_msg; 162 | else if (atsha204_check_rsp_crc16(packet->ptr, packet->len)){ 163 | rsp->ptr = packet->ptr + 1; 164 | rsp->len = packet->len - 3; 165 | rc = 0; 166 | goto out; 167 | } 168 | else 169 | /* CRC failed */ 170 | 171 | out_bad_msg: 172 | rc = -EBADMSG; 173 | out: 174 | return rc; 175 | } 176 | 177 | int atsha204_i2c_wakeup(const struct i2c_client *client) 178 | { 179 | bool is_awake = false; 180 | int retval = -ENODEV; 181 | 182 | u8 buf[4] = {0}; 183 | 184 | unsigned short int try_con = 1; 185 | 186 | while (!is_awake){ 187 | if (4 == i2c_master_send(client, buf, 4)){ 188 | pr_debug("%s\n", "ATSHA204 Device is awake."); 189 | is_awake = true; 190 | 191 | if (4 == i2c_master_recv(client, buf, 4)){ 192 | pr_debug("%s", "ATSHA204 Received wakeup\n"); 193 | } 194 | 195 | 196 | if (atsha204_check_rsp_crc16(buf,4)) 197 | retval = 0; 198 | else 199 | pr_err("%s\n", "ATSHA204 Wakeup CRC failure"); 200 | 201 | 202 | } 203 | else{ 204 | /* is_awake is already false */ 205 | pr_info("Attempting Wakeup : %u\n",try_con); 206 | if(try_con >= 10){ 207 | pr_err("Wakeup Failed. No Device"); 208 | return retval; 209 | } 210 | } 211 | 212 | ++try_con; 213 | } 214 | 215 | retval = 0; 216 | return retval; 217 | 218 | } 219 | 220 | 221 | int atsha204_i2c_idle(const struct i2c_client *client) 222 | { 223 | int rc; 224 | 225 | u8 idle_cmd[1] = {0x02}; 226 | 227 | rc = i2c_master_send(client, idle_cmd, 1); 228 | 229 | return rc; 230 | 231 | } 232 | 233 | int atsha204_i2c_sleep(const struct i2c_client *client) 234 | { 235 | int retval; 236 | char to_send[1] = {ATSHA204_SLEEP}; 237 | 238 | if ((retval = i2c_master_send(client,to_send,1)) == 1) 239 | retval = 0; 240 | else 241 | pr_err("%s: 0x%x\n", "ATSHA204 failed to sleep", client->addr); 242 | 243 | return retval; 244 | 245 | } 246 | 247 | void atsha204_i2c_crc_command(u8 *cmd, int len) 248 | { 249 | /* The command packet is: 250 | [0x03] [Length=1 + command + CRC] [cmd] [crc] 251 | 252 | The CRC is calculated over: 253 | CRC([Len] [cmd]) */ 254 | int crc_data_len = len - 2 - 1; 255 | u16 crc = atsha204_crc16(&cmd[1], crc_data_len); 256 | 257 | 258 | cmd[len - 2] = cpu_to_le16(crc) & 0xFF; 259 | cmd[len - 1] = cpu_to_le16(crc) >> 8; 260 | } 261 | 262 | int validate_write_size(const size_t count) 263 | { 264 | const int MIN_SIZE = 4; 265 | /* Header and CRC occupy 4 bytes and the length is a one byte 266 | value */ 267 | const int MAX_SIZE = 255 - 4; 268 | int rc = -EMSGSIZE; 269 | 270 | if (count <= MAX_SIZE && count >= MIN_SIZE) 271 | rc = 0; 272 | 273 | return rc; 274 | 275 | } 276 | ssize_t atsha204_i2c_write(struct file *filep, const char __user *buf, 277 | size_t count, loff_t *f_pos) 278 | { 279 | struct atsha204_file_priv *priv = filep->private_data; 280 | struct atsha204_chip *chip = priv->chip; 281 | u8 *to_send; 282 | int rc; 283 | 284 | /* Add command byte + length + 2 byte crc */ 285 | const int SEND_SIZE = count + 4; 286 | const u8 COMMAND_BYTE = 0x03; 287 | 288 | if ((rc = validate_write_size(count))) 289 | return rc; 290 | 291 | to_send = kmalloc(SEND_SIZE, GFP_KERNEL); 292 | if (!to_send) 293 | return -ENOMEM; 294 | 295 | /* Write the header */ 296 | to_send[0] = COMMAND_BYTE; 297 | /* Length byte = user size + crc size + length byte */ 298 | to_send[1] = count + 2 + 1; 299 | 300 | if (copy_from_user(&to_send[2], buf, count)){ 301 | rc = -EFAULT; 302 | kfree(to_send); 303 | return rc; 304 | } 305 | 306 | atsha204_i2c_crc_command(to_send, SEND_SIZE); 307 | 308 | rc = atsha204_i2c_transaction(chip, to_send, SEND_SIZE, 309 | &priv->buf); 310 | 311 | /* Return to the user the number of bytes that the 312 | user provided, don't include the extra header / crc 313 | bytes */ 314 | if (SEND_SIZE == rc) 315 | rc = count; 316 | 317 | /* Reset the f_pos, which indicates the read position in the 318 | buffer. Byte 1 points at the start of the data */ 319 | *f_pos = 1; 320 | 321 | kfree(to_send); 322 | 323 | return rc; 324 | } 325 | 326 | ssize_t atsha204_i2c_read(struct file *filep, char __user *buf, size_t count, 327 | loff_t *f_pos) 328 | { 329 | struct atsha204_file_priv *priv = filep->private_data; 330 | struct atsha204_chip *chip = priv->chip; 331 | struct atsha204_buffer *r_buf = &priv->buf; 332 | ssize_t rc = 0; 333 | /* r_buf has 3 extra bytes that should not be returned to the 334 | user. The first byte (length) and the last two (crc). 335 | However, since f_pos is reset to 1 on write, only subtract 336 | 2 here. 337 | */ 338 | const int MAX_REC_LEN = r_buf->len - 2; 339 | 340 | /* Check the CRC on the rec buffer on the first read */ 341 | if (*f_pos == 1 && !atsha204_check_rsp_crc16(r_buf->ptr, r_buf->len)){ 342 | rc = -EBADMSG; 343 | dev_err(chip->dev, "%s\n", "CRC on received buffer failed."); 344 | goto out; 345 | } 346 | 347 | if (*f_pos >= MAX_REC_LEN) 348 | goto out; 349 | 350 | if (*f_pos + count > MAX_REC_LEN) 351 | count = MAX_REC_LEN - *f_pos; 352 | 353 | if ((rc = copy_to_user(buf, &r_buf->ptr[*f_pos], count))){ 354 | rc = -EFAULT; 355 | } 356 | else{ 357 | *f_pos += count; 358 | rc = count; 359 | } 360 | 361 | out: 362 | return rc; 363 | } 364 | 365 | 366 | int atsha204_i2c_open(struct inode *inode, struct file *filep) 367 | { 368 | struct miscdevice *misc = filep->private_data; 369 | struct atsha204_chip *chip = container_of(misc, struct atsha204_chip, 370 | miscdev); 371 | struct atsha204_file_priv *priv; 372 | 373 | if (!atomic_dec_and_test(&atsha204_avail)){ 374 | atomic_inc(&atsha204_avail); 375 | return -EBUSY; 376 | } 377 | 378 | priv = kzalloc(sizeof(*priv), GFP_KERNEL); 379 | if (NULL == priv) 380 | return -ENOMEM; 381 | 382 | priv->chip = chip; 383 | 384 | filep->private_data = priv; 385 | 386 | filep->f_pos = 0; 387 | 388 | return 0; 389 | 390 | } 391 | 392 | 393 | int atsha204_i2c_release(struct inode *inode, struct file *filep) 394 | { 395 | 396 | atomic_inc(&atsha204_avail); 397 | 398 | return 0; 399 | } 400 | 401 | 402 | 403 | 404 | struct atsha204_chip *atsha204_i2c_register_hardware(struct device *dev, 405 | struct i2c_client *client) 406 | { 407 | 408 | struct atsha204_chip *chip; 409 | 410 | if ((chip = kzalloc(sizeof(*chip), GFP_KERNEL)) == NULL) 411 | goto out_null; 412 | 413 | chip->dev_num = 0; 414 | scnprintf(chip->devname, sizeof(chip->devname), "%s%d", 415 | "atsha", chip->dev_num); 416 | 417 | chip->dev = get_device(dev); 418 | dev_set_drvdata(dev, chip); 419 | 420 | chip->client = client; 421 | 422 | mutex_init(&chip->transaction_mutex); 423 | 424 | if (atsha204_i2c_add_device(chip)){ 425 | dev_err(dev, "%s\n", "Failed to add device"); 426 | goto put_device; 427 | } 428 | else{ 429 | int rc = hwrng_register(&atsha204_i2c_rng); 430 | dev_dbg(dev, "%s%d\n", "HWRNG result: ", rc); 431 | } 432 | 433 | 434 | return chip; 435 | 436 | put_device: 437 | put_device(chip->dev); 438 | 439 | kfree(chip); 440 | out_null: 441 | return NULL; 442 | } 443 | 444 | 445 | int atsha204_i2c_probe(struct i2c_client *client, 446 | const struct i2c_device_id *id) 447 | { 448 | int result = -1; 449 | struct device *dev = &client->dev; 450 | struct atsha204_chip *chip; 451 | 452 | if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) 453 | return -ENODEV; 454 | 455 | if((result = atsha204_i2c_wakeup(client)) == 0){ 456 | pr_debug("%s: 0x%x\n", "ATSHA204 Device is awake", 457 | client->addr); 458 | 459 | atsha204_i2c_idle(client); 460 | 461 | if ((chip = atsha204_i2c_register_hardware(dev, client)) 462 | == NULL){ 463 | return -ENODEV; 464 | } 465 | 466 | else { 467 | global_chip = chip; 468 | } 469 | 470 | result = atsha204_sysfs_add_device(chip); 471 | } 472 | 473 | else{ 474 | pr_err("%s: 0x%x\n", "ATSHA204 device failed to wake", 475 | client->addr); 476 | } 477 | 478 | return result; 479 | } 480 | 481 | int atsha204_i2c_remove(struct i2c_client *client) 482 | 483 | { 484 | struct device *dev = &(client->dev); 485 | struct atsha204_chip *chip = dev_get_drvdata(dev); 486 | 487 | if (chip){ 488 | misc_deregister(&chip->miscdev); 489 | atsha204_sysfs_del_device(chip); 490 | } 491 | 492 | hwrng_unregister(&atsha204_i2c_rng); 493 | 494 | kfree(chip); 495 | 496 | global_chip = NULL; 497 | 498 | /* The device is in an idle state, where it keeps ephemeral 499 | * memory. Wakeup the device and sleep it, which will cause it 500 | * to clear its internal memory */ 501 | 502 | atsha204_i2c_wakeup(client); 503 | atsha204_i2c_sleep(client); 504 | 505 | return 0; 506 | 507 | } 508 | 509 | 510 | 511 | 512 | 513 | MODULE_DEVICE_TABLE(i2c, atsha204_i2c_id); 514 | 515 | static struct i2c_driver atsha204_i2c_driver = { 516 | .driver = { 517 | .name = "atsha204-i2c", 518 | .owner = THIS_MODULE, 519 | }, 520 | .probe = atsha204_i2c_probe, 521 | .remove = atsha204_i2c_remove, 522 | .id_table = atsha204_i2c_id, 523 | }; 524 | 525 | static int __init atsha204_i2c_init(void) 526 | { 527 | return i2c_add_driver(&atsha204_i2c_driver); 528 | } 529 | 530 | 531 | static void __exit atsha204_i2c_driver_cleanup(void) 532 | { 533 | i2c_del_driver(&atsha204_i2c_driver); 534 | } 535 | module_init(atsha204_i2c_init); 536 | module_exit(atsha204_i2c_driver_cleanup); 537 | 538 | static const struct file_operations atsha204_i2c_fops = { 539 | .owner = THIS_MODULE, 540 | .llseek = no_llseek, 541 | .open = atsha204_i2c_open, 542 | .read = atsha204_i2c_read, 543 | .write = atsha204_i2c_write, 544 | .release = atsha204_i2c_release, 545 | }; 546 | 547 | 548 | int atsha204_i2c_add_device(struct atsha204_chip *chip) 549 | { 550 | int retval; 551 | 552 | chip->miscdev.fops = &atsha204_i2c_fops; 553 | chip->miscdev.minor = MISC_DYNAMIC_MINOR; 554 | 555 | chip->miscdev.name = chip->devname; 556 | chip->miscdev.parent = chip->dev; 557 | 558 | if ((retval = misc_register(&chip->miscdev)) != 0){ 559 | chip->miscdev.name = NULL; 560 | dev_err(chip->dev, 561 | "unable to misc_register %s, minor %d err=%d\n", 562 | chip->miscdev.name, 563 | chip->miscdev.minor, 564 | retval); 565 | } 566 | 567 | 568 | return retval; 569 | } 570 | 571 | int atsha204_i2c_read4(struct atsha204_chip *chip, u8 *read_buf, 572 | const u16 addr, const u8 param1) 573 | { 574 | u8 read_cmd[8] = {0}; 575 | u16 crc; 576 | struct atsha204_buffer rsp, msg; 577 | int rc, validate_status; 578 | 579 | read_cmd[0] = 0x03; /* Command byte */ 580 | read_cmd[1] = 0x07; /* length */ 581 | read_cmd[2] = 0x02; /* Read command opcode */ 582 | read_cmd[3] = param1; 583 | read_cmd[4] = cpu_to_le16(addr) & 0xFF; 584 | read_cmd[5] = cpu_to_le16(addr) >> 8; 585 | 586 | crc = atsha204_crc16(&read_cmd[1], 5); 587 | 588 | 589 | read_cmd[6] = cpu_to_le16(crc) & 0xFF; 590 | read_cmd[7] = cpu_to_le16(crc) >> 8; 591 | 592 | rc = atsha204_i2c_transaction(chip, read_cmd, 593 | sizeof(read_cmd), &rsp); 594 | 595 | if (sizeof(read_cmd) == rc){ 596 | if ((validate_status = atsha204_i2c_validate_rsp(&rsp, &msg)) 597 | == 0){ 598 | memcpy(read_buf, msg.ptr, msg.len); 599 | kfree(rsp.ptr); 600 | rc = msg.len; 601 | } 602 | else 603 | rc = validate_status; 604 | 605 | } 606 | 607 | return rc; 608 | 609 | 610 | 611 | } 612 | 613 | 614 | static ssize_t configzone_show(struct device *dev, 615 | struct device_attribute *attr, 616 | char *buf) 617 | { 618 | struct atsha204_chip *chip = dev_get_drvdata(dev); 619 | int i; 620 | u16 bytes, word_addr; 621 | bool keep_going = true; 622 | u8 param1 = 0; /* indicates configzone region */ 623 | char *str = buf; 624 | 625 | u8 configzone[128] = {0}; 626 | 627 | for (bytes = 0; bytes < sizeof(configzone) && keep_going; bytes += 4){ 628 | word_addr = bytes / 4; 629 | if (4 != atsha204_i2c_read4(chip, 630 | &configzone[bytes], 631 | word_addr, param1)){ 632 | keep_going = false; 633 | } 634 | } 635 | 636 | for (i = 0; i < bytes; i++) { 637 | str += sprintf(str, "%02X ", configzone[i]); 638 | if ((i + 1) % 4 == 0) 639 | str += sprintf(str, "\n"); 640 | } 641 | 642 | return str - buf; 643 | } 644 | /*static DEVICE_ATTR_RO(configzone);*/ 645 | struct device_attribute dev_attr_configzone = __ATTR_RO(configzone); 646 | 647 | static ssize_t serialnum_show(struct device *dev, 648 | struct device_attribute *attr, 649 | char *buf) 650 | { 651 | struct atsha204_chip *chip = dev_get_drvdata(dev); 652 | int i; 653 | u16 bytes, word_addr; 654 | bool keep_going = true; 655 | u8 param1 = 0; /* indicates configzone region */ 656 | char *str = buf; 657 | 658 | u8 serial[12] = {0}; 659 | 660 | for (bytes = 0; bytes < sizeof(serial) && keep_going; bytes += 4){ 661 | word_addr = bytes / 4; 662 | if (4 != atsha204_i2c_read4(chip, 663 | &serial[bytes], 664 | word_addr, param1)){ 665 | keep_going = false; 666 | } 667 | } 668 | 669 | for (i = 0; i < bytes; i++) { 670 | str += sprintf(str, "%02X", serial[i]); 671 | if ((i + 1) % sizeof(serial) == 0) 672 | str += sprintf(str, "\n"); 673 | } 674 | 675 | return str - buf; 676 | } 677 | /*static DEVICE_ATTR_RO(configzone);*/ 678 | struct device_attribute dev_attr_serialnum = __ATTR_RO(serialnum); 679 | 680 | static ssize_t is_locked(struct device *dev, 681 | struct device_attribute *attr, 682 | char *buf, 683 | const int offset) 684 | { 685 | struct atsha204_chip *chip = dev_get_drvdata(dev); 686 | const u16 LOCK_ADDR = 0x15; 687 | u8 param1 = 0; /* indicates configzone region */ 688 | char *str = buf; 689 | u8 lock_buf[4]; 690 | const u8 UNLOCKED = 0x55; 691 | 692 | if (sizeof(lock_buf) == atsha204_i2c_read4(chip, 693 | lock_buf, 694 | LOCK_ADDR, param1)){ 695 | 696 | if (UNLOCKED == lock_buf[offset]) 697 | str += sprintf(str, "0"); 698 | else 699 | str += sprintf(str, "1"); 700 | 701 | str += sprintf(str, "\n"); 702 | 703 | } 704 | 705 | return str - buf; 706 | } 707 | 708 | static ssize_t configlocked_show(struct device *dev, 709 | struct device_attribute *attr, 710 | char *buf) 711 | { 712 | const int CONFIG_ZONE_LOCK_OFFSET = 3; 713 | 714 | return is_locked(dev, attr, buf, CONFIG_ZONE_LOCK_OFFSET); 715 | } 716 | struct device_attribute dev_attr_configlocked = __ATTR_RO(configlocked); 717 | 718 | static ssize_t datalocked_show(struct device *dev, 719 | struct device_attribute *attr, 720 | char *buf) 721 | { 722 | const int DATA_ZONE_LOCK_OFFSET = 2; 723 | 724 | return is_locked(dev, attr, buf, DATA_ZONE_LOCK_OFFSET); 725 | } 726 | struct device_attribute dev_attr_datalocked = __ATTR_RO(datalocked); 727 | 728 | static struct attribute *atsha204_dev_attrs[] = { 729 | &dev_attr_configzone.attr, 730 | &dev_attr_serialnum.attr, 731 | &dev_attr_configlocked.attr, 732 | &dev_attr_datalocked.attr, 733 | NULL, 734 | }; 735 | 736 | static const struct attribute_group atsha204_dev_group = { 737 | .attrs = atsha204_dev_attrs, 738 | }; 739 | 740 | int atsha204_sysfs_add_device(struct atsha204_chip *chip) 741 | { 742 | int err; 743 | err = sysfs_create_group(&chip->dev->kobj, 744 | &atsha204_dev_group); 745 | 746 | if (err) 747 | dev_err(chip->dev, 748 | "failed to create sysfs attributes, %d\n", err); 749 | return err; 750 | } 751 | 752 | void atsha204_sysfs_del_device(struct atsha204_chip *chip) 753 | { 754 | sysfs_remove_group(&chip->dev->kobj, &atsha204_dev_group); 755 | } 756 | 757 | MODULE_AUTHOR("Josh Datko 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | . --------------------------------------------------------------------------------