[linux-2.6-block.git] / include / linux / enclosure.h

/*
 * Enclosure Services
 *
 * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
 *
**-----------------------------------------------------------------------------
**
**  This program is free software; you can redistribute it and/or
**  modify it under the terms of the GNU General Public License
**  version 2 as published by the Free Software Foundation.
**
**  This program is distributed in the hope that it will be useful,
**  but WITHOUT ANY WARRANTY; without even the implied warranty of
**  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**  GNU General Public License for more details.
**
**  You should have received a copy of the GNU General Public License
**  along with this program; if not, write to the Free Software
**  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
**
**-----------------------------------------------------------------------------
*/
#ifndef _LINUX_ENCLOSURE_H_
#define _LINUX_ENCLOSURE_H_

#include <linux/device.h>
#include <linux/list.h>

/* A few generic types ... taken from ses-2 */
enum enclosure_component_type {
	ENCLOSURE_COMPONENT_DEVICE = 0x01,
	ENCLOSURE_COMPONENT_ARRAY_DEVICE = 0x17,
};

/* ses-2 common element status */
enum enclosure_status {
	ENCLOSURE_STATUS_UNSUPPORTED = 0,
	ENCLOSURE_STATUS_OK,
	ENCLOSURE_STATUS_CRITICAL,
	ENCLOSURE_STATUS_NON_CRITICAL,
	ENCLOSURE_STATUS_UNRECOVERABLE,
	ENCLOSURE_STATUS_NOT_INSTALLED,
	ENCLOSURE_STATUS_UNKNOWN,
	ENCLOSURE_STATUS_UNAVAILABLE,
	/* last element for counting purposes */
	ENCLOSURE_STATUS_MAX
};

/* SFF-8485 activity light settings */
enum enclosure_component_setting {
	ENCLOSURE_SETTING_DISABLED = 0,
	ENCLOSURE_SETTING_ENABLED = 1,
	ENCLOSURE_SETTING_BLINK_A_ON_OFF = 2,
	ENCLOSURE_SETTING_BLINK_A_OFF_ON = 3,
	ENCLOSURE_SETTING_BLINK_B_ON_OFF = 6,
	ENCLOSURE_SETTING_BLINK_B_OFF_ON = 7,
};

struct enclosure_device;
struct enclosure_component;
struct enclosure_component_callbacks {
	void (*get_status)(struct enclosure_device *,
			     struct enclosure_component *);
	int (*set_status)(struct enclosure_device *,
			  struct enclosure_component *,
			  enum enclosure_status);
	void (*get_fault)(struct enclosure_device *,
			  struct enclosure_component *);
	int (*set_fault)(struct enclosure_device *,
			 struct enclosure_component *,
			 enum enclosure_component_setting);
	void (*get_active)(struct enclosure_device *,
			   struct enclosure_component *);
	int (*set_active)(struct enclosure_device *,
			  struct enclosure_component *,
			  enum enclosure_component_setting);
	void (*get_locate)(struct enclosure_device *,
			   struct enclosure_component *);
	int (*set_locate)(struct enclosure_device *,
			  struct enclosure_component *,
			  enum enclosure_component_setting);
	void (*get_power_status)(struct enclosure_device *,
				 struct enclosure_component *);
	int (*set_power_status)(struct enclosure_device *,
				struct enclosure_component *,
				int);
	int (*show_id)(struct enclosure_device *, char *buf);
};


struct enclosure_component {
	void *scratch;
	struct device cdev;
	struct device *dev;
	enum enclosure_component_type type;
	int number;
	int fault;
	int active;
	int locate;
	int slot;
	enum enclosure_status status;
	int power_status;
};

struct enclosure_device {
	void *scratch;
	struct list_head node;
	struct device edev;
	struct enclosure_component_callbacks *cb;
	int components;
	struct enclosure_component component[0];
};

static inline struct enclosure_device *
to_enclosure_device(struct device *dev)
{
	return container_of(dev, struct enclosure_device, edev);
}

static inline struct enclosure_component *
to_enclosure_component(struct device *dev)
{
	return container_of(dev, struct enclosure_component, cdev);
}

struct enclosure_device *
enclosure_register(struct device *, const char *, int,
		   struct enclosure_component_callbacks *);
void enclosure_unregister(struct enclosure_device *);
struct enclosure_component *
enclosure_component_alloc(struct enclosure_device *, unsigned int,
			  enum enclosure_component_type, const char *);
int enclosure_component_register(struct enclosure_component *);
int enclosure_add_device(struct enclosure_device *enclosure, int component,
			 struct device *dev);
int enclosure_remove_device(struct enclosure_device *, struct device *);
struct enclosure_device *enclosure_find(struct device *dev,
					struct enclosure_device *start);
int enclosure_for_each_device(int (*fn)(struct enclosure_device *, void *),
			      void *data);

