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>
27 #include "../w1_int.h"
30 /* COMMAND TYPE CODES */
31 #define CONTROL_CMD 0x00
35 /* CONTROL COMMAND CODES */
36 #define CTL_RESET_DEVICE 0x0000
37 #define CTL_START_EXE 0x0001
38 #define CTL_RESUME_EXE 0x0002
39 #define CTL_HALT_EXE_IDLE 0x0003
40 #define CTL_HALT_EXE_DONE 0x0004
41 #define CTL_FLUSH_COMM_CMDS 0x0007
42 #define CTL_FLUSH_RCV_BUFFER 0x0008
43 #define CTL_FLUSH_XMT_BUFFER 0x0009
44 #define CTL_GET_COMM_CMDS 0x000A
46 /* MODE COMMAND CODES */
47 #define MOD_PULSE_EN 0x0000
48 #define MOD_SPEED_CHANGE_EN 0x0001
49 #define MOD_1WIRE_SPEED 0x0002
50 #define MOD_STRONG_PU_DURATION 0x0003
51 #define MOD_PULLDOWN_SLEWRATE 0x0004
52 #define MOD_PROG_PULSE_DURATION 0x0005
53 #define MOD_WRITE1_LOWTIME 0x0006
54 #define MOD_DSOW0_TREC 0x0007
56 /* COMMUNICATION COMMAND CODES */
57 #define COMM_ERROR_ESCAPE 0x0601
58 #define COMM_SET_DURATION 0x0012
59 #define COMM_BIT_IO 0x0020
60 #define COMM_PULSE 0x0030
61 #define COMM_1_WIRE_RESET 0x0042
62 #define COMM_BYTE_IO 0x0052
63 #define COMM_MATCH_ACCESS 0x0064
64 #define COMM_BLOCK_IO 0x0074
65 #define COMM_READ_STRAIGHT 0x0080
66 #define COMM_DO_RELEASE 0x6092
67 #define COMM_SET_PATH 0x00A2
68 #define COMM_WRITE_SRAM_PAGE 0x00B2
69 #define COMM_WRITE_EPROM 0x00C4
70 #define COMM_READ_CRC_PROT_PAGE 0x00D4
71 #define COMM_READ_REDIRECT_PAGE_CRC 0x21E4
72 #define COMM_SEARCH_ACCESS 0x00F4
74 /* Communication command bits */
75 #define COMM_TYPE 0x0008
76 #define COMM_SE 0x0008
79 #define COMM_CH 0x0008
80 #define COMM_SM 0x0008
82 #define COMM_IM 0x0001
84 #define COMM_PS 0x4000
85 #define COMM_PST 0x4000
86 #define COMM_CIB 0x4000
87 #define COMM_RTS 0x4000
88 #define COMM_DT 0x2000
89 #define COMM_SPU 0x1000
91 #define COMM_NTP 0x0400
92 #define COMM_ICP 0x0200
93 #define COMM_RST 0x0100
95 #define PULSE_PROG 0x01
96 #define PULSE_SPUE 0x02
98 #define BRANCH_MAIN 0xCC
99 #define BRANCH_AUX 0x33
102 #define ST_SPUA 0x01 /* Strong Pull-up is active */
103 #define ST_PRGA 0x02 /* 12V programming pulse is being generated */
104 #define ST_12VP 0x04 /* external 12V programming voltage is present */
105 #define ST_PMOD 0x08 /* DS2490 powered from USB and external sources */
106 #define ST_HALT 0x10 /* DS2490 is currently halted */
107 #define ST_IDLE 0x20 /* DS2490 is currently idle */
110 #define SPEED_NORMAL 0x00
111 #define SPEED_FLEXIBLE 0x01
112 #define SPEED_OVERDRIVE 0x02
117 #define EP_DATA_OUT 2
122 struct list_head ds_entry
;
124 struct usb_device
*udev
;
125 struct usb_interface
*intf
;
130 * 0: pullup not active, else duration in milliseconds
134 struct w1_bus_master master
;
150 u8 command_buffer_status
;
151 u8 data_out_buffer_status
;
152 u8 data_in_buffer_status
;
158 static struct usb_device_id ds_id_table
[] = {
159 { USB_DEVICE(0x04fa, 0x2490) },
162 MODULE_DEVICE_TABLE(usb
, ds_id_table
);
164 static int ds_probe(struct usb_interface
*, const struct usb_device_id
*);
165 static void ds_disconnect(struct usb_interface
*);
167 static inline void ds_dump_status(unsigned char *, unsigned char *, int);
168 static int ds_send_control(struct ds_device
*, u16
, u16
);
169 static int ds_send_control_cmd(struct ds_device
*, u16
, u16
);
171 static LIST_HEAD(ds_devices
);
172 static DEFINE_MUTEX(ds_mutex
);
174 static struct usb_driver ds_driver
= {
177 .disconnect
= ds_disconnect
,
178 .id_table
= ds_id_table
,
181 static int ds_send_control_cmd(struct ds_device
*dev
, u16 value
, u16 index
)
185 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, dev
->ep
[EP_CONTROL
]),
186 CONTROL_CMD
, 0x40, value
, index
, NULL
, 0, 1000);
188 printk(KERN_ERR
"Failed to send command control message %x.%x: err=%d.\n",
196 static int ds_send_control_mode(struct ds_device
*dev
, u16 value
, u16 index
)
200 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, dev
->ep
[EP_CONTROL
]),
201 MODE_CMD
, 0x40, value
, index
, NULL
, 0, 1000);
203 printk(KERN_ERR
"Failed to send mode control message %x.%x: err=%d.\n",
211 static int ds_send_control(struct ds_device
*dev
, u16 value
, u16 index
)
215 err
= usb_control_msg(dev
->udev
, usb_sndctrlpipe(dev
->udev
, dev
->ep
[EP_CONTROL
]),
216 COMM_CMD
, 0x40, value
, index
, NULL
, 0, 1000);
218 printk(KERN_ERR
"Failed to send control message %x.%x: err=%d.\n",
226 static inline void ds_dump_status(unsigned char *buf
, unsigned char *str
, int off
)
228 printk("%45s: %8x\n", str
, buf
[off
]);
231 static int ds_recv_status_nodump(struct ds_device
*dev
, struct ds_status
*st
,
232 unsigned char *buf
, int size
)
236 memset(st
, 0, sizeof(*st
));
239 err
= usb_bulk_msg(dev
->udev
, usb_rcvbulkpipe(dev
->udev
, dev
->ep
[EP_STATUS
]), buf
, size
, &count
, 100);
241 printk(KERN_ERR
"Failed to read 1-wire data from 0x%x: err=%d.\n", dev
->ep
[EP_STATUS
], err
);
245 if (count
>= sizeof(*st
))
246 memcpy(st
, buf
, sizeof(*st
));
251 static int ds_recv_status(struct ds_device
*dev
, struct ds_status
*st
)
253 unsigned char buf
[64];
254 int count
, err
= 0, i
;
256 memcpy(st
, buf
, sizeof(*st
));
258 count
= ds_recv_status_nodump(dev
, st
, buf
, sizeof(buf
));
262 printk("0x%x: count=%d, status: ", dev
->ep
[EP_STATUS
], count
);
263 for (i
=0; i
<count
; ++i
)
264 printk("%02x ", buf
[i
]);
268 ds_dump_status(buf
, "enable flag", 0);
269 ds_dump_status(buf
, "1-wire speed", 1);
270 ds_dump_status(buf
, "strong pullup duration", 2);
271 ds_dump_status(buf
, "programming pulse duration", 3);
272 ds_dump_status(buf
, "pulldown slew rate control", 4);
273 ds_dump_status(buf
, "write-1 low time", 5);
274 ds_dump_status(buf
, "data sample offset/write-0 recovery time", 6);
275 ds_dump_status(buf
, "reserved (test register)", 7);
276 ds_dump_status(buf
, "device status flags", 8);
277 ds_dump_status(buf
, "communication command byte 1", 9);
278 ds_dump_status(buf
, "communication command byte 2", 10);
279 ds_dump_status(buf
, "communication command buffer status", 11);
280 ds_dump_status(buf
, "1-wire data output buffer status", 12);
281 ds_dump_status(buf
, "1-wire data input buffer status", 13);
282 ds_dump_status(buf
, "reserved", 14);
283 ds_dump_status(buf
, "reserved", 15);
286 memcpy(st
, buf
, sizeof(*st
));
288 if (st
->status
& ST_EPOF
) {
289 printk(KERN_INFO
"Resetting device after ST_EPOF.\n");
290 err
= ds_send_control_cmd(dev
, CTL_RESET_DEVICE
, 0);
293 count
= ds_recv_status_nodump(dev
, st
, buf
, sizeof(buf
));
301 static int ds_recv_data(struct ds_device
*dev
, unsigned char *buf
, int size
)
307 err
= usb_bulk_msg(dev
->udev
, usb_rcvbulkpipe(dev
->udev
, dev
->ep
[EP_DATA_IN
]),
308 buf
, size
, &count
, 1000);
310 printk(KERN_INFO
"Clearing ep0x%x.\n", dev
->ep
[EP_DATA_IN
]);
311 usb_clear_halt(dev
->udev
, usb_rcvbulkpipe(dev
->udev
, dev
->ep
[EP_DATA_IN
]));
312 ds_recv_status(dev
, &st
);
320 printk("%s: count=%d: ", __func__
, count
);
321 for (i
=0; i
<count
; ++i
)
322 printk("%02x ", buf
[i
]);
329 static int ds_send_data(struct ds_device
*dev
, unsigned char *buf
, int len
)
334 err
= usb_bulk_msg(dev
->udev
, usb_sndbulkpipe(dev
->udev
, dev
->ep
[EP_DATA_OUT
]), buf
, len
, &count
, 1000);
336 printk(KERN_ERR
"Failed to write 1-wire data to ep0x%x: "
337 "err=%d.\n", dev
->ep
[EP_DATA_OUT
], err
);
346 int ds_stop_pulse(struct ds_device
*dev
, int limit
)
349 int count
= 0, err
= 0;
353 err
= ds_send_control(dev
, CTL_HALT_EXE_IDLE
, 0);
356 err
= ds_send_control(dev
, CTL_RESUME_EXE
, 0);
359 err
= ds_recv_status_nodump(dev
, &st
, buf
, sizeof(buf
));
363 if ((st
.status
& ST_SPUA
) == 0) {
364 err
= ds_send_control_mode(dev
, MOD_PULSE_EN
, 0);
368 } while(++count
< limit
);
373 int ds_detect(struct ds_device
*dev
, struct ds_status
*st
)
377 err
= ds_send_control_cmd(dev
, CTL_RESET_DEVICE
, 0);
381 err
= ds_send_control(dev
, COMM_SET_DURATION
| COMM_IM
, 0);
385 err
= ds_send_control(dev
, COMM_SET_DURATION
| COMM_IM
| COMM_TYPE
, 0x40);
389 err
= ds_send_control_mode(dev
, MOD_PULSE_EN
, PULSE_PROG
);
393 err
= ds_recv_status(dev
, st
);
400 static int ds_wait_status(struct ds_device
*dev
, struct ds_status
*st
)
406 err
= ds_recv_status_nodump(dev
, st
, buf
, sizeof(buf
));
410 printk("0x%x: count=%d, status: ", dev
->ep
[EP_STATUS
], err
);
411 for (i
=0; i
<err
; ++i
)
412 printk("%02x ", buf
[i
]);
416 } while(!(buf
[0x08] & 0x20) && !(err
< 0) && ++count
< 100);
419 if (((err
> 16) && (buf
[0x10] & 0x01)) || count
>= 100 || err
< 0) {
420 ds_recv_status(dev
, st
);
426 static int ds_reset(struct ds_device
*dev
, struct ds_status
*st
)
430 //err = ds_send_control(dev, COMM_1_WIRE_RESET | COMM_F | COMM_IM | COMM_SE, SPEED_FLEXIBLE);
431 err
= ds_send_control(dev
, 0x43, SPEED_NORMAL
);
435 ds_wait_status(dev
, st
);
437 if (st
->command_buffer_status
) {
438 printk(KERN_INFO
"Short circuit.\n");
447 static int ds_set_speed(struct ds_device
*dev
, int speed
)
451 if (speed
!= SPEED_NORMAL
&& speed
!= SPEED_FLEXIBLE
&& speed
!= SPEED_OVERDRIVE
)
454 if (speed
!= SPEED_OVERDRIVE
)
455 speed
= SPEED_FLEXIBLE
;
459 err
= ds_send_control_mode(dev
, MOD_1WIRE_SPEED
, speed
);
467 static int ds_set_pullup(struct ds_device
*dev
, int delay
)
470 u8 del
= 1 + (u8
)(delay
>> 4);
473 err
= ds_send_control_mode(dev
, MOD_PULSE_EN
, delay
? PULSE_SPUE
: 0);
478 err
= ds_send_control(dev
, COMM_SET_DURATION
| COMM_IM
, del
);
482 /* Just storing delay would not get the trunication and
485 dev
->spu_sleep
= del
<<4;
491 static int ds_touch_bit(struct ds_device
*dev
, u8 bit
, u8
*tbit
)
495 u16 value
= (COMM_BIT_IO
| COMM_IM
) | ((bit
) ? COMM_D
: 0);
498 err
= ds_send_control(dev
, value
, 0);
504 err
= ds_wait_status(dev
, &st
);
508 cmd
= st
.command0
| (st
.command1
<< 8);
509 } while (cmd
!= value
&& ++count
< 10);
511 if (err
< 0 || count
>= 10) {
512 printk(KERN_ERR
"Failed to obtain status.\n");
516 err
= ds_recv_data(dev
, tbit
, sizeof(*tbit
));
524 static int ds_write_bit(struct ds_device
*dev
, u8 bit
)
529 /* Set COMM_ICP to write without a readback. Note, this will
530 * produce one time slot, a down followed by an up with COMM_D
531 * only determing the timing.
533 err
= ds_send_control(dev
, COMM_BIT_IO
| COMM_IM
| COMM_ICP
|
534 (bit
? COMM_D
: 0), 0);
538 ds_wait_status(dev
, &st
);
544 static int ds_write_byte(struct ds_device
*dev
, u8 byte
)
550 err
= ds_send_control(dev
, COMM_BYTE_IO
| COMM_IM
| COMM_SPU
, byte
);
555 msleep(dev
->spu_sleep
);
557 err
= ds_wait_status(dev
, &st
);
561 err
= ds_recv_data(dev
, &rbyte
, sizeof(rbyte
));
565 return !(byte
== rbyte
);
568 static int ds_read_byte(struct ds_device
*dev
, u8
*byte
)
573 err
= ds_send_control(dev
, COMM_BYTE_IO
| COMM_IM
, 0xff);
577 ds_wait_status(dev
, &st
);
579 err
= ds_recv_data(dev
, byte
, sizeof(*byte
));
586 static int ds_read_block(struct ds_device
*dev
, u8
*buf
, int len
)
594 memset(buf
, 0xFF, len
);
596 err
= ds_send_data(dev
, buf
, len
);
600 err
= ds_send_control(dev
, COMM_BLOCK_IO
| COMM_IM
, len
);
604 ds_wait_status(dev
, &st
);
606 memset(buf
, 0x00, len
);
607 err
= ds_recv_data(dev
, buf
, len
);
612 static int ds_write_block(struct ds_device
*dev
, u8
*buf
, int len
)
617 err
= ds_send_data(dev
, buf
, len
);
621 ds_wait_status(dev
, &st
);
623 err
= ds_send_control(dev
, COMM_BLOCK_IO
| COMM_IM
| COMM_SPU
, len
);
628 msleep(dev
->spu_sleep
);
630 ds_wait_status(dev
, &st
);
632 err
= ds_recv_data(dev
, buf
, len
);
636 return !(err
== len
);
641 static int ds_search(struct ds_device
*dev
, u64 init
, u64
*buf
, u8 id_number
, int conditional_search
)
647 memset(buf
, 0, sizeof(buf
));
649 err
= ds_send_data(ds_dev
, (unsigned char *)&init
, 8);
653 ds_wait_status(ds_dev
, &st
);
655 value
= COMM_SEARCH_ACCESS
| COMM_IM
| COMM_SM
| COMM_F
| COMM_RTS
;
656 index
= (conditional_search
? 0xEC : 0xF0) | (id_number
<< 8);
657 err
= ds_send_control(ds_dev
, value
, index
);
661 ds_wait_status(ds_dev
, &st
);
663 err
= ds_recv_data(ds_dev
, (unsigned char *)buf
, 8*id_number
);
670 static int ds_match_access(struct ds_device
*dev
, u64 init
)
675 err
= ds_send_data(dev
, (unsigned char *)&init
, sizeof(init
));
679 ds_wait_status(dev
, &st
);
681 err
= ds_send_control(dev
, COMM_MATCH_ACCESS
| COMM_IM
| COMM_RST
, 0x0055);
685 ds_wait_status(dev
, &st
);
690 static int ds_set_path(struct ds_device
*dev
, u64 init
)
696 memcpy(buf
, &init
, 8);
697 buf
[8] = BRANCH_MAIN
;
699 err
= ds_send_data(dev
, buf
, sizeof(buf
));
703 ds_wait_status(dev
, &st
);
705 err
= ds_send_control(dev
, COMM_SET_PATH
| COMM_IM
| COMM_RST
, 0);
709 ds_wait_status(dev
, &st
);
716 static u8
ds9490r_touch_bit(void *data
, u8 bit
)
719 struct ds_device
*dev
= data
;
721 if (ds_touch_bit(dev
, bit
, &ret
))
728 static void ds9490r_write_bit(void *data
, u8 bit
)
730 struct ds_device
*dev
= data
;
732 ds_write_bit(dev
, bit
);
735 static u8
ds9490r_read_bit(void *data
)
737 struct ds_device
*dev
= data
;
741 err
= ds_touch_bit(dev
, 1, &bit
);
749 static void ds9490r_write_byte(void *data
, u8 byte
)
751 struct ds_device
*dev
= data
;
753 ds_write_byte(dev
, byte
);
756 static u8
ds9490r_read_byte(void *data
)
758 struct ds_device
*dev
= data
;
762 err
= ds_read_byte(dev
, &byte
);
769 static void ds9490r_write_block(void *data
, const u8
*buf
, int len
)
771 struct ds_device
*dev
= data
;
773 ds_write_block(dev
, (u8
*)buf
, len
);
776 static u8
ds9490r_read_block(void *data
, u8
*buf
, int len
)
778 struct ds_device
*dev
= data
;
781 err
= ds_read_block(dev
, buf
, len
);
788 static u8
ds9490r_reset(void *data
)
790 struct ds_device
*dev
= data
;
794 memset(&st
, 0, sizeof(st
));
796 err
= ds_reset(dev
, &st
);
803 static u8
ds9490r_set_pullup(void *data
, int delay
)
805 struct ds_device
*dev
= data
;
807 if (ds_set_pullup(dev
, delay
))
813 static int ds_w1_init(struct ds_device
*dev
)
815 memset(&dev
->master
, 0, sizeof(struct w1_bus_master
));
817 dev
->master
.data
= dev
;
818 dev
->master
.touch_bit
= &ds9490r_touch_bit
;
819 /* read_bit and write_bit in w1_bus_master are expected to set and
820 * sample the line level. For write_bit that means it is expected to
821 * set it to that value and leave it there. ds2490 only supports an
822 * individual time slot at the lowest level. The requirement from
823 * pulling the bus state down to reading the state is 15us, something
824 * that isn't realistic on the USB bus anyway.
825 dev->master.read_bit = &ds9490r_read_bit;
826 dev->master.write_bit = &ds9490r_write_bit;
828 dev
->master
.read_byte
= &ds9490r_read_byte
;
829 dev
->master
.write_byte
= &ds9490r_write_byte
;
830 dev
->master
.read_block
= &ds9490r_read_block
;
831 dev
->master
.write_block
= &ds9490r_write_block
;
832 dev
->master
.reset_bus
= &ds9490r_reset
;
833 dev
->master
.set_pullup
= &ds9490r_set_pullup
;
835 return w1_add_master_device(&dev
->master
);
838 static void ds_w1_fini(struct ds_device
*dev
)
840 w1_remove_master_device(&dev
->master
);
843 static int ds_probe(struct usb_interface
*intf
,
844 const struct usb_device_id
*udev_id
)
846 struct usb_device
*udev
= interface_to_usbdev(intf
);
847 struct usb_endpoint_descriptor
*endpoint
;
848 struct usb_host_interface
*iface_desc
;
849 struct ds_device
*dev
;
852 dev
= kmalloc(sizeof(struct ds_device
), GFP_KERNEL
);
854 printk(KERN_INFO
"Failed to allocate new DS9490R structure.\n");
858 dev
->udev
= usb_get_dev(udev
);
863 memset(dev
->ep
, 0, sizeof(dev
->ep
));
865 usb_set_intfdata(intf
, dev
);
867 err
= usb_set_interface(dev
->udev
, intf
->altsetting
[0].desc
.bInterfaceNumber
, 3);
869 printk(KERN_ERR
"Failed to set alternative setting 3 for %d interface: err=%d.\n",
870 intf
->altsetting
[0].desc
.bInterfaceNumber
, err
);
874 err
= usb_reset_configuration(dev
->udev
);
876 printk(KERN_ERR
"Failed to reset configuration: err=%d.\n", err
);
880 iface_desc
= &intf
->altsetting
[0];
881 if (iface_desc
->desc
.bNumEndpoints
!= NUM_EP
-1) {
882 printk(KERN_INFO
"Num endpoints=%d. It is not DS9490R.\n", iface_desc
->desc
.bNumEndpoints
);
888 * This loop doesn'd show control 0 endpoint,
889 * so we will fill only 1-3 endpoints entry.
891 for (i
= 0; i
< iface_desc
->desc
.bNumEndpoints
; ++i
) {
892 endpoint
= &iface_desc
->endpoint
[i
].desc
;
894 dev
->ep
[i
+1] = endpoint
->bEndpointAddress
;
896 printk("%d: addr=%x, size=%d, dir=%s, type=%x\n",
897 i
, endpoint
->bEndpointAddress
, le16_to_cpu(endpoint
->wMaxPacketSize
),
898 (endpoint
->bEndpointAddress
& USB_DIR_IN
)?"IN":"OUT",
899 endpoint
->bmAttributes
& USB_ENDPOINT_XFERTYPE_MASK
);
903 err
= ds_w1_init(dev
);
907 mutex_lock(&ds_mutex
);
908 list_add_tail(&dev
->ds_entry
, &ds_devices
);
909 mutex_unlock(&ds_mutex
);
914 usb_set_intfdata(intf
, NULL
);
915 usb_put_dev(dev
->udev
);
921 static void ds_disconnect(struct usb_interface
*intf
)
923 struct ds_device
*dev
;
925 dev
= usb_get_intfdata(intf
);
929 mutex_lock(&ds_mutex
);
930 list_del(&dev
->ds_entry
);
931 mutex_unlock(&ds_mutex
);
935 usb_set_intfdata(intf
, NULL
);
937 usb_put_dev(dev
->udev
);
941 static int ds_init(void)
945 err
= usb_register(&ds_driver
);
947 printk(KERN_INFO
"Failed to register DS9490R USB device: err=%d.\n", err
);
954 static void ds_fini(void)
956 usb_deregister(&ds_driver
);
959 module_init(ds_init
);
960 module_exit(ds_fini
);
962 MODULE_LICENSE("GPL");
963 MODULE_AUTHOR("Evgeniy Polyakov <johnpol@2ka.mipt.ru>");
964 MODULE_DESCRIPTION("DS2490 USB <-> W1 bus master driver (DS9490*)");