1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Enclosure Services
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 2008 James Bottomley <James.Bottomley@HansenPartnership.com>
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun **-----------------------------------------------------------------------------
8*4882a593Smuzhiyun **
9*4882a593Smuzhiyun **
10*4882a593Smuzhiyun **-----------------------------------------------------------------------------
11*4882a593Smuzhiyun */
12*4882a593Smuzhiyun #ifndef _LINUX_ENCLOSURE_H_
13*4882a593Smuzhiyun #define _LINUX_ENCLOSURE_H_
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun #include <linux/device.h>
16*4882a593Smuzhiyun #include <linux/list.h>
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun /* A few generic types ... taken from ses-2 */
19*4882a593Smuzhiyun enum enclosure_component_type {
20*4882a593Smuzhiyun ENCLOSURE_COMPONENT_DEVICE = 0x01,
21*4882a593Smuzhiyun ENCLOSURE_COMPONENT_CONTROLLER_ELECTRONICS = 0x07,
22*4882a593Smuzhiyun ENCLOSURE_COMPONENT_SCSI_TARGET_PORT = 0x14,
23*4882a593Smuzhiyun ENCLOSURE_COMPONENT_SCSI_INITIATOR_PORT = 0x15,
24*4882a593Smuzhiyun ENCLOSURE_COMPONENT_ARRAY_DEVICE = 0x17,
25*4882a593Smuzhiyun ENCLOSURE_COMPONENT_SAS_EXPANDER = 0x18,
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun /* ses-2 common element status */
29*4882a593Smuzhiyun enum enclosure_status {
30*4882a593Smuzhiyun ENCLOSURE_STATUS_UNSUPPORTED = 0,
31*4882a593Smuzhiyun ENCLOSURE_STATUS_OK,
32*4882a593Smuzhiyun ENCLOSURE_STATUS_CRITICAL,
33*4882a593Smuzhiyun ENCLOSURE_STATUS_NON_CRITICAL,
34*4882a593Smuzhiyun ENCLOSURE_STATUS_UNRECOVERABLE,
35*4882a593Smuzhiyun ENCLOSURE_STATUS_NOT_INSTALLED,
36*4882a593Smuzhiyun ENCLOSURE_STATUS_UNKNOWN,
37*4882a593Smuzhiyun ENCLOSURE_STATUS_UNAVAILABLE,
38*4882a593Smuzhiyun /* last element for counting purposes */
39*4882a593Smuzhiyun ENCLOSURE_STATUS_MAX
40*4882a593Smuzhiyun };
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun /* SFF-8485 activity light settings */
43*4882a593Smuzhiyun enum enclosure_component_setting {
44*4882a593Smuzhiyun ENCLOSURE_SETTING_DISABLED = 0,
45*4882a593Smuzhiyun ENCLOSURE_SETTING_ENABLED = 1,
46*4882a593Smuzhiyun ENCLOSURE_SETTING_BLINK_A_ON_OFF = 2,
47*4882a593Smuzhiyun ENCLOSURE_SETTING_BLINK_A_OFF_ON = 3,
48*4882a593Smuzhiyun ENCLOSURE_SETTING_BLINK_B_ON_OFF = 6,
49*4882a593Smuzhiyun ENCLOSURE_SETTING_BLINK_B_OFF_ON = 7,
50*4882a593Smuzhiyun };
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun struct enclosure_device;
53*4882a593Smuzhiyun struct enclosure_component;
54*4882a593Smuzhiyun struct enclosure_component_callbacks {
55*4882a593Smuzhiyun void (*get_status)(struct enclosure_device *,
56*4882a593Smuzhiyun struct enclosure_component *);
57*4882a593Smuzhiyun int (*set_status)(struct enclosure_device *,
58*4882a593Smuzhiyun struct enclosure_component *,
59*4882a593Smuzhiyun enum enclosure_status);
60*4882a593Smuzhiyun void (*get_fault)(struct enclosure_device *,
61*4882a593Smuzhiyun struct enclosure_component *);
62*4882a593Smuzhiyun int (*set_fault)(struct enclosure_device *,
63*4882a593Smuzhiyun struct enclosure_component *,
64*4882a593Smuzhiyun enum enclosure_component_setting);
65*4882a593Smuzhiyun void (*get_active)(struct enclosure_device *,
66*4882a593Smuzhiyun struct enclosure_component *);
67*4882a593Smuzhiyun int (*set_active)(struct enclosure_device *,
68*4882a593Smuzhiyun struct enclosure_component *,
69*4882a593Smuzhiyun enum enclosure_component_setting);
70*4882a593Smuzhiyun void (*get_locate)(struct enclosure_device *,
71*4882a593Smuzhiyun struct enclosure_component *);
72*4882a593Smuzhiyun int (*set_locate)(struct enclosure_device *,
73*4882a593Smuzhiyun struct enclosure_component *,
74*4882a593Smuzhiyun enum enclosure_component_setting);
75*4882a593Smuzhiyun void (*get_power_status)(struct enclosure_device *,
76*4882a593Smuzhiyun struct enclosure_component *);
77*4882a593Smuzhiyun int (*set_power_status)(struct enclosure_device *,
78*4882a593Smuzhiyun struct enclosure_component *,
79*4882a593Smuzhiyun int);
80*4882a593Smuzhiyun int (*show_id)(struct enclosure_device *, char *buf);
81*4882a593Smuzhiyun };
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun struct enclosure_component {
85*4882a593Smuzhiyun void *scratch;
86*4882a593Smuzhiyun struct device cdev;
87*4882a593Smuzhiyun struct device *dev;
88*4882a593Smuzhiyun enum enclosure_component_type type;
89*4882a593Smuzhiyun int number;
90*4882a593Smuzhiyun int fault;
91*4882a593Smuzhiyun int active;
92*4882a593Smuzhiyun int locate;
93*4882a593Smuzhiyun int slot;
94*4882a593Smuzhiyun enum enclosure_status status;
95*4882a593Smuzhiyun int power_status;
96*4882a593Smuzhiyun };
97*4882a593Smuzhiyun
98*4882a593Smuzhiyun struct enclosure_device {
99*4882a593Smuzhiyun void *scratch;
100*4882a593Smuzhiyun struct list_head node;
101*4882a593Smuzhiyun struct device edev;
102*4882a593Smuzhiyun struct enclosure_component_callbacks *cb;
103*4882a593Smuzhiyun int components;
104*4882a593Smuzhiyun struct enclosure_component component[];
105*4882a593Smuzhiyun };
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun static inline struct enclosure_device *
to_enclosure_device(struct device * dev)108*4882a593Smuzhiyun to_enclosure_device(struct device *dev)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun return container_of(dev, struct enclosure_device, edev);
111*4882a593Smuzhiyun }
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun static inline struct enclosure_component *
to_enclosure_component(struct device * dev)114*4882a593Smuzhiyun to_enclosure_component(struct device *dev)
115*4882a593Smuzhiyun {
116*4882a593Smuzhiyun return container_of(dev, struct enclosure_component, cdev);
117*4882a593Smuzhiyun }
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun struct enclosure_device *
120*4882a593Smuzhiyun enclosure_register(struct device *, const char *, int,
121*4882a593Smuzhiyun struct enclosure_component_callbacks *);
122*4882a593Smuzhiyun void enclosure_unregister(struct enclosure_device *);
123*4882a593Smuzhiyun struct enclosure_component *
124*4882a593Smuzhiyun enclosure_component_alloc(struct enclosure_device *, unsigned int,
125*4882a593Smuzhiyun enum enclosure_component_type, const char *);
126*4882a593Smuzhiyun int enclosure_component_register(struct enclosure_component *);
127*4882a593Smuzhiyun int enclosure_add_device(struct enclosure_device *enclosure, int component,
128*4882a593Smuzhiyun struct device *dev);
129*4882a593Smuzhiyun int enclosure_remove_device(struct enclosure_device *, struct device *);
130*4882a593Smuzhiyun struct enclosure_device *enclosure_find(struct device *dev,
131*4882a593Smuzhiyun struct enclosure_device *start);
132*4882a593Smuzhiyun int enclosure_for_each_device(int (*fn)(struct enclosure_device *, void *),
133*4882a593Smuzhiyun void *data);
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun #endif /* _LINUX_ENCLOSURE_H_ */
136