blob: 4f731c2b121ca02be8eff969012a9c673a9c05e5 [file] [log] [blame]
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001/* -*- c-basic-offset: 8 -*-
2 *
3 * fw-device.h - Device probing and sysfs code.
4 *
5 * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
6 *
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.
11 *
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.
16 *
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 Foundation,
19 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 */
21
22#ifndef __fw_device_h
23#define __fw_device_h
24
25#include <linux/fs.h>
26#include <linux/cdev.h>
Stefan Richter641f8792007-01-27 10:34:55 +010027#include <asm/atomic.h>
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050028
29enum fw_device_state {
30 FW_DEVICE_INITIALIZING,
31 FW_DEVICE_RUNNING,
Stefan Richter5af4e5e2007-01-21 20:45:32 +010032 FW_DEVICE_SHUTDOWN,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050033};
34
35struct fw_device {
Stefan Richter641f8792007-01-27 10:34:55 +010036 atomic_t state;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050037 struct fw_node *node;
38 int node_id;
39 int generation;
40 struct fw_card *card;
41 struct device device;
42 struct cdev cdev;
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -050043 struct list_head client_list;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050044 __be32 *config_rom;
45 size_t config_rom_length;
46 int config_rom_retries;
47 struct delayed_work work;
48};
49
50static inline struct fw_device *
51fw_device(struct device *dev)
52{
Stefan Richter5e20c282007-01-21 20:44:09 +010053 return container_of(dev, struct fw_device, device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050054}
55
56struct fw_device *fw_device_get(struct fw_device *device);
57void fw_device_put(struct fw_device *device);
58int fw_device_enable_phys_dma(struct fw_device *device);
59
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -050060void fw_device_cdev_update(struct fw_device *device);
61
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050062struct fw_unit {
63 struct device device;
64 u32 *directory;
65};
66
67static inline struct fw_unit *
68fw_unit(struct device *dev)
69{
Stefan Richter5e20c282007-01-21 20:44:09 +010070 return container_of(dev, struct fw_unit, device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050071}
72
73#define CSR_OFFSET 0x40
74#define CSR_LEAF 0x80
75#define CSR_DIRECTORY 0xc0
76
77#define CSR_DESCRIPTOR 0x01
78#define CSR_VENDOR 0x03
79#define CSR_HARDWARE_VERSION 0x04
80#define CSR_NODE_CAPABILITIES 0x0c
81#define CSR_UNIT 0x11
82#define CSR_SPECIFIER_ID 0x12
83#define CSR_VERSION 0x13
84#define CSR_DEPENDENT_INFO 0x14
85#define CSR_MODEL 0x17
86#define CSR_INSTANCE 0x18
87
88#define SBP2_COMMAND_SET_SPECIFIER 0x38
89#define SBP2_COMMAND_SET 0x39
90#define SBP2_COMMAND_SET_REVISION 0x3b
91#define SBP2_FIRMWARE_REVISION 0x3c
92
93struct fw_csr_iterator {
94 u32 *p;
95 u32 *end;
96};
97
98void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
99int fw_csr_iterator_next(struct fw_csr_iterator *ci,
100 int *key, int *value);
101
102#define FW_MATCH_VENDOR 0x0001
103#define FW_MATCH_MODEL 0x0002
104#define FW_MATCH_SPECIFIER_ID 0x0004
105#define FW_MATCH_VERSION 0x0008
106
107struct fw_device_id {
108 u32 match_flags;
109 u32 vendor;
110 u32 model;
111 u32 specifier_id;
112 u32 version;
113 void *driver_data;
114};
115
116struct fw_driver {
117 struct device_driver driver;
118 /* Called when the parent device sits through a bus reset. */
119 void (*update) (struct fw_unit *unit);
Stefan Richter21ebcd12007-01-14 15:29:07 +0100120 const struct fw_device_id *id_table;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500121};
122
123static inline struct fw_driver *
124fw_driver(struct device_driver *drv)
125{
Stefan Richter5e20c282007-01-21 20:44:09 +0100126 return container_of(drv, struct fw_driver, driver);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500127}
128
Stefan Richter21ebcd12007-01-14 15:29:07 +0100129extern const struct file_operations fw_device_ops;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500130
Stefan Richter687198b2006-12-28 16:20:00 +0100131#endif /* __fw_device_h */