drivers/s390/crypto/ap_bus.h

   1 /*
   2  * Copyright IBM Corp. 2006, 2012
   3  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
   4  *            Martin Schwidefsky <schwidefsky@de.ibm.com>
   5  *            Ralph Wuerthner <rwuerthn@de.ibm.com>
   6  *            Felix Beck <felix.beck@de.ibm.com>
   7  *            Holger Dengler <hd@linux.vnet.ibm.com>
   8  *
   9  * Adjunct processor bus header file.
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2, or (at your option)
  14  * any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24  */
  25
  26 #ifndef _AP_BUS_H_
  27 #define _AP_BUS_H_
  28
  29 #include <linux/device.h>
  30 #include <linux/mod_devicetable.h>
  31 #include <linux/types.h>
  32
  33 #define AP_DEVICES 64           /* Number of AP devices. */
  34 #define AP_DOMAINS 256          /* Number of AP domains. */
  35 #define AP_RESET_TIMEOUT (HZ*0.7)       /* Time in ticks for reset timeouts. */
  36 #define AP_CONFIG_TIME 30       /* Time in seconds between AP bus rescans. */
  37 #define AP_POLL_TIME 1          /* Time in ticks between receive polls. */
  38
  39 #define AP_POLL_IMMEDIATELY     1 /* continue running poll tasklet */
  40 #define AP_POLL_AFTER_TIMEOUT   2 /* run poll tasklet again after timout */
  41
  42 extern int ap_domain_index;
  43
  44 /**
  45  * The ap_qid_t identifier of an ap queue. It contains a
  46  * 6 bit device index and a 4 bit queue index (domain).
  47  */
  48 typedef unsigned int ap_qid_t;
  49
  50 #define AP_MKQID(_device, _queue) (((_device) & 63) << 8 | ((_queue) & 255))
  51 #define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63)
  52 #define AP_QID_QUEUE(_qid) ((_qid) & 255)
  53
  54 /**
  55  * structy ap_queue_status - Holds the AP queue status.
  56  * @queue_empty: Shows if queue is empty
  57  * @replies_waiting: Waiting replies
  58  * @queue_full: Is 1 if the queue is full
  59  * @pad: A 4 bit pad
  60  * @int_enabled: Shows if interrupts are enabled for the AP
  61  * @response_conde: Holds the 8 bit response code
  62  * @pad2: A 16 bit pad
  63  *
  64  * The ap queue status word is returned by all three AP functions
  65  * (PQAP, NQAP and DQAP).  There's a set of flags in the first
  66  * byte, followed by a 1 byte response code.
  67  */
  68 struct ap_queue_status {
  69         unsigned int queue_empty        : 1;
  70         unsigned int replies_waiting    : 1;
  71         unsigned int queue_full         : 1;
  72         unsigned int pad1               : 4;
  73         unsigned int int_enabled        : 1;
  74         unsigned int response_code      : 8;
  75         unsigned int pad2               : 16;
  76 } __packed;
  77
  78
  79 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
  80 {
  81         return (*ptr & (0x80000000u >> nr)) != 0;
  82 }
  83
  84 #define AP_RESPONSE_NORMAL              0x00
  85 #define AP_RESPONSE_Q_NOT_AVAIL         0x01
  86 #define AP_RESPONSE_RESET_IN_PROGRESS   0x02
  87 #define AP_RESPONSE_DECONFIGURED        0x03
  88 #define AP_RESPONSE_CHECKSTOPPED        0x04
  89 #define AP_RESPONSE_BUSY                0x05
  90 #define AP_RESPONSE_INVALID_ADDRESS     0x06
  91 #define AP_RESPONSE_OTHERWISE_CHANGED   0x07
  92 #define AP_RESPONSE_Q_FULL              0x10
  93 #define AP_RESPONSE_NO_PENDING_REPLY    0x10
  94 #define AP_RESPONSE_INDEX_TOO_BIG       0x11
  95 #define AP_RESPONSE_NO_FIRST_PART       0x13
  96 #define AP_RESPONSE_MESSAGE_TOO_BIG     0x15
  97 #define AP_RESPONSE_REQ_FAC_NOT_INST    0x16
  98
  99 /*
 100  * Known device types
 101  */
 102 #define AP_DEVICE_TYPE_PCICC    3
 103 #define AP_DEVICE_TYPE_PCICA    4
 104 #define AP_DEVICE_TYPE_PCIXCC   5
 105 #define AP_DEVICE_TYPE_CEX2A    6
 106 #define AP_DEVICE_TYPE_CEX2C    7
 107 #define AP_DEVICE_TYPE_CEX3A    8
 108 #define AP_DEVICE_TYPE_CEX3C    9
 109 #define AP_DEVICE_TYPE_CEX4     10
 110 #define AP_DEVICE_TYPE_CEX5     11
 111
 112 /*
 113  * Known function facilities
 114  */
 115 #define AP_FUNC_MEX4K 1
 116 #define AP_FUNC_CRT4K 2
 117 #define AP_FUNC_COPRO 3
 118 #define AP_FUNC_ACCEL 4
 119 #define AP_FUNC_EP11  5
 120 #define AP_FUNC_APXA  6
 121
 122 /*
 123  * AP reset flag states
 124  */
 125 #define AP_RESET_IGNORE 0       /* request timeout will be ignored */
 126 #define AP_RESET_ARMED  1       /* request timeout timer is active */
 127 #define AP_RESET_DO     2       /* AP reset required */
 128 #define AP_RESET_IN_PROGRESS    3       /* AP reset in progress */
 129
 130 /*
 131  * AP interrupt states
 132  */
 133 #define AP_INTR_DISABLED        0       /* AP interrupt disabled */
 134 #define AP_INTR_ENABLED         1       /* AP interrupt enabled */
 135 #define AP_INTR_IN_PROGRESS     3       /* AP interrupt in progress */
 136
 137 struct ap_device;
 138 struct ap_message;
 139
 140 struct ap_driver {
 141         struct device_driver driver;
 142         struct ap_device_id *ids;
 143
 144         int (*probe)(struct ap_device *);
 145         void (*remove)(struct ap_device *);
 146         int request_timeout;            /* request timeout in jiffies */
 147 };
 148
 149 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
 150
 151 int ap_driver_register(struct ap_driver *, struct module *, char *);
 152 void ap_driver_unregister(struct ap_driver *);
 153
 154 struct ap_device {
 155         struct device device;
 156         struct ap_driver *drv;          /* Pointer to AP device driver. */
 157         spinlock_t lock;                /* Per device lock. */
 158         struct list_head list;          /* private list of all AP devices. */
 159
 160         ap_qid_t qid;                   /* AP queue id. */
 161         int queue_depth;                /* AP queue depth.*/
 162         int device_type;                /* AP device type. */
 163         int raw_hwtype;                 /* AP raw hardware type. */
 164         unsigned int functions;         /* AP device function bitfield. */
 165         int unregistered;               /* marks AP device as unregistered */
 166         struct timer_list timeout;      /* Timer for request timeouts. */
 167         int reset;                      /* Reset required after req. timeout. */
 168
 169         int interrupt;                  /* indicate if interrupts are enabled */
 170         int queue_count;                /* # messages currently on AP queue. */
 171
 172         struct list_head pendingq;      /* List of message sent to AP queue. */
 173         int pendingq_count;             /* # requests on pendingq list. */
 174         struct list_head requestq;      /* List of message yet to be sent. */
 175         int requestq_count;             /* # requests on requestq list. */
 176         int total_request_count;        /* # requests ever for this AP device. */
 177
 178         struct ap_message *reply;       /* Per device reply message. */
 179
 180         void *private;                  /* ap driver private pointer. */
 181 };
 182
 183 #define to_ap_dev(x) container_of((x), struct ap_device, device)
 184
 185 struct ap_message {
 186         struct list_head list;          /* Request queueing. */
 187         unsigned long long psmid;       /* Message id. */
 188         void *message;                  /* Pointer to message buffer. */
 189         size_t length;                  /* Message length. */
 190
 191         void *private;                  /* ap driver private pointer. */
 192         unsigned int special:1;         /* Used for special commands. */
 193         /* receive is called from tasklet context */
 194         void (*receive)(struct ap_device *, struct ap_message *,
 195                         struct ap_message *);
 196 };
 197
 198 struct ap_config_info {
 199         unsigned int special_command:1;
 200         unsigned int ap_extended:1;
 201         unsigned char reserved1:6;
 202         unsigned char reserved2[15];
 203         unsigned int apm[8];            /* AP ID mask */
 204         unsigned int aqm[8];            /* AP queue mask */
 205         unsigned int adm[8];            /* AP domain mask */
 206         unsigned char reserved4[16];
 207 } __packed;
 208
 209 #define AP_DEVICE(dt)                                   \
 210         .dev_type=(dt),                                 \
 211         .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE,
 212
 213 /**
 214  * ap_init_message() - Initialize ap_message.
 215  * Initialize a message before using. Otherwise this might result in
 216  * unexpected behaviour.
 217  */
 218 static inline void ap_init_message(struct ap_message *ap_msg)
 219 {
 220         ap_msg->psmid = 0;
 221         ap_msg->length = 0;
 222         ap_msg->special = 0;
 223         ap_msg->receive = NULL;
 224 }
 225
 226 /*
 227  * Note: don't use ap_send/ap_recv after using ap_queue_message
 228  * for the first time. Otherwise the ap message queue will get
 229  * confused.
 230  */
 231 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
 232 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
 233
 234 void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
 235 void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg);
 236 void ap_flush_queue(struct ap_device *ap_dev);
 237 void ap_bus_force_rescan(void);
 238
 239 int ap_module_init(void);
 240 void ap_module_exit(void);
 241
 242 #endif /* _AP_BUS_H_ */