video: tegra: host: expose power management paramters via sysfs
[linux-2.6.git] / include / linux / nvhost.h
1 /*
2  * include/linux/nvhost.h
3  *
4  * Tegra graphics host driver
5  *
6  * Copyright (c) 2009-2012, NVIDIA Corporation. All rights reserved.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
16  * more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21  */
22
23 #ifndef __LINUX_NVHOST_H
24 #define __LINUX_NVHOST_H
25
26 #include <linux/device.h>
27 #include <linux/types.h>
28
29 struct nvhost_master;
30 struct nvhost_device_power_attr;
31
32 #define NVHOST_MODULE_MAX_CLOCKS                3
33 #define NVHOST_MODULE_MAX_POWERGATE_IDS         2
34 #define NVHOST_MODULE_NO_POWERGATE_IDS          .powergate_ids = {-1, -1}
35 #define NVHOST_DEFAULT_CLOCKGATE_DELAY          .clockgate_delay = 25
36 #define NVHOST_NAME_SIZE                        24
37
38 enum nvhost_power_sysfs_attributes {
39         NVHOST_POWER_SYSFS_ATTRIB_CLOCKGATE_DELAY = 0,
40         NVHOST_POWER_SYSFS_ATTRIB_POWERGATE_DELAY,
41         NVHOST_POWER_SYSFS_ATTRIB_REFCOUNT,
42         NVHOST_POWER_SYSFS_ATTRIB_MAX
43 };
44
45 struct nvhost_device_id {
46         char name[NVHOST_NAME_SIZE];
47         unsigned long version;
48 };
49
50 struct nvhost_clock {
51         char *name;
52         long default_rate;
53 };
54
55 enum nvhost_device_powerstate_t {
56         NVHOST_POWER_STATE_DEINIT,
57         NVHOST_POWER_STATE_RUNNING,
58         NVHOST_POWER_STATE_CLOCKGATED,
59         NVHOST_POWER_STATE_POWERGATED
60 };
61
62 struct nvhost_device {
63         const char      *name;          /* device name */
64         int             version;        /* ip version number of device */
65         struct device   dev;            /* Linux device struct */
66         int             id;             /* Separates clients of same hw */
67         int             index;          /* Hardware channel number */
68         u32             num_resources;  /* Number of resources following */
69         struct resource *resource;      /* Resources (IOMEM in particular) */
70         struct resource *reg_mem;
71         void __iomem    *aperture;      /* Iomem mapped to kernel */
72
73         u32             syncpts;        /* Bitfield of sync points used */
74         u32             waitbases;      /* Bit field of wait bases */
75         u32             modulemutexes;  /* Bit field of module mutexes */
76         u32             moduleid;       /* Module id for user space API */
77
78         u32             class;          /* Device class */
79         bool            exclusive;      /* True if only one user at a time */
80         bool            keepalive;      /* Do not power gate when opened */
81         bool            waitbasesync;   /* Force sync of wait bases */
82         bool            powerup_reset;  /* Do a reset after power un-gating */
83
84         int             powergate_ids[NVHOST_MODULE_MAX_POWERGATE_IDS];
85         bool            can_powergate;  /* True if module can be power gated */
86         int             clockgate_delay;/* Delay before clock gated */
87         int             powergate_delay;/* Delay before power gated */
88         struct nvhost_clock clocks[NVHOST_MODULE_MAX_CLOCKS];/* Clock names */
89
90         struct delayed_work powerstate_down;/* Power state management */
91         int             num_clks;       /* Number of clocks opened for dev */
92         struct clk      *clk[NVHOST_MODULE_MAX_CLOCKS];
93         struct mutex    lock;           /* Power management lock */
94         int             powerstate;     /* Current power state */
95         int             refcount;       /* Number of tasks active */
96         wait_queue_head_t idle_wq;      /* Work queue for idle */
97         struct list_head client_list;   /* List of clients and rate requests */
98
99         struct nvhost_channel *channel; /* Channel assigned for the module */
100         struct kobject *power_kobj;     /* kobject to hold power sysfs entries */
101         struct nvhost_device_power_attr *power_attrib;  /* sysfs attributes */
102 };
103
104 struct nvhost_device_power_attr {
105         struct nvhost_device *ndev;
106         struct kobj_attribute power_attr[NVHOST_POWER_SYSFS_ATTRIB_MAX];
107 };
108
109 /* Register devices to nvhost bus */
110 extern int nvhost_add_devices(struct nvhost_device **, int num);
111
112 /* Register device to nvhost bus */
113 extern int nvhost_device_register(struct nvhost_device *);
114
115 /* Deregister device from nvhost bus */
116 extern void nvhost_device_unregister(struct nvhost_device *);
117
118 extern struct bus_type nvhost_bus_type;
119
120 struct nvhost_driver {
121         int (*probe)(struct nvhost_device *, struct nvhost_device_id *);
122         int (*remove)(struct nvhost_device *);
123         void (*shutdown)(struct nvhost_device *);
124         int (*suspend)(struct nvhost_device *, pm_message_t state);
125         int (*resume)(struct nvhost_device *);
126         struct device_driver driver;
127
128         struct nvhost_device_id *id_table;
129
130         /* Finalize power on. Can be used for context restore. */
131         void (*finalize_poweron)(struct nvhost_device *dev);
132
133         /* Device is busy. */
134         void (*busy)(struct nvhost_device *);
135
136         /* Device is idle. */
137         void (*idle)(struct nvhost_device *);
138
139         /* Device is going to be suspended */
140         void (*suspend_ndev)(struct nvhost_device *);
141
142         /* Device is initialized */
143         void (*init)(struct nvhost_device *dev);
144
145         /* Device is de-initialized. */
146         void (*deinit)(struct nvhost_device *dev);
147
148         /* Preparing for power off. Used for context save. */
149         int (*prepare_poweroff)(struct nvhost_device *dev);
150
151         /* Allocates a context handler for the device */
152         struct nvhost_hwctx_handler *(*alloc_hwctx_handler)(u32 syncpt,
153                         u32 waitbase, struct nvhost_channel *ch);
154 };
155
156 extern int nvhost_driver_register(struct nvhost_driver *);
157 extern void nvhost_driver_unregister(struct nvhost_driver *);
158 extern struct resource *nvhost_get_resource(struct nvhost_device *,
159                 unsigned int, unsigned int);
160 extern int nvhost_get_irq(struct nvhost_device *, unsigned int);
161 extern struct resource *nvhost_get_resource_byname(struct nvhost_device *,
162                 unsigned int, const char *);
163 extern int nvhost_get_irq_byname(struct nvhost_device *, const char *);
164
165 #define to_nvhost_device(x)     container_of((x), struct nvhost_device, dev)
166 #define to_nvhost_driver(drv)   (container_of((drv), struct nvhost_driver, \
167                                  driver))
168
169 #define nvhost_get_drvdata(_dev)        dev_get_drvdata(&(_dev)->dev)
170 #define nvhost_set_drvdata(_dev, data)  dev_set_drvdata(&(_dev)->dev, (data))
171 static inline struct nvhost_master *nvhost_get_host(struct nvhost_device *_dev)
172 {
173         return (_dev->dev.parent) ? \
174                 ((struct nvhost_master *) dev_get_drvdata(_dev->dev.parent)) : \
175                 ((struct nvhost_master *) dev_get_drvdata(&(_dev->dev)));
176 }
177
178 int nvhost_bus_add_host(struct nvhost_master *host);
179
180 #endif