pnp.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * Linux Plug and Play Support
  4. * Copyright by Adam Belay <ambx1@neo.rr.com>
  5. * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
  6. * Bjorn Helgaas <bjorn.helgaas@hp.com>
  7. */
  8. #ifndef _LINUX_PNP_H
  9. #define _LINUX_PNP_H
  10. #include <linux/device.h>
  11. #include <linux/list.h>
  12. #include <linux/errno.h>
  13. #include <linux/mod_devicetable.h>
  14. #include <linux/console.h>
  15. #define PNP_NAME_LEN 50
  16. struct pnp_protocol;
  17. struct pnp_dev;
  18. /*
  19. * Resource Management
  20. */
  21. #ifdef CONFIG_PNP
  22. struct resource *pnp_get_resource(struct pnp_dev *dev, unsigned long type,
  23. unsigned int num);
  24. #else
  25. static inline struct resource *pnp_get_resource(struct pnp_dev *dev,
  26. unsigned long type, unsigned int num)
  27. {
  28. return NULL;
  29. }
  30. #endif
  31. static inline int pnp_resource_valid(struct resource *res)
  32. {
  33. if (res)
  34. return 1;
  35. return 0;
  36. }
  37. static inline int pnp_resource_enabled(struct resource *res)
  38. {
  39. if (res && !(res->flags & IORESOURCE_DISABLED))
  40. return 1;
  41. return 0;
  42. }
  43. static inline resource_size_t pnp_resource_len(struct resource *res)
  44. {
  45. if (res->start == 0 && res->end == 0)
  46. return 0;
  47. return resource_size(res);
  48. }
  49. static inline resource_size_t pnp_port_start(struct pnp_dev *dev,
  50. unsigned int bar)
  51. {
  52. struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  53. if (pnp_resource_valid(res))
  54. return res->start;
  55. return 0;
  56. }
  57. static inline resource_size_t pnp_port_end(struct pnp_dev *dev,
  58. unsigned int bar)
  59. {
  60. struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  61. if (pnp_resource_valid(res))
  62. return res->end;
  63. return 0;
  64. }
  65. static inline unsigned long pnp_port_flags(struct pnp_dev *dev,
  66. unsigned int bar)
  67. {
  68. struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  69. if (pnp_resource_valid(res))
  70. return res->flags;
  71. return IORESOURCE_IO | IORESOURCE_AUTO;
  72. }
  73. static inline int pnp_port_valid(struct pnp_dev *dev, unsigned int bar)
  74. {
  75. return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IO, bar));
  76. }
  77. static inline resource_size_t pnp_port_len(struct pnp_dev *dev,
  78. unsigned int bar)
  79. {
  80. struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
  81. if (pnp_resource_valid(res))
  82. return pnp_resource_len(res);
  83. return 0;
  84. }
  85. static inline resource_size_t pnp_mem_start(struct pnp_dev *dev,
  86. unsigned int bar)
  87. {
  88. struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
  89. if (pnp_resource_valid(res))
  90. return res->start;
  91. return 0;
  92. }
  93. static inline resource_size_t pnp_mem_end(struct pnp_dev *dev,
  94. unsigned int bar)
  95. {
  96. struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
  97. if (pnp_resource_valid(res))
  98. return res->end;
  99. return 0;
  100. }
  101. static inline unsigned long pnp_mem_flags(struct pnp_dev *dev, unsigned int bar)
  102. {
  103. struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
  104. if (pnp_resource_valid(res))
  105. return res->flags;
  106. return IORESOURCE_MEM | IORESOURCE_AUTO;
  107. }
  108. static inline int pnp_mem_valid(struct pnp_dev *dev, unsigned int bar)
  109. {
  110. return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_MEM, bar));
  111. }
  112. static inline resource_size_t pnp_mem_len(struct pnp_dev *dev,
  113. unsigned int bar)
  114. {
  115. struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
  116. if (pnp_resource_valid(res))
  117. return pnp_resource_len(res);
  118. return 0;
  119. }
  120. static inline resource_size_t pnp_irq(struct pnp_dev *dev, unsigned int bar)
  121. {
  122. struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
  123. if (pnp_resource_valid(res))
  124. return res->start;
  125. return -1;
  126. }
  127. static inline unsigned long pnp_irq_flags(struct pnp_dev *dev, unsigned int bar)
  128. {
  129. struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
  130. if (pnp_resource_valid(res))
  131. return res->flags;
  132. return IORESOURCE_IRQ | IORESOURCE_AUTO;
  133. }
  134. static inline int pnp_irq_valid(struct pnp_dev *dev, unsigned int bar)
  135. {
  136. return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IRQ, bar));
  137. }
  138. static inline resource_size_t pnp_dma(struct pnp_dev *dev, unsigned int bar)
  139. {
  140. struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
  141. if (pnp_resource_valid(res))
  142. return res->start;
  143. return -1;
  144. }
  145. static inline unsigned long pnp_dma_flags(struct pnp_dev *dev, unsigned int bar)
  146. {
  147. struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
  148. if (pnp_resource_valid(res))
  149. return res->flags;
  150. return IORESOURCE_DMA | IORESOURCE_AUTO;
  151. }
  152. static inline int pnp_dma_valid(struct pnp_dev *dev, unsigned int bar)
  153. {
  154. return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_DMA, bar));
  155. }
  156. /*
  157. * Device Management
  158. */
  159. struct pnp_card {
  160. struct device dev; /* Driver Model device interface */
  161. unsigned char number; /* used as an index, must be unique */
  162. struct list_head global_list; /* node in global list of cards */
  163. struct list_head protocol_list; /* node in protocol's list of cards */
  164. struct list_head devices; /* devices attached to the card */
  165. struct pnp_protocol *protocol;
  166. struct pnp_id *id; /* contains supported EISA IDs */
  167. char name[PNP_NAME_LEN]; /* contains a human-readable name */
  168. unsigned char pnpver; /* Plug & Play version */
  169. unsigned char productver; /* product version */
  170. unsigned int serial; /* serial number */
  171. unsigned char checksum; /* if zero - checksum passed */
  172. struct proc_dir_entry *procdir; /* directory entry in /proc/bus/isapnp */
  173. };
  174. #define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)
  175. #define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)
  176. #define to_pnp_card(n) container_of(n, struct pnp_card, dev)
  177. #define pnp_for_each_card(card) \
  178. list_for_each_entry(card, &pnp_cards, global_list)
  179. struct pnp_card_link {
  180. struct pnp_card *card;
  181. struct pnp_card_driver *driver;
  182. void *driver_data;
  183. pm_message_t pm_state;
  184. };
  185. static inline void *pnp_get_card_drvdata(struct pnp_card_link *pcard)
  186. {
  187. return pcard->driver_data;
  188. }
  189. static inline void pnp_set_card_drvdata(struct pnp_card_link *pcard, void *data)
  190. {
  191. pcard->driver_data = data;
  192. }
  193. struct pnp_dev {
  194. struct device dev; /* Driver Model device interface */
  195. u64 dma_mask;
  196. unsigned int number; /* used as an index, must be unique */
  197. int status;
  198. struct list_head global_list; /* node in global list of devices */
  199. struct list_head protocol_list; /* node in list of device's protocol */
  200. struct list_head card_list; /* node in card's list of devices */
  201. struct list_head rdev_list; /* node in cards list of requested devices */
  202. struct pnp_protocol *protocol;
  203. struct pnp_card *card; /* card the device is attached to, none if NULL */
  204. struct pnp_driver *driver;
  205. struct pnp_card_link *card_link;
  206. struct pnp_id *id; /* supported EISA IDs */
  207. int active;
  208. int capabilities;
  209. unsigned int num_dependent_sets;
  210. struct list_head resources;
  211. struct list_head options;
  212. char name[PNP_NAME_LEN]; /* contains a human-readable name */
  213. int flags; /* used by protocols */
  214. struct proc_dir_entry *procent; /* device entry in /proc/bus/isapnp */
  215. void *data;
  216. };
  217. #define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)
  218. #define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)
  219. #define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)
  220. #define to_pnp_dev(n) container_of(n, struct pnp_dev, dev)
  221. #define pnp_for_each_dev(dev) list_for_each_entry(dev, &pnp_global, global_list)
  222. #define card_for_each_dev(card, dev) \
  223. list_for_each_entry(dev, &(card)->devices, card_list)
  224. #define pnp_dev_name(dev) (dev)->name
  225. static inline void *pnp_get_drvdata(struct pnp_dev *pdev)
  226. {
  227. return dev_get_drvdata(&pdev->dev);
  228. }
  229. static inline void pnp_set_drvdata(struct pnp_dev *pdev, void *data)
  230. {
  231. dev_set_drvdata(&pdev->dev, data);
  232. }
  233. struct pnp_fixup {
  234. char id[7];
  235. void (*quirk_function) (struct pnp_dev * dev); /* fixup function */
  236. };
  237. /* config parameters */
  238. #define PNP_CONFIG_NORMAL 0x0001
  239. #define PNP_CONFIG_FORCE 0x0002 /* disables validity checking */
  240. /* capabilities */
  241. #define PNP_READ 0x0001
  242. #define PNP_WRITE 0x0002
  243. #define PNP_DISABLE 0x0004
  244. #define PNP_CONFIGURABLE 0x0008
  245. #define PNP_REMOVABLE 0x0010
  246. #define PNP_CONSOLE 0x0020
  247. #define pnp_can_read(dev) (((dev)->protocol->get) && \
  248. ((dev)->capabilities & PNP_READ))
  249. #define pnp_can_write(dev) (((dev)->protocol->set) && \
  250. ((dev)->capabilities & PNP_WRITE))
  251. #define pnp_can_disable(dev) (((dev)->protocol->disable) && \
  252. ((dev)->capabilities & PNP_DISABLE) && \
  253. (!((dev)->capabilities & PNP_CONSOLE) || \
  254. console_suspend_enabled))
  255. #define pnp_can_configure(dev) ((!(dev)->active) && \
  256. ((dev)->capabilities & PNP_CONFIGURABLE))
  257. #define pnp_can_suspend(dev) (((dev)->protocol->suspend) && \
  258. (!((dev)->capabilities & PNP_CONSOLE) || \
  259. console_suspend_enabled))
  260. #ifdef CONFIG_ISAPNP
  261. extern struct pnp_protocol isapnp_protocol;
  262. #define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))
  263. #else
  264. #define pnp_device_is_isapnp(dev) 0
  265. #endif
  266. extern struct mutex pnp_res_mutex;
  267. #ifdef CONFIG_PNPBIOS
  268. extern struct pnp_protocol pnpbios_protocol;
  269. extern bool arch_pnpbios_disabled(void);
  270. #define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
  271. #else
  272. #define pnp_device_is_pnpbios(dev) 0
  273. #define arch_pnpbios_disabled() false
  274. #endif
  275. #ifdef CONFIG_PNPACPI
  276. extern struct pnp_protocol pnpacpi_protocol;
  277. static inline struct acpi_device *pnp_acpi_device(struct pnp_dev *dev)
  278. {
  279. if (dev->protocol == &pnpacpi_protocol)
  280. return dev->data;
  281. return NULL;
  282. }
  283. #else
  284. #define pnp_acpi_device(dev) 0
  285. #endif
  286. /* status */
  287. #define PNP_READY 0x0000
  288. #define PNP_ATTACHED 0x0001
  289. #define PNP_BUSY 0x0002
  290. #define PNP_FAULTY 0x0004
  291. /* isapnp specific macros */
  292. #define isapnp_card_number(dev) ((dev)->card ? (dev)->card->number : -1)
  293. #define isapnp_csn_number(dev) ((dev)->number)
  294. /*
  295. * Driver Management
  296. */
  297. struct pnp_id {
  298. char id[PNP_ID_LEN];
  299. struct pnp_id *next;
  300. };
  301. struct pnp_driver {
  302. const char *name;
  303. const struct pnp_device_id *id_table;
  304. unsigned int flags;
  305. int (*probe) (struct pnp_dev *dev, const struct pnp_device_id *dev_id);
  306. void (*remove) (struct pnp_dev *dev);
  307. void (*shutdown) (struct pnp_dev *dev);
  308. int (*suspend) (struct pnp_dev *dev, pm_message_t state);
  309. int (*resume) (struct pnp_dev *dev);
  310. struct device_driver driver;
  311. };
  312. #define to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)
  313. struct pnp_card_driver {
  314. struct list_head global_list;
  315. char *name;
  316. const struct pnp_card_device_id *id_table;
  317. unsigned int flags;
  318. int (*probe) (struct pnp_card_link *card,
  319. const struct pnp_card_device_id *card_id);
  320. void (*remove) (struct pnp_card_link *card);
  321. int (*suspend) (struct pnp_card_link *card, pm_message_t state);
  322. int (*resume) (struct pnp_card_link *card);
  323. struct pnp_driver link;
  324. };
  325. #define to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)
  326. /* pnp driver flags */
  327. #define PNP_DRIVER_RES_DO_NOT_CHANGE 0x0001 /* do not change the state of the device */
  328. #define PNP_DRIVER_RES_DISABLE 0x0003 /* ensure the device is disabled */
  329. /*
  330. * Protocol Management
  331. */
  332. struct pnp_protocol {
  333. struct list_head protocol_list;
  334. char *name;
  335. /* resource control functions */
  336. int (*get) (struct pnp_dev *dev);
  337. int (*set) (struct pnp_dev *dev);
  338. int (*disable) (struct pnp_dev *dev);
  339. /* protocol specific suspend/resume */
  340. bool (*can_wakeup) (struct pnp_dev *dev);
  341. int (*suspend) (struct pnp_dev * dev, pm_message_t state);
  342. int (*resume) (struct pnp_dev * dev);
  343. /* used by pnp layer only (look but don't touch) */
  344. unsigned char number; /* protocol number */
  345. struct device dev; /* link to driver model */
  346. struct list_head cards;
  347. struct list_head devices;
  348. };
  349. #define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)
  350. #define protocol_for_each_card(protocol, card) \
  351. list_for_each_entry(card, &(protocol)->cards, protocol_list)
  352. #define protocol_for_each_dev(protocol, dev) \
  353. list_for_each_entry(dev, &(protocol)->devices, protocol_list)
  354. extern struct bus_type pnp_bus_type;
  355. #if defined(CONFIG_PNP)
  356. /* device management */
  357. int pnp_device_attach(struct pnp_dev *pnp_dev);
  358. void pnp_device_detach(struct pnp_dev *pnp_dev);
  359. extern struct list_head pnp_global;
  360. extern int pnp_platform_devices;
  361. /* multidevice card support */
  362. struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink,
  363. const char *id, struct pnp_dev *from);
  364. void pnp_release_card_device(struct pnp_dev *dev);
  365. int pnp_register_card_driver(struct pnp_card_driver *drv);
  366. void pnp_unregister_card_driver(struct pnp_card_driver *drv);
  367. extern struct list_head pnp_cards;
  368. /* resource management */
  369. int pnp_possible_config(struct pnp_dev *dev, int type, resource_size_t base,
  370. resource_size_t size);
  371. int pnp_auto_config_dev(struct pnp_dev *dev);
  372. int pnp_start_dev(struct pnp_dev *dev);
  373. int pnp_stop_dev(struct pnp_dev *dev);
  374. int pnp_activate_dev(struct pnp_dev *dev);
  375. int pnp_disable_dev(struct pnp_dev *dev);
  376. int pnp_range_reserved(resource_size_t start, resource_size_t end);
  377. /* protocol helpers */
  378. int pnp_is_active(struct pnp_dev *dev);
  379. int compare_pnp_id(struct pnp_id *pos, const char *id);
  380. int pnp_register_driver(struct pnp_driver *drv);
  381. void pnp_unregister_driver(struct pnp_driver *drv);
  382. #else
  383. /* device management */
  384. static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }
  385. static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { }
  386. #define pnp_platform_devices 0
  387. /* multidevice card support */
  388. static inline struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink, const char *id, struct pnp_dev *from) { return NULL; }
  389. static inline void pnp_release_card_device(struct pnp_dev *dev) { }
  390. static inline int pnp_register_card_driver(struct pnp_card_driver *drv) { return -ENODEV; }
  391. static inline void pnp_unregister_card_driver(struct pnp_card_driver *drv) { }
  392. /* resource management */
  393. static inline int pnp_possible_config(struct pnp_dev *dev, int type,
  394. resource_size_t base,
  395. resource_size_t size) { return 0; }
  396. static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
  397. static inline int pnp_start_dev(struct pnp_dev *dev) { return -ENODEV; }
  398. static inline int pnp_stop_dev(struct pnp_dev *dev) { return -ENODEV; }
  399. static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }
  400. static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }
  401. static inline int pnp_range_reserved(resource_size_t start, resource_size_t end) { return 0;}
  402. /* protocol helpers */
  403. static inline int pnp_is_active(struct pnp_dev *dev) { return 0; }
  404. static inline int compare_pnp_id(struct pnp_id *pos, const char *id) { return -ENODEV; }
  405. static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }
  406. static inline void pnp_unregister_driver(struct pnp_driver *drv) { }
  407. #endif /* CONFIG_PNP */
  408. /**
  409. * module_pnp_driver() - Helper macro for registering a PnP driver
  410. * @__pnp_driver: pnp_driver struct
  411. *
  412. * Helper macro for PnP drivers which do not do anything special in module
  413. * init/exit. This eliminates a lot of boilerplate. Each module may only
  414. * use this macro once, and calling it replaces module_init() and module_exit()
  415. */
  416. #define module_pnp_driver(__pnp_driver) \
  417. module_driver(__pnp_driver, pnp_register_driver, \
  418. pnp_unregister_driver)
  419. #endif /* _LINUX_PNP_H */