#endif /* _LINUX_ENCLOSURE_H_ */
Commit	Line	Data
d569d5bb JB	1	/*
	2	* Enclosure Services
	3	*
	4	* Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
	5	*
	6	**-----------------------------------------------------------------------------
	7	**
	8	** This program is free software; you can redistribute it and/or
	9	** modify it under the terms of the GNU General Public License
	10	** version 2 as published by the Free Software Foundation.
	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
	19	** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	20	**
	21	**-----------------------------------------------------------------------------
	22	*/
	23	#ifndef _LINUX_ENCLOSURE_H_
	24	#define _LINUX_ENCLOSURE_H_
	25
	26	#include <linux/device.h>
	27	#include <linux/list.h>
	28
	29	/* A few generic types ... taken from ses-2 */
	30	enum enclosure_component_type {
	31	ENCLOSURE_COMPONENT_DEVICE = 0x01,
	32	ENCLOSURE_COMPONENT_ARRAY_DEVICE = 0x17,
	33	};
	34
	35	/* ses-2 common element status */
	36	enum enclosure_status {
	37	ENCLOSURE_STATUS_UNSUPPORTED = 0,
	38	ENCLOSURE_STATUS_OK,
	39	ENCLOSURE_STATUS_CRITICAL,
	40	ENCLOSURE_STATUS_NON_CRITICAL,
	41	ENCLOSURE_STATUS_UNRECOVERABLE,
	42	ENCLOSURE_STATUS_NOT_INSTALLED,
	43	ENCLOSURE_STATUS_UNKNOWN,
	44	ENCLOSURE_STATUS_UNAVAILABLE,
cc9b2e9f JB	45	/* last element for counting purposes */
cc9b2e9f JB	46	ENCLOSURE_STATUS_MAX
d569d5bb JB	47	};
	48
	49	/* SFF-8485 activity light settings */
	50	enum enclosure_component_setting {
	51	ENCLOSURE_SETTING_DISABLED = 0,
	52	ENCLOSURE_SETTING_ENABLED = 1,
	53	ENCLOSURE_SETTING_BLINK_A_ON_OFF = 2,
	54	ENCLOSURE_SETTING_BLINK_A_OFF_ON = 3,
	55	ENCLOSURE_SETTING_BLINK_B_ON_OFF = 6,
	56	ENCLOSURE_SETTING_BLINK_B_OFF_ON = 7,
	57	};
	58
	59	struct enclosure_device;
	60	struct enclosure_component;
	61	struct enclosure_component_callbacks {
	62	void (get_status)(struct enclosure_device ,
	63	struct enclosure_component *);
	64	int (set_status)(struct enclosure_device ,
	65	struct enclosure_component *,
	66	enum enclosure_status);
	67	void (get_fault)(struct enclosure_device ,
	68	struct enclosure_component *);
	69	int (set_fault)(struct enclosure_device ,
	70	struct enclosure_component *,
	71	enum enclosure_component_setting);
	72	void (get_active)(struct enclosure_device ,
	73	struct enclosure_component *);
	74	int (set_active)(struct enclosure_device ,
	75	struct enclosure_component *,
	76	enum enclosure_component_setting);
	77	void (get_locate)(struct enclosure_device ,
	78	struct enclosure_component *);
	79	int (set_locate)(struct enclosure_device ,
	80	struct enclosure_component *,
	81	enum enclosure_component_setting);
08024885 SL	82	void (get_power_status)(struct enclosure_device ,
	83	struct enclosure_component *);
	84	int (set_power_status)(struct enclosure_device ,
	85	struct enclosure_component *,
	86	int);
967f7bab	87	int (show_id)(struct enclosure_device , char *buf);
d569d5bb JB	88	};
	89
	90
	91	struct enclosure_component {
	92	void *scratch;
ee959b00 TJ	93	struct device cdev;
ee959b00 TJ	94	struct device *dev;
d569d5bb JB	95	enum enclosure_component_type type;
	96	int number;
	97	int fault;
	98	int active;
	99	int locate;
921ce7f5	100	int slot;
d569d5bb	101	enum enclosure_status status;
08024885	102	int power_status;
d569d5bb JB	103	};
	104
	105	struct enclosure_device {
	106	void *scratch;
	107	struct list_head node;
ee959b00	108	struct device edev;
d569d5bb JB	109	struct enclosure_component_callbacks *cb;
	110	int components;
	111	struct enclosure_component component[0];
	112	};
	113
	114	static inline struct enclosure_device *
ee959b00	115	to_enclosure_device(struct device *dev)
d569d5bb	116	{
ee959b00	117	return container_of(dev, struct enclosure_device, edev);
d569d5bb JB	118	}
	119
	120	static inline struct enclosure_component *
ee959b00	121	to_enclosure_component(struct device *dev)
d569d5bb JB	122	{
	123	return container_of(dev, struct enclosure_component, cdev);
	124	}
	125
	126	struct enclosure_device *
	127	enclosure_register(struct device , const char , int,
	128	struct enclosure_component_callbacks *);
	129	void enclosure_unregister(struct enclosure_device *);
	130	struct enclosure_component *
ed09dcc8 DW	131	enclosure_component_alloc(struct enclosure_device *, unsigned int,
	132	enum enclosure_component_type, const char *);
	133	int enclosure_component_register(struct enclosure_component *);
d569d5bb JB	134	int enclosure_add_device(struct enclosure_device *enclosure, int component,
d569d5bb JB	135	struct device *dev);
43d8eb9c	136	int enclosure_remove_device(struct enclosure_device , struct device );
163f52b6 JB	137	struct enclosure_device enclosure_find(struct device dev,
163f52b6 JB	138	struct enclosure_device *start);
d569d5bb JB	139	int enclosure_for_each_device(int (fn)(struct enclosure_device , void *),
	140	void *data);
	141
	142	#endif /* _LINUX_ENCLOSURE_H_ */