PCI: fix missing kernel-doc and typos
[linux-2.6/mini2440.git] / drivers / w1 / masters / matrox_w1.c
blob1550431ccb6ade0b3b1ee556d3ea809f1c125132
1 /*
2 * matrox_w1.c
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 <asm/types.h>
23 #include <asm/atomic.h>
24 #include <asm/io.h>
26 #include <linux/delay.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/list.h>
30 #include <linux/interrupt.h>
31 #include <linux/spinlock.h>
32 #include <linux/timer.h>
33 #include <linux/slab.h>
34 #include <linux/pci_ids.h>
35 #include <linux/pci.h>
37 #include "../w1.h"
38 #include "../w1_int.h"
39 #include "../w1_log.h"
41 MODULE_LICENSE("GPL");
42 MODULE_AUTHOR("Evgeniy Polyakov <johnpol@2ka.mipt.ru>");
43 MODULE_DESCRIPTION("Driver for transport(Dallas 1-wire prtocol) over VGA DDC(matrox gpio).");
45 static struct pci_device_id matrox_w1_tbl[] = {
46 { PCI_DEVICE(PCI_VENDOR_ID_MATROX, PCI_DEVICE_ID_MATROX_G400) },
47 { },
49 MODULE_DEVICE_TABLE(pci, matrox_w1_tbl);
51 static int __devinit matrox_w1_probe(struct pci_dev *, const struct pci_device_id *);
52 static void __devexit matrox_w1_remove(struct pci_dev *);
54 static struct pci_driver matrox_w1_pci_driver = {
55 .name = "matrox_w1",
56 .id_table = matrox_w1_tbl,
57 .probe = matrox_w1_probe,
58 .remove = __devexit_p(matrox_w1_remove),
62 * Matrox G400 DDC registers.
65 #define MATROX_G400_DDC_CLK (1<<4)
66 #define MATROX_G400_DDC_DATA (1<<1)
68 #define MATROX_BASE 0x3C00
69 #define MATROX_STATUS 0x1e14
71 #define MATROX_PORT_INDEX_OFFSET 0x00
72 #define MATROX_PORT_DATA_OFFSET 0x0A
74 #define MATROX_GET_CONTROL 0x2A
75 #define MATROX_GET_DATA 0x2B
76 #define MATROX_CURSOR_CTL 0x06
78 struct matrox_device
80 void __iomem *base_addr;
81 void __iomem *port_index;
82 void __iomem *port_data;
83 u8 data_mask;
85 unsigned long phys_addr;
86 void __iomem *virt_addr;
87 unsigned long found;
89 struct w1_bus_master *bus_master;
92 static u8 matrox_w1_read_ddc_bit(void *);
93 static void matrox_w1_write_ddc_bit(void *, u8);
96 * These functions read and write DDC Data bit.
98 * Using tristate pins, since i can't find any open-drain pin in whole motherboard.
99 * Unfortunately we can't connect to Intel's 82801xx IO controller
100 * since we don't know motherboard schema, which has pretty unused(may be not) GPIO.
102 * I've heard that PIIX also has open drain pin.
104 * Port mapping.
106 static __inline__ u8 matrox_w1_read_reg(struct matrox_device *dev, u8 reg)
108 u8 ret;
110 writeb(reg, dev->port_index);
111 ret = readb(dev->port_data);
112 barrier();
114 return ret;
117 static __inline__ void matrox_w1_write_reg(struct matrox_device *dev, u8 reg, u8 val)
119 writeb(reg, dev->port_index);
120 writeb(val, dev->port_data);
121 wmb();
124 static void matrox_w1_write_ddc_bit(void *data, u8 bit)
126 u8 ret;
127 struct matrox_device *dev = data;
129 if (bit)
130 bit = 0;
131 else
132 bit = dev->data_mask;
134 ret = matrox_w1_read_reg(dev, MATROX_GET_CONTROL);
135 matrox_w1_write_reg(dev, MATROX_GET_CONTROL, ((ret & ~dev->data_mask) | bit));
136 matrox_w1_write_reg(dev, MATROX_GET_DATA, 0x00);
139 static u8 matrox_w1_read_ddc_bit(void *data)
141 u8 ret;
142 struct matrox_device *dev = data;
144 ret = matrox_w1_read_reg(dev, MATROX_GET_DATA);
146 return ret;
149 static void matrox_w1_hw_init(struct matrox_device *dev)
151 matrox_w1_write_reg(dev, MATROX_GET_DATA, 0xFF);
152 matrox_w1_write_reg(dev, MATROX_GET_CONTROL, 0x00);
155 static int __devinit matrox_w1_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
157 struct matrox_device *dev;
158 int err;
160 assert(pdev != NULL);
161 assert(ent != NULL);
163 if (pdev->vendor != PCI_VENDOR_ID_MATROX || pdev->device != PCI_DEVICE_ID_MATROX_G400)
164 return -ENODEV;
166 dev = kzalloc(sizeof(struct matrox_device) +
167 sizeof(struct w1_bus_master), GFP_KERNEL);
168 if (!dev) {
169 dev_err(&pdev->dev,
170 "%s: Failed to create new matrox_device object.\n",
171 __func__);
172 return -ENOMEM;
176 dev->bus_master = (struct w1_bus_master *)(dev + 1);
179 * True for G400, for some other we need resource 0, see drivers/video/matrox/matroxfb_base.c
182 dev->phys_addr = pci_resource_start(pdev, 1);
184 dev->virt_addr = ioremap_nocache(dev->phys_addr, 16384);
185 if (!dev->virt_addr) {
186 dev_err(&pdev->dev, "%s: failed to ioremap(0x%lx, %d).\n",
187 __func__, dev->phys_addr, 16384);
188 err = -EIO;
189 goto err_out_free_device;
192 dev->base_addr = dev->virt_addr + MATROX_BASE;
193 dev->port_index = dev->base_addr + MATROX_PORT_INDEX_OFFSET;
194 dev->port_data = dev->base_addr + MATROX_PORT_DATA_OFFSET;
195 dev->data_mask = (MATROX_G400_DDC_DATA);
197 matrox_w1_hw_init(dev);
199 dev->bus_master->data = dev;
200 dev->bus_master->read_bit = &matrox_w1_read_ddc_bit;
201 dev->bus_master->write_bit = &matrox_w1_write_ddc_bit;
203 err = w1_add_master_device(dev->bus_master);
204 if (err)
205 goto err_out_free_device;
207 pci_set_drvdata(pdev, dev);
209 dev->found = 1;
211 dev_info(&pdev->dev, "Matrox G400 GPIO transport layer for 1-wire.\n");
213 return 0;
215 err_out_free_device:
216 if (dev->virt_addr)
217 iounmap(dev->virt_addr);
218 kfree(dev);
220 return err;
223 static void __devexit matrox_w1_remove(struct pci_dev *pdev)
225 struct matrox_device *dev = pci_get_drvdata(pdev);
227 assert(dev != NULL);
229 if (dev->found) {
230 w1_remove_master_device(dev->bus_master);
231 iounmap(dev->virt_addr);
233 kfree(dev);
236 static int __init matrox_w1_init(void)
238 return pci_register_driver(&matrox_w1_pci_driver);
241 static void __exit matrox_w1_fini(void)
243 pci_unregister_driver(&matrox_w1_pci_driver);
246 module_init(matrox_w1_init);
247 module_exit(matrox_w1_fini);