[mirror_ubuntu-bionic-kernel.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_CONTROLLER_ELECTRONICS = 0x07,
	ENCLOSURE_COMPONENT_SCSI_TARGET_PORT = 0x14,
	ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT = 0x15,
	ENCLOSURE_COMPONENT_ARRAY_DEVICE = 0x17,
	ENCLOSURE_COMPONENT_SAS_EXPANDER = 0x18,
};

/* 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,
5e103356 JB	32	ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS = 0x07,
	33	ENCLOSURE_COMPONENT_SCSI_TARGET_PORT = 0x14,
	34	ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT = 0x15,
d569d5bb	35	ENCLOSURE_COMPONENT_ARRAY_DEVICE = 0x17,
5e103356	36	ENCLOSURE_COMPONENT_SAS_EXPANDER = 0x18,
d569d5bb JB	37	};
	38
	39	/* ses-2 common element status */
	40	enum enclosure_status {
	41	ENCLOSURE_STATUS_UNSUPPORTED = 0,
	42	ENCLOSURE_STATUS_OK,
	43	ENCLOSURE_STATUS_CRITICAL,
	44	ENCLOSURE_STATUS_NON_CRITICAL,
	45	ENCLOSURE_STATUS_UNRECOVERABLE,
	46	ENCLOSURE_STATUS_NOT_INSTALLED,
	47	ENCLOSURE_STATUS_UNKNOWN,
	48	ENCLOSURE_STATUS_UNAVAILABLE,
cc9b2e9f JB	49	/* last element for counting purposes */
cc9b2e9f JB	50	ENCLOSURE_STATUS_MAX
d569d5bb JB	51	};
	52
	53	/* SFF-8485 activity light settings */
	54	enum enclosure_component_setting {
	55	ENCLOSURE_SETTING_DISABLED = 0,
	56	ENCLOSURE_SETTING_ENABLED = 1,
	57	ENCLOSURE_SETTING_BLINK_A_ON_OFF = 2,
	58	ENCLOSURE_SETTING_BLINK_A_OFF_ON = 3,
	59	ENCLOSURE_SETTING_BLINK_B_ON_OFF = 6,
	60	ENCLOSURE_SETTING_BLINK_B_OFF_ON = 7,
	61	};
	62
	63	struct enclosure_device;
	64	struct enclosure_component;
	65	struct enclosure_component_callbacks {
	66	void (get_status)(struct enclosure_device ,
	67	struct enclosure_component *);
	68	int (set_status)(struct enclosure_device ,
	69	struct enclosure_component *,
	70	enum enclosure_status);
	71	void (get_fault)(struct enclosure_device ,
	72	struct enclosure_component *);
	73	int (set_fault)(struct enclosure_device ,
	74	struct enclosure_component *,
	75	enum enclosure_component_setting);
	76	void (get_active)(struct enclosure_device ,
	77	struct enclosure_component *);
	78	int (set_active)(struct enclosure_device ,
	79	struct enclosure_component *,
	80	enum enclosure_component_setting);
	81	void (get_locate)(struct enclosure_device ,
	82	struct enclosure_component *);
	83	int (set_locate)(struct enclosure_device ,
	84	struct enclosure_component *,
	85	enum enclosure_component_setting);
08024885 SL	86	void (get_power_status)(struct enclosure_device ,
	87	struct enclosure_component *);
	88	int (set_power_status)(struct enclosure_device ,
	89	struct enclosure_component *,
	90	int);
967f7bab	91	int (show_id)(struct enclosure_device , char *buf);
d569d5bb JB	92	};
	93
	94
	95	struct enclosure_component {
	96	void *scratch;
ee959b00 TJ	97	struct device cdev;
ee959b00 TJ	98	struct device *dev;
d569d5bb JB	99	enum enclosure_component_type type;
	100	int number;
	101	int fault;
	102	int active;
	103	int locate;
921ce7f5	104	int slot;
d569d5bb	105	enum enclosure_status status;
08024885	106	int power_status;
d569d5bb JB	107	};
	108
	109	struct enclosure_device {
	110	void *scratch;
	111	struct list_head node;
ee959b00	112	struct device edev;
d569d5bb JB	113	struct enclosure_component_callbacks *cb;
	114	int components;
	115	struct enclosure_component component[0];
	116	};
	117
	118	static inline struct enclosure_device *
ee959b00	119	to_enclosure_device(struct device *dev)
d569d5bb	120	{
ee959b00	121	return container_of(dev, struct enclosure_device, edev);
d569d5bb JB	122	}
	123
	124	static inline struct enclosure_component *
ee959b00	125	to_enclosure_component(struct device *dev)
d569d5bb JB	126	{
	127	return container_of(dev, struct enclosure_component, cdev);
	128	}
	129
	130	struct enclosure_device *
	131	enclosure_register(struct device , const char , int,
	132	struct enclosure_component_callbacks *);
	133	void enclosure_unregister(struct enclosure_device *);
	134	struct enclosure_component *
ed09dcc8 DW	135	enclosure_component_alloc(struct enclosure_device *, unsigned int,
	136	enum enclosure_component_type, const char *);
	137	int enclosure_component_register(struct enclosure_component *);
d569d5bb JB	138	int enclosure_add_device(struct enclosure_device *enclosure, int component,
d569d5bb JB	139	struct device *dev);
43d8eb9c	140	int enclosure_remove_device(struct enclosure_device , struct device );
163f52b6 JB	141	struct enclosure_device enclosure_find(struct device dev,
163f52b6 JB	142	struct enclosure_device *start);
d569d5bb JB	143	int enclosure_for_each_device(int (fn)(struct enclosure_device , void *),
	144	void *data);
	145
	146	#endif /* _LINUX_ENCLOSURE_H_ */