chandev.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:10k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*
  2.  *  include/asm-s390/chandev.h
  3.  *
  4.  *    Copyright (C) 2000 IBM Deutschland Entwicklung GmbH, IBM Corporation
  5.  *    Author(s): Denis Joseph Barrow (djbarrow@de.ibm.com,barrow_dj@yahoo.com)
  6.  * 
  7.  *  Generic channel device initialisation support. 
  8.  */
  9. #ifndef __S390_CHANDEV_H
  10. #define __S390_CHANDEV_H
  11. #include <linux/version.h>
  12. #include <asm/types.h>
  13. #include <linux/netdevice.h>
  14. /* Setting this flag to true causes a device name to be built based on the read_devno of the device */
  15. /* this is exported so external code can look at this flags setting */
  16. extern int chandev_use_devno_names;
  17. /* chandev_type is a bitmask for registering & describing device types. */
  18. typedef enum
  19. {
  20. chandev_type_none=0x0,
  21. chandev_type_ctc=0x1,
  22. chandev_type_escon=0x2,
  23. chandev_type_lcs=0x4,
  24. chandev_type_osad=0x8,
  25. chandev_type_qeth=0x10,
  26. chandev_type_claw=0x20,
  27. } chandev_type;
  28. typedef enum
  29. {
  30. chandev_category_none,
  31. chandev_category_network_device,
  32. chandev_category_serial_device,
  33. } chandev_category;
  34. typedef struct
  35. {
  36. int     irq;
  37. u16     devno;
  38. u16     cu_type;      /* control unit type */
  39. u8      cu_model;     /* control unit model */
  40. u16     dev_type;     /* device type */
  41. u8      dev_model;    /* device model */
  42. u8      pim;          /* path installed mask */
  43. u8      chpid[8];     /* CHPID 0-7 (if available) */
  44. } chandev_subchannel_info;
  45. #define CLAW_NAMELEN 9
  46. /* CLAW specific parameters other drivers should ignore these fields */
  47. typedef struct
  48. {
  49. char  host_name[CLAW_NAMELEN];    /* local host name */
  50. char  adapter_name[CLAW_NAMELEN]; /* workstation adapter name */
  51. char  api_type[CLAW_NAMELEN];     /* API type either TCPIP or API */
  52. } chandev_claw_info;
  53. /*
  54.  * The chandev_probeinfo structure is passed to the device driver with configuration
  55.  * info for which irq's & ports to use when attempting to probe the device.
  56.  */
  57. typedef struct
  58. {
  59. chandev_subchannel_info read;
  60. chandev_subchannel_info write;
  61. chandev_subchannel_info data;
  62. /* memory_usage_in_k is the suggested memory the driver should attempt to use for io */
  63. /* buffers -1 means use the driver default the driver should set this field to the */
  64. /* amount of memory it actually uses when returning this probeinfo to the channel */
  65. /* device layer with chandev_initdevice */
  66. s32     memory_usage_in_k;
  67. chandev_claw_info       claw;
  68. u8      data_exists; /* whether this device has a data channel */
  69. u8      cu_dev_info_inconsistent; /* either ctc or we possibly had a bad sense_id */
  70. u8      chpid_info_inconsistent;  /* either ctc or schib info bad */
  71.         s16     port_protocol_no; /* 0 by default, set specifically when forcing */
  72. u8      hint_port_no;   /* lcs specific */
  73. u8      max_port_no;    /* lcs/qeth specific */
  74. chandev_type chan_type;
  75. u8      checksum_received_ip_pkts;
  76. u8      use_hw_stats; /* where available e.g. lcs */
  77. u8      device_forced; /* indicates the device hasn't been autodetected */
  78. char    *parmstr;       /* driver specific parameters added by add_parms keyword */
  79. /* newdevice used internally by chandev.c */
  80. struct  chandev_activelist *newdevice; 
  81. s32     devif_num; 
  82. /* devif_num=-1 implies don't care,0 implies tr0, info used by chandev_initnetdevice */
  83. } chandev_probeinfo;
  84. /*
  85.  * This is a wrapper to the machine check handler & should be used
  86.  * instead of reqest_irq or s390_request_irq_special for anything
  87.  * using the channel device layer.
  88.  */
  89. int chandev_request_irq(unsigned int   irq,
  90.                       void           (*handler)(int, void *, struct pt_regs *),
  91.                       unsigned long  irqflags,
  92.                       const char    *devname,
  93.                       void          *dev_id);
  94. /*
  95.  * I originally believed this function wouldn't be necessary
  96.  * I subsequently found that reprobing failed in certain cases :-(,
  97.  * It is just a wrapper for free irq.
  98.  */
  99. void chandev_free_irq(unsigned int irq, void *dev_id);
  100. typedef enum
  101. {
  102. chandev_status_good,
  103. chandev_status_not_oper,
  104. chandev_status_first_msck=chandev_status_not_oper,
  105. chandev_status_no_path,
  106. chandev_status_revalidate,
  107. chandev_status_gone,
  108. chandev_status_last_msck,
  109. chandev_status_all_chans_good /* pseudo machine check to indicate all channels are healthy */
  110. } chandev_msck_status;
  111. typedef int (*chandev_probefunc)(chandev_probeinfo *probeinfo);
  112. typedef int (*chandev_shutdownfunc)(void *device);
  113. typedef void (*chandev_unregfunc)(void *device);
  114. typedef void (*chandev_msck_notification_func)(void *device,int msck_irq,
  115. chandev_msck_status prevstatus,chandev_msck_status newstatus);
  116. /* A driver should call chandev_register_and_probe when ready to be probed,
  117.  * after registeration the drivers probefunction will be called asynchronously
  118.  * when more devices become available at normal task time.
  119.  * The shutdownfunc parameter is used so that the channel layer
  120.  * can request a driver to close unregister itself & release its interrupts.
  121.  * repoper func is used when a device becomes operational again after being temporarily
  122.  * not operational the previous status is sent in the prevstatus variable.
  123.  * This can be used in cases when the default handling isn't quite adequete
  124.  * e.g. if a ssch is needed to reinitialize long running channel programs.
  125.  *
  126.  * This returns the number of devices found or -ENOMEM if the code didn't
  127.  * have enough memory to allocate the chandev control block
  128.  * or -EPERM if a duplicate entry is found.
  129.  */
  130. int chandev_register_and_probe(chandev_probefunc probefunc,
  131.        chandev_shutdownfunc shutdownfunc,
  132.        chandev_msck_notification_func msck_notfunc,
  133.        chandev_type chan_type);
  134. /* The chandev_unregister function is typically called when a module is being removed 
  135.  * from the system. The shutdown parameter if TRUE calls shutdownfunc for each 
  136.  * device instance so the driver writer doesn't have to.
  137.  */
  138. void chandev_unregister(chandev_probefunc probefunc,int call_shutdown);
  139. /* chandev_initdevice should be called immeadiately before returning after */
  140. /* a successful probe. */
  141. int chandev_initdevice(chandev_probeinfo *probeinfo,void *dev_ptr,u8 port_no,char *devname,
  142. chandev_category category,chandev_unregfunc unreg_dev);
  143. /* This function builds a device name & copies it into destnamebuff suitable for calling 
  144.    init_trdev or whatever & it honours the use_devno_names flag, it is used by chandev_initnetdevice 
  145.    setting the buildfullname flag to TRUE will cause it to always build a full unique name based 
  146.    on basename either honouring the chandev_use_devno_names flag if set or starting at index 
  147.    0 & checking the namespace of the channel device layer itself for a free index, this
  148.    may be useful when one doesn't have control of the name an upper layer may choose.
  149.    It returns NULL on error.
  150. */
  151. char *chandev_build_device_name(chandev_probeinfo *probeinfo,char *destnamebuff,char *basename,int buildfullname);
  152. /* chandev_init_netdev registers with the normal network device layer */
  153. /* it doesn't update any of the chandev internal structures. */
  154. /* i.e. it is optional */
  155. /* it was part of chandev_initnetdevice but I separated it as */
  156. /* chandev_initnetdevice may make too many assumptions for some users */
  157. /* chandev_initnetdevice = chandev_initdevice followed by chandev_init_netdev */
  158. #if LINUX_VERSION_CODE>=KERNEL_VERSION(2,3,0)
  159. struct net_device *chandev_init_netdev(chandev_probeinfo *probeinfo,char *basename,
  160. struct net_device *dev, int sizeof_priv,struct net_device *(*init_netdevfunc)(struct net_device *dev, int sizeof_priv));
  161. #else
  162. struct device *chandev_init_netdev(chandev_probeinfo *probeinfo,char *basename,
  163. struct device *dev, int sizeof_priv,struct device *(*init_netdevfunc)(struct device *dev, int sizeof_priv));
  164. #endif
  165. /* chandev_initnetdevice registers a network device with the channel layer. 
  166.  * It returns the device structure if successful,if dev=NULL it kmallocs it, 
  167.  * On device initialisation failure it will kfree it under ALL curcumstances
  168.  * i.e. if dev is not NULL on entering this routine it MUST be malloced with kmalloc. 
  169.  * The base name is tr ( e.g. tr0 without the 0 ), for token ring eth for ethernet,
  170.  *  ctc or escon for ctc device drivers.
  171.  * If valid function pointers are given they will be called to setup,
  172.  * register & unregister the device. 
  173.  * An example of setup is eth_setup in drivers/net/net_init.c.
  174.  * An example of init_dev is init_trdev(struct net_device *dev)
  175.  * & an example of unregister is unregister_trdev, 
  176.  * unregister_netdev should be used for escon & ctc
  177.  * as there is no network unregister_ctcdev in the kernel.
  178. */
  179. #if LINUX_VERSION_CODE>=KERNEL_VERSION(2,3,0)
  180. struct net_device *chandev_initnetdevice(chandev_probeinfo *probeinfo,u8 port_no,
  181.  struct net_device *dev,int sizeof_priv, 
  182.  char *basename, 
  183.  struct net_device *(*init_netdevfunc)
  184.  (struct net_device *dev, int sizeof_priv),
  185.  void (*unreg_netdevfunc)(struct net_device *dev));
  186. #else
  187. struct device *chandev_initnetdevice(chandev_probeinfo *probeinfo,u8 port_no,
  188.      struct device *dev,int sizeof_priv,
  189.      char *basename, 
  190.      struct device *(*init_netdevfunc)
  191.      (struct device *dev, int sizeof_priv),
  192.      void (*unreg_netdevfunc)(struct device *dev));
  193. #endif
  194. /* chandev_add & delete model shouldn't normally be needed by drivers except if */
  195. /* someone is developing a driver which the channel device layer doesn't know about */
  196. void chandev_add_model(chandev_type chan_type,s32 cu_type,s16 cu_model,
  197.        s32 dev_type,s16 dev_model,u8 max_port_no,int auto_msck_recovery,
  198.         u8 default_checksum_received_ip_pkts,u8 default_use_hw_stats);
  199. void chandev_del_model(s32 cu_type,s16 cu_model,s32 dev_type,s16 dev_model);
  200. /* modules should use chandev_persist to see if they should stay loaded */
  201. /* this is useful for debugging purposes where you may wish to examine */
  202. /* /proc/s390dbf/ entries */
  203. int chandev_persist(chandev_type chan_type);
  204. #endif /* __S390_CHANDEV_H */