175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* 275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * Windfarm PowerMac thermal control. 375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * 475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * (c) Copyright 2005 Benjamin Herrenschmidt, IBM Corp. 575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * <benh@kernel.crashing.org> 675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * 775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * Released under the term of the GNU GPL v2. 875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt */ 975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 1075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#ifndef __WINDFARM_H__ 1175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define __WINDFARM_H__ 1275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 1375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#include <linux/kref.h> 1475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#include <linux/list.h> 1575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#include <linux/module.h> 1675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#include <linux/notifier.h> 17ac171c46667c1cb2ee9e22312291df6ed78e1b6eBenjamin Herrenschmidt#include <linux/device.h> 1875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 1975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* Display a 16.16 fixed point value */ 206cd3209967469f6e89d329deda6bb0b4700e7b62Benjamin Herrenschmidt#define FIX32TOPRINT(f) (((s32)(f)) >> 16),(((((s32)(f)) & 0xffff) * 1000) >> 16) 2175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 2275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* 2375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * Control objects 2475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt */ 2575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 2675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstruct wf_control; 2775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 2875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstruct wf_control_ops { 2975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt int (*set_value)(struct wf_control *ct, s32 val); 3075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt int (*get_value)(struct wf_control *ct, s32 *val); 3175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt s32 (*get_min)(struct wf_control *ct); 3275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt s32 (*get_max)(struct wf_control *ct); 3375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt void (*release)(struct wf_control *ct); 3475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt struct module *owner; 3575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt}; 3675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 3775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstruct wf_control { 38e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt struct list_head link; 39e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt const struct wf_control_ops *ops; 40e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt const char *name; 41e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt int type; 42e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt struct kref ref; 43e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt struct device_attribute attr; 446cd3209967469f6e89d329deda6bb0b4700e7b62Benjamin Herrenschmidt void *priv; 4575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt}; 4675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 4775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_CONTROL_TYPE_GENERIC 0 4875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_CONTROL_RPM_FAN 1 4975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_CONTROL_PWM_FAN 2 5075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 5175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 5275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* Note about lifetime rules: wf_register_control() will initialize 5375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * the kref and wf_unregister_control will decrement it, thus the 5475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * object creating/disposing a given control shouldn't assume it 5575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * still exists after wf_unregister_control has been called. 5675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * wf_find_control will inc the refcount for you 5775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt */ 5875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern int wf_register_control(struct wf_control *ct); 5975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern void wf_unregister_control(struct wf_control *ct); 6075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern struct wf_control * wf_find_control(const char *name); 6175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern int wf_get_control(struct wf_control *ct); 6275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern void wf_put_control(struct wf_control *ct); 6375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 6475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstatic inline int wf_control_set_max(struct wf_control *ct) 6575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt{ 6675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt s32 vmax = ct->ops->get_max(ct); 6775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt return ct->ops->set_value(ct, vmax); 6875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt} 6975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 7075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstatic inline int wf_control_set_min(struct wf_control *ct) 7175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt{ 7275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt s32 vmin = ct->ops->get_min(ct); 7375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt return ct->ops->set_value(ct, vmin); 7475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt} 7575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 7633e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidtstatic inline int wf_control_set(struct wf_control *ct, s32 val) 7733e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt{ 7833e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt return ct->ops->set_value(ct, val); 7933e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt} 8033e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt 8133e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidtstatic inline int wf_control_get(struct wf_control *ct, s32 *val) 8233e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt{ 8333e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt return ct->ops->get_value(ct, val); 8433e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt} 8533e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt 8633e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidtstatic inline s32 wf_control_get_min(struct wf_control *ct) 8733e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt{ 8833e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt return ct->ops->get_min(ct); 8933e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt} 9033e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt 9133e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidtstatic inline s32 wf_control_get_max(struct wf_control *ct) 9233e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt{ 9333e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt return ct->ops->get_max(ct); 9433e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt} 9533e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt 9675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* 9775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * Sensor objects 9875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt */ 9975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 10075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstruct wf_sensor; 10175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 10275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstruct wf_sensor_ops { 10375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt int (*get_value)(struct wf_sensor *sr, s32 *val); 10475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt void (*release)(struct wf_sensor *sr); 10575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt struct module *owner; 10675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt}; 10775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 10875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtstruct wf_sensor { 109e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt struct list_head link; 110e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt const struct wf_sensor_ops *ops; 111e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt const char *name; 112e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt struct kref ref; 113e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt struct device_attribute attr; 114e074d08e2b98db1b19328bb9395052b34366831dBenjamin Herrenschmidt void *priv; 11575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt}; 11675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 11775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* Same lifetime rules as controls */ 11875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern int wf_register_sensor(struct wf_sensor *sr); 11975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern void wf_unregister_sensor(struct wf_sensor *sr); 12075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern struct wf_sensor * wf_find_sensor(const char *name); 12175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern int wf_get_sensor(struct wf_sensor *sr); 12275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern void wf_put_sensor(struct wf_sensor *sr); 12375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 12433e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidtstatic inline int wf_sensor_get(struct wf_sensor *sr, s32 *val) 12533e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt{ 12633e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt return sr->ops->get_value(sr, val); 12733e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt} 12833e6820b767a5bfa4a0d579da6ee4568a2b1e730Benjamin Herrenschmidt 12975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* For use by clients. Note that we are a bit racy here since 13075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * notifier_block doesn't have a module owner field. I may fix 13175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * it one day ... 13275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * 13375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * LOCKING NOTE ! 13475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * 13575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * All "events" except WF_EVENT_TICK are called with an internal mutex 13675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * held which will deadlock if you call basically any core routine. 13775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * So don't ! Just take note of the event and do your actual operations 13875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * from the ticker. 13975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * 14075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt */ 14175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern int wf_register_client(struct notifier_block *nb); 14275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern int wf_unregister_client(struct notifier_block *nb); 14375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 14475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* Overtemp conditions. Those are refcounted */ 14575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern void wf_set_overtemp(void); 14675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern void wf_clear_overtemp(void); 14775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidtextern int wf_is_overtemp(void); 14875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 14975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_EVENT_NEW_CONTROL 0 /* param is wf_control * */ 15075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_EVENT_NEW_SENSOR 1 /* param is wf_sensor * */ 15175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_EVENT_OVERTEMP 2 /* no param */ 15275722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_EVENT_NORMALTEMP 3 /* overtemp condition cleared */ 15375722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#define WF_EVENT_TICK 4 /* 1 second tick */ 15475722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 15575722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt/* Note: If that driver gets more broad use, we could replace the 15675722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * simplistic overtemp bits with "environmental conditions". That 15775722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * could then be used to also notify of things like fan failure, 15875722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt * case open, battery conditions, ... 15975722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt */ 16075722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt 16175722d3992f57375c0cc029dcceb2334a45ceff1Benjamin Herrenschmidt#endif /* __WINDFARM_H__ */ 162