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

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*
  2.  * HP Human Interface Loop Master Link Controller driver.
  3.  *
  4.  * Copyright (c) 2001 Brian S. Julin
  5.  * All rights reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 1. Redistributions of source code must retain the above copyright
  11.  *    notice, this list of conditions, and the following disclaimer,
  12.  *    without modification.
  13.  * 2. The name of the author may not be used to endorse or promote products
  14.  *    derived from this software without specific prior written permission.
  15.  *
  16.  * Alternatively, this software may be distributed under the terms of the
  17.  * GNU General Public License ("GPL").
  18.  *
  19.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22.  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  23.  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28.  *
  29.  * References:
  30.  * HP-HIL Technical Reference Manual.  Hewlett Packard Product No. 45918A
  31.  *
  32.  */
  33. #include <linux/hil.h>
  34. #include <linux/time.h>
  35. #include <linux/interrupt.h>
  36. #include <asm/semaphore.h>
  37. #include <linux/serio.h>
  38. #include <linux/list.h>
  39. typedef struct hil_mlc hil_mlc;
  40. /* The HIL has a complicated state engine.
  41.  * We define the structure of nodes in the state engine here.
  42.  */
  43. enum hilse_act {
  44.    /* HILSE_OUT prepares to receive input if the next node
  45.  * is an IN or EXPECT, and then sends the given packet.
  46.  */
  47. HILSE_OUT = 0,
  48.    /* HILSE_CTS checks if the loop is busy. */
  49. HILSE_CTS,
  50. /* HILSE_OUT_LAST sends the given command packet to 
  51.  * the last configured/running device on the loop.
  52.  */
  53. HILSE_OUT_LAST,
  54. /* HILSE_OUT_DISC sends the given command packet to
  55.  * the next device past the last configured/running one.
  56.  */
  57. HILSE_OUT_DISC,
  58. /* HILSE_FUNC runs a callback function with given arguments.
  59.  * a positive return value causes the "ugly" branch to be taken.
  60.  */
  61. HILSE_FUNC,
  62.    /* HILSE_IN simply expects any non-errored packet to arrive 
  63.  * within arg usecs.
  64.  */
  65. HILSE_IN = 0x100,
  66.    /* HILSE_EXPECT expects a particular packet to arrive 
  67.  * within arg usecs, any other packet is considered an error.
  68.  */
  69. HILSE_EXPECT,
  70.    /* HILSE_EXPECT_LAST as above but dev field should be last 
  71.  * discovered/operational device.
  72.  */
  73. HILSE_EXPECT_LAST,
  74.    /* HILSE_EXPECT_LAST as above but dev field should be first 
  75.  * undiscovered/inoperational device.
  76.  */
  77. HILSE_EXPECT_DISC
  78. };
  79. typedef int (hilse_func) (hil_mlc *mlc, int arg);
  80. struct hilse_node {
  81. enum hilse_act act; /* How to process this node         */
  82. union {
  83. hilse_func *func; /* Function to call if HILSE_FUNC   */
  84. hil_packet packet; /* Packet to send or to compare     */
  85. } object;
  86. int arg; /* Timeout in usec or parm for func */
  87. int good; /* Node to jump to on success       */
  88. int bad; /* Node to jump to on error         */
  89. int ugly; /* Node to jump to on timeout       */
  90. };
  91. /* Methods for back-end drivers, e.g. hp_sdc_mlc */
  92. typedef int (hil_mlc_cts) (hil_mlc *mlc);
  93. typedef void (hil_mlc_out) (hil_mlc *mlc);
  94. typedef int (hil_mlc_in)  (hil_mlc *mlc, suseconds_t timeout);
  95. struct hil_mlc_devinfo {
  96. uint8_t idd[16]; /* Device ID Byte and Describe Record */
  97. uint8_t rsc[16]; /* Security Code Header and Record */
  98. uint8_t exd[16]; /* Extended Describe Record */
  99. uint8_t rnm[16]; /* Device name as returned by RNM command */
  100. };
  101. struct hil_mlc_serio_map {
  102. hil_mlc *mlc;
  103. int di_revmap;
  104. int didx;
  105. };
  106. /* How many (possibly old/detached) devices the we try to keep track of */
  107. #define HIL_MLC_DEVMEM 16
  108. struct hil_mlc {
  109. struct list_head list; /* hil_mlc is organized as linked list */
  110. rwlock_t lock;
  111. void *priv; /* Data specific to a particular type of MLC */
  112. int  seidx; /* Current node in state engine */
  113. int istarted, ostarted;
  114. hil_mlc_cts *cts;
  115. struct semaphore csem;   /* Raised when loop idle */
  116. hil_mlc_out *out;
  117. struct semaphore osem;   /* Raised when outpacket dispatched */
  118. hil_packet opacket;
  119. hil_mlc_in *in;
  120. struct semaphore isem;   /* Raised when a packet arrives */
  121. hil_packet ipacket[16];
  122. hil_packet imatch;
  123. int icount;
  124. struct timeval instart;
  125. suseconds_t intimeout;
  126. int ddi; /* Last operational device id */
  127. int lcv; /* LCV to throttle loops */
  128. struct timeval lcv_tv; /* Time loop was started */
  129. int di_map[7]; /* Maps below items to live devs */
  130. struct hil_mlc_devinfo di[HIL_MLC_DEVMEM];
  131. struct serio serio[HIL_MLC_DEVMEM];
  132. struct hil_mlc_serio_map serio_map[HIL_MLC_DEVMEM];
  133. hil_packet serio_opacket[HIL_MLC_DEVMEM];
  134. int serio_oidx[HIL_MLC_DEVMEM];
  135. struct hil_mlc_devinfo di_scratch; /* Temporary area */
  136. void (*inc_use_count)(void);
  137. void (*dec_use_count)(void);
  138. int opercnt;
  139. struct tasklet_struct *tasklet;
  140. };
  141. int hil_mlc_register(hil_mlc *mlc);
  142. int hil_mlc_unregister(hil_mlc *mlc);