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 = {
58 .disconnect = ds_disconnect,
59 .id_table = ds_id_table,
62 static struct ds_device *ds_dev;
64 struct ds_device * ds_get_device(void)
67 atomic_inc(&ds_dev->refcnt);
71 void ds_put_device(struct ds_device *dev)
73 atomic_dec(&dev->refcnt);
76 static int ds_send_control_cmd(struct ds_device *dev, u16 value, u16 index)
80 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
81 CONTROL_CMD, 0x40, value, index, NULL, 0, 1000);
83 printk(KERN_ERR "Failed to send command control message %x.%x: err=%d.\n",
91 static int ds_send_control_mode(struct ds_device *dev, u16 value, u16 index)
95 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
96 MODE_CMD, 0x40, value, index, NULL, 0, 1000);
98 printk(KERN_ERR "Failed to send mode control message %x.%x: err=%d.\n",
106 static int ds_send_control(struct ds_device *dev, u16 value, u16 index)
110 err = usb_control_msg(dev->udev, usb_sndctrlpipe(dev->udev, dev->ep[EP_CONTROL]),
111 COMM_CMD, 0x40, value, index, NULL, 0, 1000);
113 printk(KERN_ERR "Failed to send control message %x.%x: err=%d.\n",
121 static inline void ds_dump_status(unsigned char *buf, unsigned char *str, int off)
123 printk("%45s: %8x\n", str, buf[off]);
126 static int ds_recv_status_nodump(struct ds_device *dev, struct ds_status *st,
127 unsigned char *buf, int size)
131 memset(st, 0, sizeof(st));
134 err = usb_bulk_msg(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_STATUS]), buf, size, &count, 100);
136 printk(KERN_ERR "Failed to read 1-wire data from 0x%x: err=%d.\n", dev->ep[EP_STATUS], err);
140 if (count >= sizeof(*st))
141 memcpy(st, buf, sizeof(*st));
146 static int ds_recv_status(struct ds_device *dev, struct ds_status *st)
148 unsigned char buf[64];
149 int count, err = 0, i;
151 memcpy(st, buf, sizeof(*st));
153 count = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
157 printk("0x%x: count=%d, status: ", dev->ep[EP_STATUS], count);
158 for (i=0; i<count; ++i)
159 printk("%02x ", buf[i]);
163 ds_dump_status(buf, "enable flag", 0);
164 ds_dump_status(buf, "1-wire speed", 1);
165 ds_dump_status(buf, "strong pullup duration", 2);
166 ds_dump_status(buf, "programming pulse duration", 3);
167 ds_dump_status(buf, "pulldown slew rate control", 4);
168 ds_dump_status(buf, "write-1 low time", 5);
169 ds_dump_status(buf, "data sample offset/write-0 recovery time", 6);
170 ds_dump_status(buf, "reserved (test register)", 7);
171 ds_dump_status(buf, "device status flags", 8);
172 ds_dump_status(buf, "communication command byte 1", 9);
173 ds_dump_status(buf, "communication command byte 2", 10);
174 ds_dump_status(buf, "communication command buffer status", 11);
175 ds_dump_status(buf, "1-wire data output buffer status", 12);
176 ds_dump_status(buf, "1-wire data input buffer status", 13);
177 ds_dump_status(buf, "reserved", 14);
178 ds_dump_status(buf, "reserved", 15);
181 memcpy(st, buf, sizeof(*st));
183 if (st->status & ST_EPOF) {
184 printk(KERN_INFO "Resetting device after ST_EPOF.\n");
185 err = ds_send_control_cmd(dev, CTL_RESET_DEVICE, 0);
188 count = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
193 if (st->status & ST_IDLE) {
194 printk(KERN_INFO "Resetting pulse after ST_IDLE.\n");
195 err = ds_start_pulse(dev, PULLUP_PULSE_DURATION);
204 static int ds_recv_data(struct ds_device *dev, unsigned char *buf, int size)
210 err = usb_bulk_msg(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_DATA_IN]),
211 buf, size, &count, 1000);
213 printk(KERN_INFO "Clearing ep0x%x.\n", dev->ep[EP_DATA_IN]);
214 usb_clear_halt(dev->udev, usb_rcvbulkpipe(dev->udev, dev->ep[EP_DATA_IN]));
215 ds_recv_status(dev, &st);
223 printk("%s: count=%d: ", __func__, count);
224 for (i=0; i<count; ++i)
225 printk("%02x ", buf[i]);
232 static int ds_send_data(struct ds_device *dev, unsigned char *buf, int len)
237 err = usb_bulk_msg(dev->udev, usb_sndbulkpipe(dev->udev, dev->ep[EP_DATA_OUT]), buf, len, &count, 1000);
239 printk(KERN_ERR "Failed to read 1-wire data from 0x02: err=%d.\n", err);
248 int ds_stop_pulse(struct ds_device *dev, int limit)
251 int count = 0, err = 0;
255 err = ds_send_control(dev, CTL_HALT_EXE_IDLE, 0);
258 err = ds_send_control(dev, CTL_RESUME_EXE, 0);
261 err = ds_recv_status_nodump(dev, &st, buf, sizeof(buf));
265 if ((st.status & ST_SPUA) == 0) {
266 err = ds_send_control_mode(dev, MOD_PULSE_EN, 0);
270 } while(++count < limit);
275 int ds_detect(struct ds_device *dev, struct ds_status *st)
279 err = ds_send_control_cmd(dev, CTL_RESET_DEVICE, 0);
283 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM, 0);
287 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM | COMM_TYPE, 0x40);
291 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_PROG);
295 err = ds_recv_status(dev, st);
302 static int ds_wait_status(struct ds_device *dev, struct ds_status *st)
308 err = ds_recv_status_nodump(dev, st, buf, sizeof(buf));
312 printk("0x%x: count=%d, status: ", dev->ep[EP_STATUS], err);
313 for (i=0; i<err; ++i)
314 printk("%02x ", buf[i]);
318 } while(!(buf[0x08] & 0x20) && !(err < 0) && ++count < 100);
321 if (((err > 16) && (buf[0x10] & 0x01)) || count >= 100 || err < 0) {
322 ds_recv_status(dev, st);
328 int ds_reset(struct ds_device *dev, struct ds_status *st)
332 //err = ds_send_control(dev, COMM_1_WIRE_RESET | COMM_F | COMM_IM | COMM_SE, SPEED_FLEXIBLE);
333 err = ds_send_control(dev, 0x43, SPEED_NORMAL);
337 ds_wait_status(dev, st);
339 if (st->command_buffer_status) {
340 printk(KERN_INFO "Short circuit.\n");
349 int ds_set_speed(struct ds_device *dev, int speed)
353 if (speed != SPEED_NORMAL && speed != SPEED_FLEXIBLE && speed != SPEED_OVERDRIVE)
356 if (speed != SPEED_OVERDRIVE)
357 speed = SPEED_FLEXIBLE;
361 err = ds_send_control_mode(dev, MOD_1WIRE_SPEED, speed);
369 static int ds_start_pulse(struct ds_device *dev, int delay)
372 u8 del = 1 + (u8)(delay >> 4);
376 err = ds_stop_pulse(dev, 10);
380 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_SPUE);
384 err = ds_send_control(dev, COMM_SET_DURATION | COMM_IM, del);
388 err = ds_send_control(dev, COMM_PULSE | COMM_IM | COMM_F, 0);
394 ds_wait_status(dev, &st);
399 int ds_touch_bit(struct ds_device *dev, u8 bit, u8 *tbit)
403 u16 value = (COMM_BIT_IO | COMM_IM) | ((bit) ? COMM_D : 0);
406 err = ds_send_control(dev, value, 0);
412 err = ds_wait_status(dev, &st);
416 cmd = st.command0 | (st.command1 << 8);
417 } while (cmd != value && ++count < 10);
419 if (err < 0 || count >= 10) {
420 printk(KERN_ERR "Failed to obtain status.\n");
424 err = ds_recv_data(dev, tbit, sizeof(*tbit));
431 int ds_write_bit(struct ds_device *dev, u8 bit)
436 err = ds_send_control(dev, COMM_BIT_IO | COMM_IM | (bit) ? COMM_D : 0, 0);
440 ds_wait_status(dev, &st);
445 int ds_write_byte(struct ds_device *dev, u8 byte)
451 err = ds_send_control(dev, COMM_BYTE_IO | COMM_IM | COMM_SPU, byte);
455 err = ds_wait_status(dev, &st);
459 err = ds_recv_data(dev, &rbyte, sizeof(rbyte));
463 ds_start_pulse(dev, PULLUP_PULSE_DURATION);
465 return !(byte == rbyte);
468 int ds_read_bit(struct ds_device *dev, u8 *bit)
472 err = ds_send_control_mode(dev, MOD_PULSE_EN, PULSE_SPUE);
476 err = ds_send_control(dev, COMM_BIT_IO | COMM_IM | COMM_SPU | COMM_D, 0);
480 err = ds_recv_data(dev, bit, sizeof(*bit));
487 int ds_read_byte(struct ds_device *dev, u8 *byte)
492 err = ds_send_control(dev, COMM_BYTE_IO | COMM_IM , 0xff);
496 ds_wait_status(dev, &st);
498 err = ds_recv_data(dev, byte, sizeof(*byte));
505 int ds_read_block(struct ds_device *dev, u8 *buf, int len)
513 memset(buf, 0xFF, len);
515 err = ds_send_data(dev, buf, len);
519 err = ds_send_control(dev, COMM_BLOCK_IO | COMM_IM | COMM_SPU, len);
523 ds_wait_status(dev, &st);
525 memset(buf, 0x00, len);
526 err = ds_recv_data(dev, buf, len);
531 int ds_write_block(struct ds_device *dev, u8 *buf, int len)
536 err = ds_send_data(dev, buf, len);
540 ds_wait_status(dev, &st);
542 err = ds_send_control(dev, COMM_BLOCK_IO | COMM_IM | COMM_SPU, len);
546 ds_wait_status(dev, &st);
548 err = ds_recv_data(dev, buf, len);
552 ds_start_pulse(dev, PULLUP_PULSE_DURATION);
554 return !(err == len);
559 int ds_search(struct ds_device *dev, u64 init, u64 *buf, u8 id_number, int conditional_search)
565 memset(buf, 0, sizeof(buf));
567 err = ds_send_data(ds_dev, (unsigned char *)&init, 8);
571 ds_wait_status(ds_dev, &st);
573 value = COMM_SEARCH_ACCESS | COMM_IM | COMM_SM | COMM_F | COMM_RTS;
574 index = (conditional_search ? 0xEC : 0xF0) | (id_number << 8);
575 err = ds_send_control(ds_dev, value, index);
579 ds_wait_status(ds_dev, &st);
581 err = ds_recv_data(ds_dev, (unsigned char *)buf, 8*id_number);
588 int ds_match_access(struct ds_device *dev, u64 init)
593 err = ds_send_data(dev, (unsigned char *)&init, sizeof(init));
597 ds_wait_status(dev, &st);
599 err = ds_send_control(dev, COMM_MATCH_ACCESS | COMM_IM | COMM_RST, 0x0055);
603 ds_wait_status(dev, &st);
608 int ds_set_path(struct ds_device *dev, u64 init)
614 memcpy(buf, &init, 8);
615 buf[8] = BRANCH_MAIN;
617 err = ds_send_data(dev, buf, sizeof(buf));
621 ds_wait_status(dev, &st);
623 err = ds_send_control(dev, COMM_SET_PATH | COMM_IM | COMM_RST, 0);
627 ds_wait_status(dev, &st);
634 static int ds_probe(struct usb_interface *intf,
635 const struct usb_device_id *udev_id)
637 struct usb_device *udev = interface_to_usbdev(intf);
638 struct usb_endpoint_descriptor *endpoint;
639 struct usb_host_interface *iface_desc;
642 ds_dev = kmalloc(sizeof(struct ds_device), GFP_KERNEL);
644 printk(KERN_INFO "Failed to allocate new DS9490R structure.\n");
648 ds_dev->udev = usb_get_dev(udev);
649 usb_set_intfdata(intf, ds_dev);
651 err = usb_set_interface(ds_dev->udev, intf->altsetting[0].desc.bInterfaceNumber, 3);
653 printk(KERN_ERR "Failed to set alternative setting 3 for %d interface: err=%d.\n",
654 intf->altsetting[0].desc.bInterfaceNumber, err);
658 err = usb_reset_configuration(ds_dev->udev);
660 printk(KERN_ERR "Failed to reset configuration: err=%d.\n", err);
664 iface_desc = &intf->altsetting[0];
665 if (iface_desc->desc.bNumEndpoints != NUM_EP-1) {
666 printk(KERN_INFO "Num endpoints=%d. It is not DS9490R.\n", iface_desc->desc.bNumEndpoints);
670 atomic_set(&ds_dev->refcnt, 0);
671 memset(ds_dev->ep, 0, sizeof(ds_dev->ep));
674 * This loop doesn'd show control 0 endpoint,
675 * so we will fill only 1-3 endpoints entry.
677 for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
678 endpoint = &iface_desc->endpoint[i].desc;
680 ds_dev->ep[i+1] = endpoint->bEndpointAddress;
682 printk("%d: addr=%x, size=%d, dir=%s, type=%x\n",
683 i, endpoint->bEndpointAddress, le16_to_cpu(endpoint->wMaxPacketSize),
684 (endpoint->bEndpointAddress & USB_DIR_IN)?"IN":"OUT",
685 endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
692 u64 init=0xb30000002078ee81ull;
695 ds_reset(ds_dev, &st);
696 err = ds_search(ds_dev, init, buf, 3, 0);
699 for (i=0; i<err; ++i)
700 printk("%d: %llx\n", i, buf[i]);
702 printk("Resetting...\n");
703 ds_reset(ds_dev, &st);
704 printk("Setting path for %llx.\n", init);
705 err = ds_set_path(ds_dev, init);
708 printk("Calling MATCH_ACCESS.\n");
709 err = ds_match_access(ds_dev, init);
713 printk("Searching the bus...\n");
714 err = ds_search(ds_dev, init, buf, 3, 0);
716 printk("ds_search() returned %d\n", err);
720 for (i=0; i<err; ++i)
721 printk("%d: %llx\n", i, buf[i]);
730 static void ds_disconnect(struct usb_interface *intf)
732 struct ds_device *dev;
734 dev = usb_get_intfdata(intf);
735 usb_set_intfdata(intf, NULL);
737 while (atomic_read(&dev->refcnt)) {
738 printk(KERN_INFO "Waiting for DS to become free: refcnt=%d.\n",
739 atomic_read(&dev->refcnt));
741 if (msleep_interruptible(1000))
742 flush_signals(current);
745 usb_put_dev(dev->udev);
750 static int ds_init(void)
754 err = usb_register(&ds_driver);
756 printk(KERN_INFO "Failed to register DS9490R USB device: err=%d.\n", err);
763 static void ds_fini(void)
765 usb_deregister(&ds_driver);
768 module_init(ds_init);
769 module_exit(ds_fini);
771 MODULE_LICENSE("GPL");
772 MODULE_AUTHOR("Evgeniy Polyakov <johnpol@2ka.mipt.ru>");
774 EXPORT_SYMBOL(ds_touch_bit);
775 EXPORT_SYMBOL(ds_read_byte);
776 EXPORT_SYMBOL(ds_read_bit);
777 EXPORT_SYMBOL(ds_read_block);
778 EXPORT_SYMBOL(ds_write_byte);
779 EXPORT_SYMBOL(ds_write_bit);
780 EXPORT_SYMBOL(ds_write_block);
781 EXPORT_SYMBOL(ds_reset);
782 EXPORT_SYMBOL(ds_get_device);
783 EXPORT_SYMBOL(ds_put_device);
786 * This functions can be used for EEPROM programming,
787 * when driver will be included into mainline this will
788 * require uncommenting.
791 EXPORT_SYMBOL(ds_start_pulse);
792 EXPORT_SYMBOL(ds_set_speed);
793 EXPORT_SYMBOL(ds_detect);
794 EXPORT_SYMBOL(ds_stop_pulse);
795 EXPORT_SYMBOL(ds_search);