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>
26 #include <linux/slab.h>
28 #include "../w1_int.h"
31 /* COMMAND TYPE CODES */
32 #define CONTROL_CMD 0x00
36 /* CONTROL COMMAND CODES */
37 #define CTL_RESET_DEVICE 0x0000
38 #define CTL_START_EXE 0x0001
39 #define CTL_RESUME_EXE 0x0002
40 #define CTL_HALT_EXE_IDLE 0x0003
41 #define CTL_HALT_EXE_DONE 0x0004
42 #define CTL_FLUSH_COMM_CMDS 0x0007
43 #define CTL_FLUSH_RCV_BUFFER 0x0008
44 #define CTL_FLUSH_XMT_BUFFER 0x0009
45 #define CTL_GET_COMM_CMDS 0x000A
47 /* MODE COMMAND CODES */
48 #define MOD_PULSE_EN 0x0000
49 #define MOD_SPEED_CHANGE_EN 0x0001
50 #define MOD_1WIRE_SPEED 0x0002
51 #define MOD_STRONG_PU_DURATION 0x0003
52 #define MOD_PULLDOWN_SLEWRATE 0x0004
53 #define MOD_PROG_PULSE_DURATION 0x0005
54 #define MOD_WRITE1_LOWTIME 0x0006
55 #define MOD_DSOW0_TREC 0x0007
57 /* COMMUNICATION COMMAND CODES */
58 #define COMM_ERROR_ESCAPE 0x0601
59 #define COMM_SET_DURATION 0x0012
60 #define COMM_BIT_IO 0x0020
61 #define COMM_PULSE 0x0030
62 #define COMM_1_WIRE_RESET 0x0042
63 #define COMM_BYTE_IO 0x0052
64 #define COMM_MATCH_ACCESS 0x0064
65 #define COMM_BLOCK_IO 0x0074
66 #define COMM_READ_STRAIGHT 0x0080
67 #define COMM_DO_RELEASE 0x6092
68 #define COMM_SET_PATH 0x00A2
69 #define COMM_WRITE_SRAM_PAGE 0x00B2
70 #define COMM_WRITE_EPROM 0x00C4
71 #define COMM_READ_CRC_PROT_PAGE 0x00D4
72 #define COMM_READ_REDIRECT_PAGE_CRC 0x21E4
73 #define COMM_SEARCH_ACCESS 0x00F4
75 /* Communication command bits */
76 #define COMM_TYPE 0x0008
77 #define COMM_SE 0x0008
80 #define COMM_CH 0x0008
81 #define COMM_SM 0x0008
83 #define COMM_IM 0x0001
85 #define COMM_PS 0x4000
86 #define COMM_PST 0x4000
87 #define COMM_CIB 0x4000
88 #define COMM_RTS 0x4000
89 #define COMM_DT 0x2000
90 #define COMM_SPU 0x1000
92 #define COMM_NTF 0x0400
93 #define COMM_ICP 0x0200
94 #define COMM_RST 0x0100
96 #define PULSE_PROG 0x01
97 #define PULSE_SPUE 0x02
99 #define BRANCH_MAIN 0xCC
100 #define BRANCH_AUX 0x33
103 #define ST_SPUA 0x01 /* Strong Pull-up is active */
104 #define ST_PRGA 0x02 /* 12V programming pulse is being generated */
105 #define ST_12VP 0x04 /* external 12V programming voltage is present */
106 #define ST_PMOD 0x08 /* DS2490 powered from USB and external sources */
107 #define ST_HALT 0x10 /* DS2490 is currently halted */
108 #define ST_IDLE 0x20 /* DS2490 is currently idle */
111 /* Result Register flags */
112 #define RR_DETECT 0xA5 /* New device detected */
113 #define RR_NRS 0x01 /* Reset no presence or ... */
114 #define RR_SH 0x02 /* short on reset or set path */
115 #define RR_APP 0x04 /* alarming presence on reset */
116 #define RR_VPP 0x08 /* 12V expected not seen */
117 #define RR_CMP 0x10 /* compare error */
118 #define RR_CRC 0x20 /* CRC error detected */
119 #define RR_RDP 0x40 /* redirected page */
120 #define RR_EOS 0x80 /* end of search error */
122 #define SPEED_NORMAL 0x00
123 #define SPEED_FLEXIBLE 0x01
124 #define SPEED_OVERDRIVE 0x02
129 #define EP_DATA_OUT 2
134 struct list_head ds_entry
;
136 struct usb_device
*udev
;
137 struct usb_interface
*intf
;
142 * 0: pullup not active, else duration in milliseconds
145 /* spu_bit contains COMM_SPU or 0 depending on if the strong pullup
146 * should be active or not for writes.
150 struct w1_bus_master master
;
166 u8 command_buffer_status
;
167 u8 data_out_buffer_status
;
168 u8 data_in_buffer_status
;
174 static struct usb_device_id ds_id_table
[] = {
175 { USB_DEVICE(0x04fa, 0x2490) },
178 MODULE_DEVICE_TABLE(usb
, ds_id_table
);
180 static int ds_probe(struct usb_interface
*, const struct usb_device_id
*);
181 static void ds_disconnect(struct usb_interface
*);
183 static int ds_send_control(struct ds_device
*, u16
, u16
);
184 static int ds_send_control_cmd(struct ds_device
*, u16
, u16
);
186 static LIST_HEAD(ds_devices
);
187 static DEFINE_MUTEX(ds_mutex
);
189 static struct usb_driver ds_driver
= {
192 .disconnect
= ds_disconnect
,
193 .id_table
= ds_id_table
,
196 static int ds_send_control_cmd(struct ds_device
*dev
, u16 value
, u16 index
)
200 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, dev
->ep
[EP_CONTROL
]),
201 CONTROL_CMD
, 0x40, value
, index
, NULL
, 0, 1000);
203 printk(KERN_ERR
"Failed to send command control message %x.%x: err=%d.\n",
211 static int ds_send_control_mode(struct ds_device
*dev
, u16 value
, u16 index
)
215 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, dev
->ep
[EP_CONTROL
]),
216 MODE_CMD
, 0x40, value
, index
, NULL
, 0, 1000);
218 printk(KERN_ERR
"Failed to send mode control message %x.%x: err=%d.\n",
226 static int ds_send_control(struct ds_device
*dev
, u16 value
, u16 index
)
230 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, dev
->ep
[EP_CONTROL
]),
231 COMM_CMD
, 0x40, value
, index
, NULL
, 0, 1000);
233 printk(KERN_ERR
"Failed to send control message %x.%x: err=%d.\n",
241 static int ds_recv_status_nodump(struct ds_device
*dev
, struct ds_status
*st
,
242 unsigned char *buf
, int size
)
246 memset(st
, 0, sizeof(*st
));
249 err
= usb_bulk_msg(dev
->udev
, usb_rcvbulkpipe(dev
->udev
, dev
->ep
[EP_STATUS
]), buf
, size
, &count
, 100);
251 printk(KERN_ERR
"Failed to read 1-wire data from 0x%x: err=%d.\n", dev
->ep
[EP_STATUS
], err
);
255 if (count
>= sizeof(*st
))
256 memcpy(st
, buf
, sizeof(*st
));
261 static inline void ds_print_msg(unsigned char *buf
, unsigned char *str
, int off
)
263 printk(KERN_INFO
"%45s: %8x\n", str
, buf
[off
]);
266 static void ds_dump_status(struct ds_device
*dev
, unsigned char *buf
, int count
)
270 printk(KERN_INFO
"0x%x: count=%d, status: ", dev
->ep
[EP_STATUS
], count
);
271 for (i
=0; i
<count
; ++i
)
272 printk("%02x ", buf
[i
]);
273 printk(KERN_INFO
"\n");
276 ds_print_msg(buf
, "enable flag", 0);
277 ds_print_msg(buf
, "1-wire speed", 1);
278 ds_print_msg(buf
, "strong pullup duration", 2);
279 ds_print_msg(buf
, "programming pulse duration", 3);
280 ds_print_msg(buf
, "pulldown slew rate control", 4);
281 ds_print_msg(buf
, "write-1 low time", 5);
282 ds_print_msg(buf
, "data sample offset/write-0 recovery time",
284 ds_print_msg(buf
, "reserved (test register)", 7);
285 ds_print_msg(buf
, "device status flags", 8);
286 ds_print_msg(buf
, "communication command byte 1", 9);
287 ds_print_msg(buf
, "communication command byte 2", 10);
288 ds_print_msg(buf
, "communication command buffer status", 11);
289 ds_print_msg(buf
, "1-wire data output buffer status", 12);
290 ds_print_msg(buf
, "1-wire data input buffer status", 13);
291 ds_print_msg(buf
, "reserved", 14);
292 ds_print_msg(buf
, "reserved", 15);
294 for (i
= 16; i
< count
; ++i
) {
295 if (buf
[i
] == RR_DETECT
) {
296 ds_print_msg(buf
, "new device detect", i
);
299 ds_print_msg(buf
, "Result Register Value: ", i
);
301 printk(KERN_INFO
"NRS: Reset no presence or ...\n");
303 printk(KERN_INFO
"SH: short on reset or set path\n");
305 printk(KERN_INFO
"APP: alarming presence on reset\n");
307 printk(KERN_INFO
"VPP: 12V expected not seen\n");
309 printk(KERN_INFO
"CMP: compare error\n");
311 printk(KERN_INFO
"CRC: CRC error detected\n");
313 printk(KERN_INFO
"RDP: redirected page\n");
315 printk(KERN_INFO
"EOS: end of search error\n");
319 static void ds_reset_device(struct ds_device
*dev
)
321 ds_send_control_cmd(dev
, CTL_RESET_DEVICE
, 0);
322 /* Always allow strong pullup which allow individual writes to use
325 if (ds_send_control_mode(dev
, MOD_PULSE_EN
, PULSE_SPUE
))
326 printk(KERN_ERR
"ds_reset_device: "
327 "Error allowing strong pullup\n");
328 /* Chip strong pullup time was cleared. */
329 if (dev
->spu_sleep
) {
330 /* lower 4 bits are 0, see ds_set_pullup */
331 u8 del
= dev
->spu_sleep
>>4;
332 if (ds_send_control(dev
, COMM_SET_DURATION
| COMM_IM
, del
))
333 printk(KERN_ERR
"ds_reset_device: "
334 "Error setting duration\n");
338 static int ds_recv_data(struct ds_device
*dev
, unsigned char *buf
, int size
)
343 /* Careful on size. If size is less than what is available in
344 * the input buffer, the device fails the bulk transfer and
345 * clears the input buffer. It could read the maximum size of
346 * the data buffer, but then do you return the first, last, or
347 * some set of the middle size bytes? As long as the rest of
348 * the code is correct there will be size bytes waiting. A
349 * call to ds_wait_status will wait until the device is idle
350 * and any data to be received would have been available.
353 err
= usb_bulk_msg(dev
->udev
, usb_rcvbulkpipe(dev
->udev
, dev
->ep
[EP_DATA_IN
]),
354 buf
, size
, &count
, 1000);
359 printk(KERN_INFO
"Clearing ep0x%x.\n", dev
->ep
[EP_DATA_IN
]);
360 usb_clear_halt(dev
->udev
, usb_rcvbulkpipe(dev
->udev
, dev
->ep
[EP_DATA_IN
]));
362 count
= ds_recv_status_nodump(dev
, &st
, buf
, sizeof(buf
));
363 ds_dump_status(dev
, buf
, count
);
370 static int ds_send_data(struct ds_device
*dev
, unsigned char *buf
, int len
)
375 err
= usb_bulk_msg(dev
->udev
, usb_sndbulkpipe(dev
->udev
, dev
->ep
[EP_DATA_OUT
]), buf
, len
, &count
, 1000);
377 printk(KERN_ERR
"Failed to write 1-wire data to ep0x%x: "
378 "err=%d.\n", dev
->ep
[EP_DATA_OUT
], err
);
386 static int ds_wait_status(struct ds_device
*dev
, struct ds_status
*st
)
392 err
= ds_recv_status_nodump(dev
, st
, buf
, sizeof(buf
));
393 } while (!(buf
[0x08] & ST_IDLE
) && !(err
< 0) && ++count
< 100);
395 if (err
>= 16 && st
->status
& ST_EPOF
) {
396 printk(KERN_INFO
"Resetting device after ST_EPOF.\n");
397 ds_reset_device(dev
);
398 /* Always dump the device status. */
402 /* Dump the status for errors or if there is extended return data.
403 * The extended status includes new device detection (maybe someone
404 * can do something with it).
406 if (err
> 16 || count
>= 100 || err
< 0)
407 ds_dump_status(dev
, buf
, err
);
409 /* Extended data isn't an error. Well, a short is, but the dump
410 * would have already told the user that and we can't do anything
411 * about it in software anyway.
413 if (count
>= 100 || err
< 0)
419 static int ds_reset(struct ds_device
*dev
)
423 /* Other potentionally interesting flags for reset.
425 * COMM_NTF: Return result register feedback. This could be used to
426 * detect some conditions such as short, alarming presence, or
427 * detect if a new device was detected.
429 * COMM_SE which allows SPEED_NORMAL, SPEED_FLEXIBLE, SPEED_OVERDRIVE:
430 * Select the data transfer rate.
432 err
= ds_send_control(dev
, COMM_1_WIRE_RESET
| COMM_IM
, SPEED_NORMAL
);
440 static int ds_set_pullup(struct ds_device
*dev
, int delay
)
443 u8 del
= 1 + (u8
)(delay
>> 4);
444 /* Just storing delay would not get the trunication and roundup. */
447 /* Enable spu_bit if a delay is set. */
448 dev
->spu_bit
= delay
? COMM_SPU
: 0;
449 /* If delay is zero, it has already been disabled, if the time is
450 * the same as the hardware was last programmed to, there is also
451 * nothing more to do. Compare with the recalculated value ms
452 * rather than del or delay which can have a different value.
454 if (delay
== 0 || ms
== dev
->spu_sleep
)
457 err
= ds_send_control(dev
, COMM_SET_DURATION
| COMM_IM
, del
);
466 static int ds_touch_bit(struct ds_device
*dev
, u8 bit
, u8
*tbit
)
471 err
= ds_send_control(dev
, COMM_BIT_IO
| COMM_IM
| (bit
? COMM_D
: 0),
476 ds_wait_status(dev
, &st
);
478 err
= ds_recv_data(dev
, tbit
, sizeof(*tbit
));
486 static int ds_write_byte(struct ds_device
*dev
, u8 byte
)
492 err
= ds_send_control(dev
, COMM_BYTE_IO
| COMM_IM
| dev
->spu_bit
, byte
);
497 msleep(dev
->spu_sleep
);
499 err
= ds_wait_status(dev
, &st
);
503 err
= ds_recv_data(dev
, &rbyte
, sizeof(rbyte
));
507 return !(byte
== rbyte
);
510 static int ds_read_byte(struct ds_device
*dev
, u8
*byte
)
515 err
= ds_send_control(dev
, COMM_BYTE_IO
| COMM_IM
, 0xff);
519 ds_wait_status(dev
, &st
);
521 err
= ds_recv_data(dev
, byte
, sizeof(*byte
));
528 static int ds_read_block(struct ds_device
*dev
, u8
*buf
, int len
)
536 memset(buf
, 0xFF, len
);
538 err
= ds_send_data(dev
, buf
, len
);
542 err
= ds_send_control(dev
, COMM_BLOCK_IO
| COMM_IM
, len
);
546 ds_wait_status(dev
, &st
);
548 memset(buf
, 0x00, len
);
549 err
= ds_recv_data(dev
, buf
, len
);
554 static int ds_write_block(struct ds_device
*dev
, u8
*buf
, int len
)
559 err
= ds_send_data(dev
, buf
, len
);
563 err
= ds_send_control(dev
, COMM_BLOCK_IO
| COMM_IM
| dev
->spu_bit
, len
);
568 msleep(dev
->spu_sleep
);
570 ds_wait_status(dev
, &st
);
572 err
= ds_recv_data(dev
, buf
, len
);
576 return !(err
== len
);
580 static u8
ds9490r_touch_bit(void *data
, u8 bit
)
583 struct ds_device
*dev
= data
;
585 if (ds_touch_bit(dev
, bit
, &ret
))
592 static void ds9490r_write_byte(void *data
, u8 byte
)
594 struct ds_device
*dev
= data
;
596 ds_write_byte(dev
, byte
);
599 static u8
ds9490r_read_byte(void *data
)
601 struct ds_device
*dev
= data
;
605 err
= ds_read_byte(dev
, &byte
);
612 static void ds9490r_write_block(void *data
, const u8
*buf
, int len
)
614 struct ds_device
*dev
= data
;
616 ds_write_block(dev
, (u8
*)buf
, len
);
619 static u8
ds9490r_read_block(void *data
, u8
*buf
, int len
)
621 struct ds_device
*dev
= data
;
624 err
= ds_read_block(dev
, buf
, len
);
631 static u8
ds9490r_reset(void *data
)
633 struct ds_device
*dev
= data
;
643 static u8
ds9490r_set_pullup(void *data
, int delay
)
645 struct ds_device
*dev
= data
;
647 if (ds_set_pullup(dev
, delay
))
653 static int ds_w1_init(struct ds_device
*dev
)
655 memset(&dev
->master
, 0, sizeof(struct w1_bus_master
));
657 /* Reset the device as it can be in a bad state.
658 * This is necessary because a block write will wait for data
659 * to be placed in the output buffer and block any later
660 * commands which will keep accumulating and the device will
661 * not be idle. Another case is removing the ds2490 module
662 * while a bus search is in progress, somehow a few commands
663 * get through, but the input transfers fail leaving data in
664 * the input buffer. This will cause the next read to fail
665 * see the note in ds_recv_data.
667 ds_reset_device(dev
);
669 dev
->master
.data
= dev
;
670 dev
->master
.touch_bit
= &ds9490r_touch_bit
;
671 /* read_bit and write_bit in w1_bus_master are expected to set and
672 * sample the line level. For write_bit that means it is expected to
673 * set it to that value and leave it there. ds2490 only supports an
674 * individual time slot at the lowest level. The requirement from
675 * pulling the bus state down to reading the state is 15us, something
676 * that isn't realistic on the USB bus anyway.
677 dev->master.read_bit = &ds9490r_read_bit;
678 dev->master.write_bit = &ds9490r_write_bit;
680 dev
->master
.read_byte
= &ds9490r_read_byte
;
681 dev
->master
.write_byte
= &ds9490r_write_byte
;
682 dev
->master
.read_block
= &ds9490r_read_block
;
683 dev
->master
.write_block
= &ds9490r_write_block
;
684 dev
->master
.reset_bus
= &ds9490r_reset
;
685 dev
->master
.set_pullup
= &ds9490r_set_pullup
;
687 return w1_add_master_device(&dev
->master
);
690 static void ds_w1_fini(struct ds_device
*dev
)
692 w1_remove_master_device(&dev
->master
);
695 static int ds_probe(struct usb_interface
*intf
,
696 const struct usb_device_id
*udev_id
)
698 struct usb_device
*udev
= interface_to_usbdev(intf
);
699 struct usb_endpoint_descriptor
*endpoint
;
700 struct usb_host_interface
*iface_desc
;
701 struct ds_device
*dev
;
704 dev
= kmalloc(sizeof(struct ds_device
), GFP_KERNEL
);
706 printk(KERN_INFO
"Failed to allocate new DS9490R structure.\n");
711 dev
->udev
= usb_get_dev(udev
);
716 memset(dev
->ep
, 0, sizeof(dev
->ep
));
718 usb_set_intfdata(intf
, dev
);
720 err
= usb_set_interface(dev
->udev
, intf
->altsetting
[0].desc
.bInterfaceNumber
, 3);
722 printk(KERN_ERR
"Failed to set alternative setting 3 for %d interface: err=%d.\n",
723 intf
->altsetting
[0].desc
.bInterfaceNumber
, err
);
727 err
= usb_reset_configuration(dev
->udev
);
729 printk(KERN_ERR
"Failed to reset configuration: err=%d.\n", err
);
733 iface_desc
= &intf
->altsetting
[0];
734 if (iface_desc
->desc
.bNumEndpoints
!= NUM_EP
-1) {
735 printk(KERN_INFO
"Num endpoints=%d. It is not DS9490R.\n", iface_desc
->desc
.bNumEndpoints
);
741 * This loop doesn'd show control 0 endpoint,
742 * so we will fill only 1-3 endpoints entry.
744 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
745 endpoint
= &iface_desc
->endpoint
[i
].desc
;
747 dev
->ep
[i
+1] = endpoint
->bEndpointAddress
;
750 err
= ds_w1_init(dev
);
754 mutex_lock(&ds_mutex
);
755 list_add_tail(&dev
->ds_entry
, &ds_devices
);
756 mutex_unlock(&ds_mutex
);
761 usb_set_intfdata(intf
, NULL
);
762 usb_put_dev(dev
->udev
);
768 static void ds_disconnect(struct usb_interface
*intf
)
770 struct ds_device
*dev
;
772 dev
= usb_get_intfdata(intf
);
776 mutex_lock(&ds_mutex
);
777 list_del(&dev
->ds_entry
);
778 mutex_unlock(&ds_mutex
);
782 usb_set_intfdata(intf
, NULL
);
784 usb_put_dev(dev
->udev
);
788 static int ds_init(void)
792 err
= usb_register(&ds_driver
);
794 printk(KERN_INFO
"Failed to register DS9490R USB device: err=%d.\n", err
);
801 static void ds_fini(void)
803 usb_deregister(&ds_driver
);
806 module_init(ds_init
);
807 module_exit(ds_fini
);
809 MODULE_LICENSE("GPL");
810 MODULE_AUTHOR("Evgeniy Polyakov <johnpol@2ka.mipt.ru>");
811 MODULE_DESCRIPTION("DS2490 USB <-> W1 bus master driver (DS9490*)");