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 int ds_probe(struct usb_interface *, const struct usb_device_id *);
36 void ds_disconnect(struct usb_interface *);
38 inline int ds_touch_bit(struct ds_device *, u8, u8 *);
39 inline int ds_read_byte(struct ds_device *, u8 *);
40 inline int ds_read_bit(struct ds_device *, u8 *);
41 inline int ds_write_byte(struct ds_device *, u8);
42 inline int ds_write_bit(struct ds_device *, u8);
43 inline int ds_start_pulse(struct ds_device *, int);
44 inline int ds_set_speed(struct ds_device *, int);
45 inline int ds_reset(struct ds_device *, struct ds_status *);
46 inline int ds_detect(struct ds_device *, struct ds_status *);
47 inline int ds_stop_pulse(struct ds_device *, int);
48 inline int ds_send_data(struct ds_device *, unsigned char *, int);
49 inline int ds_recv_data(struct ds_device *, unsigned char *, int);
50 inline int ds_recv_status(struct ds_device *, struct ds_status *);
51 inline struct ds_device * ds_get_device(void);
52 inline void ds_put_device(struct ds_device *);
54 static inline void ds_dump_status(unsigned char *, unsigned char *, int);
55 static inline int ds_send_control(struct ds_device *, u16, u16);
56 static inline int ds_send_control_mode(struct ds_device *, u16, u16);
57 static inline int ds_send_control_cmd(struct ds_device *, u16, u16);
60 static struct usb_driver ds_driver = {
64 .disconnect = ds_disconnect,
65 .id_table = ds_id_table,
68 static struct ds_device *ds_dev;
70 struct ds_device * ds_get_device(void)
73 atomic_inc(&ds_dev->refcnt);
77 void ds_put_device(struct ds_device *dev)
79 atomic_dec(&dev->refcnt);
82 static int ds_send_control_cmd(struct ds_device *dev, u16 value, u16 index)
86 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
87 CONTROL_CMD, 0x40, value, index, NULL, 0, HZ);
89 printk(KERN_ERR "Failed to send command control message %x.%x: err=%d.\n",
97 static int ds_send_control_mode(struct ds_device *dev, u16 value, u16 index)
101 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
102 MODE_CMD, 0x40, value, index, NULL, 0, HZ);
104 printk(KERN_ERR "Failed to send mode control message %x.%x: err=%d.\n",
112 static int ds_send_control(struct ds_device *dev, u16 value, u16 index)
116 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
117 COMM_CMD, 0x40, value, index, NULL, 0, HZ);
119 printk(KERN_ERR "Failed to send control message %x.%x: err=%d.\n",
127 static inline void ds_dump_status(unsigned char *buf, unsigned char *str, int off)
129 printk("%45s: %8x\n", str, buf[off]);
132 int ds_recv_status_nodump(struct ds_device *dev, struct ds_status *st, unsigned char *buf, int size)
136 memset(st, 0, sizeof(st));
139 err = usb_bulk_msg(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_STATUS]), buf, size, &count, 100);
141 printk(KERN_ERR "Failed to read 1-wire data from 0x%x: err=%d.\n", dev->ep[EP_STATUS], err);
145 if (count >= sizeof(*st))
146 memcpy(st, buf, sizeof(*st));
151 int ds_recv_status(struct ds_device *dev, struct ds_status *st)
153 unsigned char buf[64];
154 int count, err = 0, i;
156 memcpy(st, buf, sizeof(*st));
158 count = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
162 printk("0x%x: count=%d, status: ", dev->ep[EP_STATUS], count);
163 for (i=0; i<count; ++i)
164 printk("%02x ", buf[i]);
168 ds_dump_status(buf, "enable flag", 0);
169 ds_dump_status(buf, "1-wire speed", 1);
170 ds_dump_status(buf, "strong pullup duration", 2);
171 ds_dump_status(buf, "programming pulse duration", 3);
172 ds_dump_status(buf, "pulldown slew rate control", 4);
173 ds_dump_status(buf, "write-1 low time", 5);
174 ds_dump_status(buf, "data sample offset/write-0 recovery time", 6);
175 ds_dump_status(buf, "reserved (test register)", 7);
176 ds_dump_status(buf, "device status flags", 8);
177 ds_dump_status(buf, "communication command byte 1", 9);
178 ds_dump_status(buf, "communication command byte 2", 10);
179 ds_dump_status(buf, "communication command buffer status", 11);
180 ds_dump_status(buf, "1-wire data output buffer status", 12);
181 ds_dump_status(buf, "1-wire data input buffer status", 13);
182 ds_dump_status(buf, "reserved", 14);
183 ds_dump_status(buf, "reserved", 15);
186 memcpy(st, buf, sizeof(*st));
188 if (st->status & ST_EPOF) {
189 printk(KERN_INFO "Resetting device after ST_EPOF.\n");
190 err = ds_send_control_cmd(dev, CTL_RESET_DEVICE, 0);
193 count = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
198 if (st->status & ST_IDLE) {
199 printk(KERN_INFO "Resetting pulse after ST_IDLE.\n");
200 err = ds_start_pulse(dev, PULLUP_PULSE_DURATION);
209 int ds_recv_data(struct ds_device *dev, unsigned char *buf, int size)
215 err = usb_bulk_msg(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_DATA_IN]),
216 buf, size, &count, HZ);
218 printk(KERN_INFO "Clearing ep0x%x.\n", dev->ep[EP_DATA_IN]);
219 usb_clear_halt(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_DATA_IN]));
220 ds_recv_status(dev, &st);
228 printk("%s: count=%d: ", __func__, count);
229 for (i=0; i<count; ++i)
230 printk("%02x ", buf[i]);
237 int ds_send_data(struct ds_device *dev, unsigned char *buf, int len)
242 err = usb_bulk_msg(dev->udev, usb_sndbulkpipe(dev->udev, dev->ep[EP_DATA_OUT]), buf, len, &count, HZ);
244 printk(KERN_ERR "Failed to read 1-wire data from 0x02: err=%d.\n", err);
251 int ds_stop_pulse(struct ds_device *dev, int limit)
254 int count = 0, err = 0;
258 err = ds_send_control(dev, CTL_HALT_EXE_IDLE, 0);
261 err = ds_send_control(dev, CTL_RESUME_EXE, 0);
264 err = ds_recv_status_nodump(dev, &st, buf, sizeof(buf));
268 if ((st.status & ST_SPUA) == 0) {
269 err = ds_send_control_mode(dev, MOD_PULSE_EN, 0);
273 } while(++count < limit);
278 int ds_detect(struct ds_device *dev, struct ds_status *st)
282 err = ds_send_control_cmd(dev, CTL_RESET_DEVICE, 0);
286 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM, 0);
290 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM | COMM_TYPE, 0x40);
294 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_PROG);
298 err = ds_recv_status(dev, st);
303 int ds_wait_status(struct ds_device *dev, struct ds_status *st)
309 err = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
313 printk("0x%x: count=%d, status: ", dev->ep[EP_STATUS], err);
314 for (i=0; i<err; ++i)
315 printk("%02x ", buf[i]);
319 } while(!(buf[0x08] & 0x20) && !(err < 0) && ++count < 100);
322 if (((err > 16) && (buf[0x10] & 0x01)) || count >= 100 || err < 0) {
323 ds_recv_status(dev, st);
331 int ds_reset(struct ds_device *dev, struct ds_status *st)
335 //err = ds_send_control(dev, COMM_1_WIRE_RESET | COMM_F | COMM_IM | COMM_SE, SPEED_FLEXIBLE);
336 err = ds_send_control(dev, 0x43, SPEED_NORMAL);
340 ds_wait_status(dev, st);
342 if (st->command_buffer_status) {
343 printk(KERN_INFO "Short circuit.\n");
351 int ds_set_speed(struct ds_device *dev, int speed)
355 if (speed != SPEED_NORMAL && speed != SPEED_FLEXIBLE && speed != SPEED_OVERDRIVE)
358 if (speed != SPEED_OVERDRIVE)
359 speed = SPEED_FLEXIBLE;
363 err = ds_send_control_mode(dev, MOD_1WIRE_SPEED, speed);
370 int ds_start_pulse(struct ds_device *dev, int delay)
373 u8 del = 1 + (u8)(delay >> 4);
377 err = ds_stop_pulse(dev, 10);
381 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_SPUE);
385 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM, del);
389 err = ds_send_control(dev, COMM_PULSE | COMM_IM | COMM_F, 0);
395 ds_wait_status(dev, &st);
400 int ds_touch_bit(struct ds_device *dev, u8 bit, u8 *tbit)
404 u16 value = (COMM_BIT_IO | COMM_IM) | ((bit) ? COMM_D : 0);
407 err = ds_send_control(dev, value, 0);
413 err = ds_wait_status(dev, &st);
417 cmd = st.command0 | (st.command1 << 8);
418 } while (cmd != value && ++count < 10);
420 if (err < 0 || count >= 10) {
421 printk(KERN_ERR "Failed to obtain status.\n");
425 err = ds_recv_data(dev, tbit, sizeof(*tbit));
432 int ds_write_bit(struct ds_device *dev, u8 bit)
437 err = ds_send_control(dev, COMM_BIT_IO | COMM_IM | (bit) ? COMM_D : 0, 0);
441 ds_wait_status(dev, &st);
446 int ds_write_byte(struct ds_device *dev, u8 byte)
452 err = ds_send_control(dev, COMM_BYTE_IO | COMM_IM | COMM_SPU, byte);
456 err = ds_wait_status(dev, &st);
460 err = ds_recv_data(dev, &rbyte, sizeof(rbyte));
464 ds_start_pulse(dev, PULLUP_PULSE_DURATION);
466 return !(byte == rbyte);
469 int ds_read_bit(struct ds_device *dev, u8 *bit)
473 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_SPUE);
477 err = ds_send_control(dev, COMM_BIT_IO | COMM_IM | COMM_SPU | COMM_D, 0);
481 err = ds_recv_data(dev, bit, sizeof(*bit));
488 int ds_read_byte(struct ds_device *dev, u8 *byte)
493 err = ds_send_control(dev, COMM_BYTE_IO | COMM_IM , 0xff);
497 ds_wait_status(dev, &st);
499 err = ds_recv_data(dev, byte, sizeof(*byte));
506 inline int ds_read_block(struct ds_device *dev, u8 *buf, int len)
514 memset(buf, 0xFF, len);
516 err = ds_send_data(dev, buf, len);
520 err = ds_send_control(dev, COMM_BLOCK_IO | COMM_IM | COMM_SPU, len);
524 ds_wait_status(dev, &st);
526 memset(buf, 0x00, len);
527 err = ds_recv_data(dev, buf, len);
532 inline int ds_write_block(struct ds_device *dev, u8 *buf, int len)
537 err = ds_send_data(dev, buf, len);
541 ds_wait_status(dev, &st);
543 err = ds_send_control(dev, COMM_BLOCK_IO | COMM_IM | COMM_SPU, len);
547 ds_wait_status(dev, &st);
549 err = ds_recv_data(dev, buf, len);
553 ds_start_pulse(dev, PULLUP_PULSE_DURATION);
555 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);
631 int ds_probe(struct usb_interface *intf, const struct usb_device_id *udev_id)
633 struct usb_device *udev = interface_to_usbdev(intf);
634 struct usb_endpoint_descriptor *endpoint;
635 struct usb_host_interface *iface_desc;
638 ds_dev = kmalloc(sizeof(struct ds_device), GFP_KERNEL);
640 printk(KERN_INFO "Failed to allocate new DS9490R structure.\n");
644 ds_dev->udev = usb_get_dev(udev);
645 usb_set_intfdata(intf, ds_dev);
647 err = usb_set_interface(ds_dev->udev, intf->altsetting[0].desc.bInterfaceNumber, 3);
649 printk(KERN_ERR "Failed to set alternative setting 3 for %d interface: err=%d.\n",
650 intf->altsetting[0].desc.bInterfaceNumber, err);
654 err = usb_reset_configuration(ds_dev->udev);
656 printk(KERN_ERR "Failed to reset configuration: err=%d.\n", err);
660 iface_desc = &intf->altsetting[0];
661 if (iface_desc->desc.bNumEndpoints != NUM_EP-1) {
662 printk(KERN_INFO "Num endpoints=%d. It is not DS9490R.\n", iface_desc->desc.bNumEndpoints);
666 atomic_set(&ds_dev->refcnt, 0);
667 memset(ds_dev->ep, 0, sizeof(ds_dev->ep));
670 * This loop doesn'd show control 0 endpoint,
671 * so we will fill only 1-3 endpoints entry.
673 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
674 endpoint = &iface_desc->endpoint[i].desc;
676 ds_dev->ep[i+1] = endpoint->bEndpointAddress;
678 printk("%d: addr=%x, size=%d, dir=%s, type=%x\n",
679 i, endpoint->bEndpointAddress, endpoint->wMaxPacketSize,
680 (endpoint->bEndpointAddress & USB_DIR_IN)?"IN":"OUT",
681 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
688 u64 init=0xb30000002078ee81ull;
691 ds_reset(ds_dev, &st);
692 err = ds_search(ds_dev, init, buf, 3, 0);
695 for (i=0; i<err; ++i)
696 printk("%d: %llx\n", i, buf[i]);
698 printk("Resetting...\n");
699 ds_reset(ds_dev, &st);
700 printk("Setting path for %llx.\n", init);
701 err = ds_set_path(ds_dev, init);
704 printk("Calling MATCH_ACCESS.\n");
705 err = ds_match_access(ds_dev, init);
709 printk("Searching the bus...\n");
710 err = ds_search(ds_dev, init, buf, 3, 0);
712 printk("ds_search() returned %d\n", err);
716 for (i=0; i<err; ++i)
717 printk("%d: %llx\n", i, buf[i]);
726 void ds_disconnect(struct usb_interface *intf)
728 struct ds_device *dev;
730 dev = usb_get_intfdata (intf);
731 usb_set_intfdata (intf, NULL);
733 while(atomic_read(&dev->refcnt))
734 schedule_timeout(HZ);
736 usb_put_dev(dev->udev);
745 err = usb_register(&ds_driver);
747 printk(KERN_INFO "Failed to register DS9490R USB device: err=%d.\n", err);
756 usb_deregister(&ds_driver);
759 module_init(ds_init);
760 module_exit(ds_fini);
762 MODULE_LICENSE("GPL");
763 MODULE_AUTHOR("Evgeniy Polyakov <johnpol@2ka.mipt.ru>");
765 EXPORT_SYMBOL(ds_touch_bit);
766 EXPORT_SYMBOL(ds_read_byte);
767 EXPORT_SYMBOL(ds_read_bit);
768 EXPORT_SYMBOL(ds_read_block);
769 EXPORT_SYMBOL(ds_write_byte);
770 EXPORT_SYMBOL(ds_write_bit);
771 EXPORT_SYMBOL(ds_write_block);
772 EXPORT_SYMBOL(ds_start_pulse);
773 EXPORT_SYMBOL(ds_set_speed);
774 EXPORT_SYMBOL(ds_reset);
775 EXPORT_SYMBOL(ds_detect);
776 EXPORT_SYMBOL(ds_stop_pulse);
777 EXPORT_SYMBOL(ds_send_data);
778 EXPORT_SYMBOL(ds_recv_data);
779 EXPORT_SYMBOL(ds_recv_status);
780 EXPORT_SYMBOL(ds_search);
781 EXPORT_SYMBOL(ds_get_device);
782 EXPORT_SYMBOL(ds_put_device);