ioerror.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:7k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /* $Id$
  2.  *
  3.  * This file is subject to the terms and conditions of the GNU General Public
  4.  * License.  See the file "COPYING" in the main directory of this archive
  5.  * for more details.
  6.  *
  7.  * Copyright (C) 1992 - 1997, 2000 Silicon Graphics, Inc.
  8.  * Copyright (C) 2000 by Colin Ngam
  9.  */
  10. #ifndef _ASM_SN_IOERROR_H
  11. #define _ASM_SN_IOERROR_H
  12. #if defined(_LANGUAGE_C) || defined(_LANGUAGE_C_PLUS_PLUS)
  13. /*
  14.  * Macros defining the various Errors to be handled as part of
  15.  * IO Error handling.
  16.  */
  17. /*
  18.  * List of errors to be handled by each subsystem.
  19.  * "error_code" field will take one of these values.
  20.  * The error code is built up of single bits expressing
  21.  * our confidence that the error was that type; note
  22.  * that it is possible to have a PIO or DMA error where
  23.  * we don't know whether it was a READ or a WRITE, or
  24.  * even a READ or WRITE error that we're not sure whether
  25.  * to call a PIO or DMA.
  26.  *
  27.  * It is also possible to set both PIO and DMA, and possible
  28.  * to set both READ and WRITE; the first may be nonsensical
  29.  * but the second *could* be used to designate an access
  30.  * that is known to be a read-modify-write cycle. It is
  31.  * quite possible that nobody will ever use PIO|DMA or
  32.  * READ|WRITE ... but being flexible is good.
  33.  */
  34. #define IOECODE_UNSPEC 0
  35. #define IOECODE_READ 1
  36. #define IOECODE_WRITE 2
  37. #define IOECODE_PIO 4
  38. #define IOECODE_DMA 8
  39. #define IOECODE_PIO_READ (IOECODE_PIO|IOECODE_READ)
  40. #define IOECODE_PIO_WRITE (IOECODE_PIO|IOECODE_WRITE)
  41. #define IOECODE_DMA_READ (IOECODE_DMA|IOECODE_READ)
  42. #define IOECODE_DMA_WRITE (IOECODE_DMA|IOECODE_WRITE)
  43. /* support older names, but try to move everything
  44.  * to using new names that identify which package
  45.  * controls their values ...
  46.  */
  47. #define PIO_READ_ERROR IOECODE_PIO_READ
  48. #define PIO_WRITE_ERROR IOECODE_PIO_WRITE
  49. #define DMA_READ_ERROR IOECODE_DMA_READ
  50. #define DMA_WRITE_ERROR IOECODE_DMA_WRITE
  51. /*
  52.  * List of error numbers returned by error handling sub-system.
  53.  */
  54. #define IOERROR_HANDLED 0 /* Error Properly handled.        */
  55. #define IOERROR_NODEV 0x1 /* No such device attached        */
  56. #define IOERROR_BADHANDLE 0x2 /* Received bad handle            */
  57. #define IOERROR_BADWIDGETNUM 0x3 /* Bad widget number              */
  58. #define IOERROR_BADERRORCODE 0x4 /* Bad error code passed in       */
  59. #define IOERROR_INVALIDADDR 0x5 /* Invalid address specified      */
  60. #define IOERROR_WIDGETLEVEL 0x6 /* Some failure at widget level    */
  61. #define IOERROR_XTALKLEVEL 0x7
  62. #define IOERROR_HWGRAPH_LOOKUP 0x8 /* hwgraph lookup failed for path  */
  63. #define IOERROR_UNHANDLED 0x9 /* handler rejected error          */
  64. #define IOERROR_PANIC 0xA /* subsidiary handler has already
  65.  * started decode: continue error
  66.  * data dump, and panic from top
  67.  * caller in error chain.
  68.  */
  69. /*
  70.  * IO errors at the bus/device driver level
  71.  */
  72. #define IOERROR_DEV_NOTFOUND 0x10 /* Device matching bus addr not found */
  73. #define IOERROR_DEV_SHUTDOWN 0x11 /* Device has been shutdown        */
  74. /*
  75.  * Type of address.
  76.  * Indicates the direction of transfer that caused the error.
  77.  */
  78. #define IOERROR_ADDR_PIO 1 /* Error Address generated due to PIO */
  79. #define IOERROR_ADDR_DMA 2 /* Error address generated due to DMA */
  80. /*
  81.  * IO error structure.
  82.  *
  83.  * This structure would expand to hold the information retrieved from
  84.  * all IO related error registers.
  85.  *
  86.  * This structure is defined to hold all system specific
  87.  * information related to a single error.
  88.  *
  89.  * This serves a couple of purpose.
  90.  *      - Error handling often involves translating one form of address to other
  91.  *        form. So, instead of having different data structures at each level,
  92.  *        we have a single structure, and the appropriate fields get filled in
  93.  *        at each layer.
  94.  *      - This provides a way to dump all error related information in any layer
  95.  *        of erorr handling (debugging aid).
  96.  *
  97.  * A second possibility is to allow each layer to define its own error
  98.  * data structure, and fill in the proper fields. This has the advantage
  99.  * of isolating the layers.
  100.  * A big concern is the potential stack usage (and overflow), if each layer
  101.  * defines these structures on stack (assuming we don't want to do kmalloc.
  102.  *
  103.  * Any layer wishing to pass extra information to a layer next to it in
  104.  * error handling hierarchy, can do so as a separate parameter.
  105.  */
  106. typedef struct io_error_s {
  107.     /* Bit fields indicating which sturcture fields are valid */
  108.     union {
  109. struct {
  110.     unsigned                ievb_errortype:1;
  111.     unsigned                ievb_widgetnum:1;
  112.     unsigned                ievb_widgetdev:1;
  113.     unsigned                ievb_srccpu:1;
  114.     unsigned                ievb_srcnode:1;
  115.     unsigned                ievb_errnode:1;
  116.     unsigned                ievb_sysioaddr:1;
  117.     unsigned                ievb_xtalkaddr:1;
  118.     unsigned                ievb_busspace:1;
  119.     unsigned                ievb_busaddr:1;
  120.     unsigned                ievb_vaddr:1;
  121.     unsigned                ievb_memaddr:1;
  122.     unsigned     ievb_epc:1;
  123.     unsigned     ievb_ef:1;
  124. } iev_b;
  125. unsigned                iev_a;
  126.     } ie_v;
  127.     short                   ie_errortype; /* error type: extra info about error */
  128.     short                   ie_widgetnum; /* Widget number that's in error */
  129.     short                   ie_widgetdev; /* Device within widget in error */
  130.     cpuid_t                 ie_srccpu; /* CPU on srcnode generating error */
  131.     cnodeid_t               ie_srcnode; /* Node which caused the error   */
  132.     cnodeid_t               ie_errnode; /* Node where error was noticed  */
  133.     iopaddr_t               ie_sysioaddr; /* Sys specific IO address       */
  134.     iopaddr_t               ie_xtalkaddr; /* Xtalk (48bit) addr of Error   */
  135.     iopaddr_t               ie_busspace; /* Bus specific address space    */
  136.     iopaddr_t               ie_busaddr; /* Bus specific address          */
  137.     caddr_t                 ie_vaddr; /* Virtual address of error      */
  138.     paddr_t                 ie_memaddr; /* Physical memory address       */
  139.     caddr_t     ie_epc; /* pc when error reported  */
  140.     caddr_t     ie_ef; /* eframe when error reported  */
  141. } ioerror_t;
  142. #define IOERROR_INIT(e) do { (e)->ie_v.iev_a = 0; } while (0)
  143. #define IOERROR_SETVALUE(e,f,v) do { (e)->ie_ ## f = (v); (e)->ie_v.iev_b.ievb_ ## f = 1; } while (0)
  144. #define IOERROR_FIELDVALID(e,f) (((e)->ie_v.iev_b.ievb_ ## f) != 0)
  145. #define IOERROR_GETVALUE(e,f) (ASSERT(IOERROR_FIELDVALID(e,f)),((e)->ie_ ## f))
  146. #if IP27 || IP35
  147. /* hub code likes to call the SysAD address "hubaddr" ... */
  148. #define ie_hubaddr ie_sysioaddr
  149. #define ievb_hubaddr ievb_sysioaddr
  150. #endif
  151. /*
  152.  * Error handling Modes.
  153.  */
  154. typedef enum {
  155.     MODE_DEVPROBE, /* Probing mode. Errors not fatal */
  156.     MODE_DEVERROR, /* Error while system is running */
  157.     MODE_DEVUSERERROR, /* Device Error created due to user mode access */
  158.     MODE_DEVREENABLE /* Reenable pass                */
  159. } ioerror_mode_t;
  160. #endif /* C || C++ */
  161. typedef int             error_handler_f(void *, int, ioerror_mode_t, ioerror_t *);
  162. typedef void           *error_handler_arg_t;
  163. extern void             ioerror_dump(char *, int, int, ioerror_t *);
  164. #ifdef ERROR_DEBUG
  165. #define IOERROR_DUMP(x, y, z, t) ioerror_dump((x), (y), (z), (t))
  166. #define IOERR_PRINTF(x) (x)
  167. #else
  168. #define IOERROR_DUMP(x, y, z, t)
  169. #define IOERR_PRINTF(x)
  170. #endif /* ERROR_DEBUG */
  171. #endif /* _ASM_SN_IOERROR_H */