4 * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/mod_devicetable.h>
25 #include <linux/usb.h>
29 static struct usb_device_id ds_id_table [] = {
30 { USB_DEVICE(0x04fa, 0x2490) },
33 MODULE_DEVICE_TABLE(usb, ds_id_table);
35 static int ds_probe(struct usb_interface *, const struct usb_device_id *);
36 static void ds_disconnect(struct usb_interface *);
38 int ds_touch_bit(struct ds_device *, u8, u8 *);
39 int ds_read_byte(struct ds_device *, u8 *);
40 int ds_read_bit(struct ds_device *, u8 *);
41 int ds_write_byte(struct ds_device *, u8);
42 int ds_write_bit(struct ds_device *, u8);
43 static int ds_start_pulse(struct ds_device *, int);
44 int ds_reset(struct ds_device *, struct ds_status *);
45 struct ds_device * ds_get_device(void);
46 void ds_put_device(struct ds_device *);
48 static inline void ds_dump_status(unsigned char *, unsigned char *, int);
49 static int ds_send_control(struct ds_device *, u16, u16);
50 static int ds_send_control_mode(struct ds_device *, u16, u16);
51 static int ds_send_control_cmd(struct ds_device *, u16, u16);
54 static struct usb_driver ds_driver = {
57 .disconnect = ds_disconnect,
58 .id_table = ds_id_table,
61 static struct ds_device *ds_dev;
63 struct ds_device * ds_get_device(void)
66 atomic_inc(&ds_dev->refcnt);
70 void ds_put_device(struct ds_device *dev)
72 atomic_dec(&dev->refcnt);
75 static int ds_send_control_cmd(struct ds_device *dev, u16 value, u16 index)
79 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
80 CONTROL_CMD, 0x40, value, index, NULL, 0, 1000);
82 printk(KERN_ERR "Failed to send command control message %x.%x: err=%d.\n",
90 static int ds_send_control_mode(struct ds_device *dev, u16 value, u16 index)
94 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
95 MODE_CMD, 0x40, value, index, NULL, 0, 1000);
97 printk(KERN_ERR "Failed to send mode control message %x.%x: err=%d.\n",
105 static int ds_send_control(struct ds_device *dev, u16 value, u16 index)
109 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
110 COMM_CMD, 0x40, value, index, NULL, 0, 1000);
112 printk(KERN_ERR "Failed to send control message %x.%x: err=%d.\n",
120 static inline void ds_dump_status(unsigned char *buf, unsigned char *str, int off)
122 printk("%45s: %8x\n", str, buf[off]);
125 static int ds_recv_status_nodump(struct ds_device *dev, struct ds_status *st,
126 unsigned char *buf, int size)
130 memset(st, 0, sizeof(st));
133 err = usb_bulk_msg(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_STATUS]), buf, size, &count, 100);
135 printk(KERN_ERR "Failed to read 1-wire data from 0x%x: err=%d.\n", dev->ep[EP_STATUS], err);
139 if (count >= sizeof(*st))
140 memcpy(st, buf, sizeof(*st));
145 static int ds_recv_status(struct ds_device *dev, struct ds_status *st)
147 unsigned char buf[64];
148 int count, err = 0, i;
150 memcpy(st, buf, sizeof(*st));
152 count = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
156 printk("0x%x: count=%d, status: ", dev->ep[EP_STATUS], count);
157 for (i=0; i<count; ++i)
158 printk("%02x ", buf[i]);
162 ds_dump_status(buf, "enable flag", 0);
163 ds_dump_status(buf, "1-wire speed", 1);
164 ds_dump_status(buf, "strong pullup duration", 2);
165 ds_dump_status(buf, "programming pulse duration", 3);
166 ds_dump_status(buf, "pulldown slew rate control", 4);
167 ds_dump_status(buf, "write-1 low time", 5);
168 ds_dump_status(buf, "data sample offset/write-0 recovery time", 6);
169 ds_dump_status(buf, "reserved (test register)", 7);
170 ds_dump_status(buf, "device status flags", 8);
171 ds_dump_status(buf, "communication command byte 1", 9);
172 ds_dump_status(buf, "communication command byte 2", 10);
173 ds_dump_status(buf, "communication command buffer status", 11);
174 ds_dump_status(buf, "1-wire data output buffer status", 12);
175 ds_dump_status(buf, "1-wire data input buffer status", 13);
176 ds_dump_status(buf, "reserved", 14);
177 ds_dump_status(buf, "reserved", 15);
180 memcpy(st, buf, sizeof(*st));
182 if (st->status & ST_EPOF) {
183 printk(KERN_INFO "Resetting device after ST_EPOF.\n");
184 err = ds_send_control_cmd(dev, CTL_RESET_DEVICE, 0);
187 count = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
192 if (st->status & ST_IDLE) {
193 printk(KERN_INFO "Resetting pulse after ST_IDLE.\n");
194 err = ds_start_pulse(dev, PULLUP_PULSE_DURATION);
203 static int ds_recv_data(struct ds_device *dev, unsigned char *buf, int size)
209 err = usb_bulk_msg(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_DATA_IN]),
210 buf, size, &count, 1000);
212 printk(KERN_INFO "Clearing ep0x%x.\n", dev->ep[EP_DATA_IN]);
213 usb_clear_halt(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_DATA_IN]));
214 ds_recv_status(dev, &st);
222 printk("%s: count=%d: ", __func__, count);
223 for (i=0; i<count; ++i)
224 printk("%02x ", buf[i]);
231 static int ds_send_data(struct ds_device *dev, unsigned char *buf, int len)
236 err = usb_bulk_msg(dev->udev, usb_sndbulkpipe(dev->udev, dev->ep[EP_DATA_OUT]), buf, len, &count, 1000);
238 printk(KERN_ERR "Failed to read 1-wire data from 0x02: err=%d.\n", err);
247 int ds_stop_pulse(struct ds_device *dev, int limit)
250 int count = 0, err = 0;
254 err = ds_send_control(dev, CTL_HALT_EXE_IDLE, 0);
257 err = ds_send_control(dev, CTL_RESUME_EXE, 0);
260 err = ds_recv_status_nodump(dev, &st, buf, sizeof(buf));
264 if ((st.status & ST_SPUA) == 0) {
265 err = ds_send_control_mode(dev, MOD_PULSE_EN, 0);
269 } while(++count < limit);
274 int ds_detect(struct ds_device *dev, struct ds_status *st)
278 err = ds_send_control_cmd(dev, CTL_RESET_DEVICE, 0);
282 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM, 0);
286 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM | COMM_TYPE, 0x40);
290 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_PROG);
294 err = ds_recv_status(dev, st);
301 static int ds_wait_status(struct ds_device *dev, struct ds_status *st)
307 err = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
311 printk("0x%x: count=%d, status: ", dev->ep[EP_STATUS], err);
312 for (i=0; i<err; ++i)
313 printk("%02x ", buf[i]);
317 } while(!(buf[0x08] & 0x20) && !(err < 0) && ++count < 100);
320 if (((err > 16) && (buf[0x10] & 0x01)) || count >= 100 || err < 0) {
321 ds_recv_status(dev, st);
327 int ds_reset(struct ds_device *dev, struct ds_status *st)
331 //err = ds_send_control(dev, COMM_1_WIRE_RESET | COMM_F | COMM_IM | COMM_SE, SPEED_FLEXIBLE);
332 err = ds_send_control(dev, 0x43, SPEED_NORMAL);
336 ds_wait_status(dev, st);
338 if (st->command_buffer_status) {
339 printk(KERN_INFO "Short circuit.\n");
348 int ds_set_speed(struct ds_device *dev, int speed)
352 if (speed != SPEED_NORMAL && speed != SPEED_FLEXIBLE && speed != SPEED_OVERDRIVE)
355 if (speed != SPEED_OVERDRIVE)
356 speed = SPEED_FLEXIBLE;
360 err = ds_send_control_mode(dev, MOD_1WIRE_SPEED, speed);
368 static int ds_start_pulse(struct ds_device *dev, int delay)
371 u8 del = 1 + (u8)(delay >> 4);
375 err = ds_stop_pulse(dev, 10);
379 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_SPUE);
383 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM, del);
387 err = ds_send_control(dev, COMM_PULSE | COMM_IM | COMM_F, 0);
393 ds_wait_status(dev, &st);
398 int ds_touch_bit(struct ds_device *dev, u8 bit, u8 *tbit)
402 u16 value = (COMM_BIT_IO | COMM_IM) | ((bit) ? COMM_D : 0);
405 err = ds_send_control(dev, value, 0);
411 err = ds_wait_status(dev, &st);
415 cmd = st.command0 | (st.command1 << 8);
416 } while (cmd != value && ++count < 10);
418 if (err < 0 || count >= 10) {
419 printk(KERN_ERR "Failed to obtain status.\n");
423 err = ds_recv_data(dev, tbit, sizeof(*tbit));
430 int ds_write_bit(struct ds_device *dev, u8 bit)
435 err = ds_send_control(dev, COMM_BIT_IO | COMM_IM | (bit) ? COMM_D : 0, 0);
439 ds_wait_status(dev, &st);
444 int ds_write_byte(struct ds_device *dev, u8 byte)
450 err = ds_send_control(dev, COMM_BYTE_IO | COMM_IM | COMM_SPU, byte);
454 err = ds_wait_status(dev, &st);
458 err = ds_recv_data(dev, &rbyte, sizeof(rbyte));
462 ds_start_pulse(dev, PULLUP_PULSE_DURATION);
464 return !(byte == rbyte);
467 int ds_read_bit(struct ds_device *dev, u8 *bit)
471 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_SPUE);
475 err = ds_send_control(dev, COMM_BIT_IO | COMM_IM | COMM_SPU | COMM_D, 0);
479 err = ds_recv_data(dev, bit, sizeof(*bit));
486 int ds_read_byte(struct ds_device *dev, u8 *byte)
491 err = ds_send_control(dev, COMM_BYTE_IO | COMM_IM , 0xff);
495 ds_wait_status(dev, &st);
497 err = ds_recv_data(dev, byte, sizeof(*byte));
504 int ds_read_block(struct ds_device *dev, u8 *buf, int len)
512 memset(buf, 0xFF, len);
514 err = ds_send_data(dev, buf, len);
518 err = ds_send_control(dev, COMM_BLOCK_IO | COMM_IM | COMM_SPU, len);
522 ds_wait_status(dev, &st);
524 memset(buf, 0x00, len);
525 err = ds_recv_data(dev, buf, len);
530 int ds_write_block(struct ds_device *dev, u8 *buf, int len)
535 err = ds_send_data(dev, buf, len);
539 ds_wait_status(dev, &st);
541 err = ds_send_control(dev, COMM_BLOCK_IO | COMM_IM | COMM_SPU, len);
545 ds_wait_status(dev, &st);
547 err = ds_recv_data(dev, buf, len);
551 ds_start_pulse(dev, PULLUP_PULSE_DURATION);
553 return !(err == len);
558 int ds_search(struct ds_device *dev, u64 init, u64 *buf, u8 id_number, int conditional_search)
564 memset(buf, 0, sizeof(buf));
566 err = ds_send_data(ds_dev, (unsigned char *)&init, 8);
570 ds_wait_status(ds_dev, &st);
572 value = COMM_SEARCH_ACCESS | COMM_IM | COMM_SM | COMM_F | COMM_RTS;
573 index = (conditional_search ? 0xEC : 0xF0) | (id_number << 8);
574 err = ds_send_control(ds_dev, value, index);
578 ds_wait_status(ds_dev, &st);
580 err = ds_recv_data(ds_dev, (unsigned char *)buf, 8*id_number);
587 int ds_match_access(struct ds_device *dev, u64 init)
592 err = ds_send_data(dev, (unsigned char *)&init, sizeof(init));
596 ds_wait_status(dev, &st);
598 err = ds_send_control(dev, COMM_MATCH_ACCESS | COMM_IM | COMM_RST, 0x0055);
602 ds_wait_status(dev, &st);
607 int ds_set_path(struct ds_device *dev, u64 init)
613 memcpy(buf, &init, 8);
614 buf[8] = BRANCH_MAIN;
616 err = ds_send_data(dev, buf, sizeof(buf));
620 ds_wait_status(dev, &st);
622 err = ds_send_control(dev, COMM_SET_PATH | COMM_IM | COMM_RST, 0);
626 ds_wait_status(dev, &st);
633 static int ds_probe(struct usb_interface *intf,
634 const struct usb_device_id *udev_id)
636 struct usb_device *udev = interface_to_usbdev(intf);
637 struct usb_endpoint_descriptor *endpoint;
638 struct usb_host_interface *iface_desc;
641 ds_dev = kmalloc(sizeof(struct ds_device), GFP_KERNEL);
643 printk(KERN_INFO "Failed to allocate new DS9490R structure.\n");
647 ds_dev->udev = usb_get_dev(udev);
648 usb_set_intfdata(intf, ds_dev);
650 err = usb_set_interface(ds_dev->udev, intf->altsetting[0].desc.bInterfaceNumber, 3);
652 printk(KERN_ERR "Failed to set alternative setting 3 for %d interface: err=%d.\n",
653 intf->altsetting[0].desc.bInterfaceNumber, err);
657 err = usb_reset_configuration(ds_dev->udev);
659 printk(KERN_ERR "Failed to reset configuration: err=%d.\n", err);
663 iface_desc = &intf->altsetting[0];
664 if (iface_desc->desc.bNumEndpoints != NUM_EP-1) {
665 printk(KERN_INFO "Num endpoints=%d. It is not DS9490R.\n", iface_desc->desc.bNumEndpoints);
669 atomic_set(&ds_dev->refcnt, 0);
670 memset(ds_dev->ep, 0, sizeof(ds_dev->ep));
673 * This loop doesn'd show control 0 endpoint,
674 * so we will fill only 1-3 endpoints entry.
676 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
677 endpoint = &iface_desc->endpoint[i].desc;
679 ds_dev->ep[i+1] = endpoint->bEndpointAddress;
681 printk("%d: addr=%x, size=%d, dir=%s, type=%x\n",
682 i, endpoint->bEndpointAddress, le16_to_cpu(endpoint->wMaxPacketSize),
683 (endpoint->bEndpointAddress & USB_DIR_IN)?"IN":"OUT",
684 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
691 u64 init=0xb30000002078ee81ull;
694 ds_reset(ds_dev, &st);
695 err = ds_search(ds_dev, init, buf, 3, 0);
698 for (i=0; i<err; ++i)
699 printk("%d: %llx\n", i, buf[i]);
701 printk("Resetting...\n");
702 ds_reset(ds_dev, &st);
703 printk("Setting path for %llx.\n", init);
704 err = ds_set_path(ds_dev, init);
707 printk("Calling MATCH_ACCESS.\n");
708 err = ds_match_access(ds_dev, init);
712 printk("Searching the bus...\n");
713 err = ds_search(ds_dev, init, buf, 3, 0);
715 printk("ds_search() returned %d\n", err);
719 for (i=0; i<err; ++i)
720 printk("%d: %llx\n", i, buf[i]);
729 static void ds_disconnect(struct usb_interface *intf)
731 struct ds_device *dev;
733 dev = usb_get_intfdata(intf);
734 usb_set_intfdata(intf, NULL);
736 while (atomic_read(&dev->refcnt)) {
737 printk(KERN_INFO "Waiting for DS to become free: refcnt=%d.\n",
738 atomic_read(&dev->refcnt));
740 if (msleep_interruptible(1000))
741 flush_signals(current);
744 usb_put_dev(dev->udev);
749 static int ds_init(void)
753 err = usb_register(&ds_driver);
755 printk(KERN_INFO "Failed to register DS9490R USB device: err=%d.\n", err);
762 static void ds_fini(void)
764 usb_deregister(&ds_driver);
767 module_init(ds_init);
768 module_exit(ds_fini);
770 MODULE_LICENSE("GPL");
771 MODULE_AUTHOR("Evgeniy Polyakov <johnpol@2ka.mipt.ru>");
773 EXPORT_SYMBOL(ds_touch_bit);
774 EXPORT_SYMBOL(ds_read_byte);
775 EXPORT_SYMBOL(ds_read_bit);
776 EXPORT_SYMBOL(ds_read_block);
777 EXPORT_SYMBOL(ds_write_byte);
778 EXPORT_SYMBOL(ds_write_bit);
779 EXPORT_SYMBOL(ds_write_block);
780 EXPORT_SYMBOL(ds_reset);
781 EXPORT_SYMBOL(ds_get_device);
782 EXPORT_SYMBOL(ds_put_device);
785 * This functions can be used for EEPROM programming,
786 * when driver will be included into mainline this will
787 * require uncommenting.
790 EXPORT_SYMBOL(ds_start_pulse);
791 EXPORT_SYMBOL(ds_set_speed);
792 EXPORT_SYMBOL(ds_detect);
793 EXPORT_SYMBOL(ds_stop_pulse);
794 EXPORT_SYMBOL(ds_search);