LXR linux/drivers/s390/crypto/ap

   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/types.h>
  31
  32#define AP_DEVICES 64           /* Number of AP devices. */
  33#define AP_DOMAINS 256          /* Number of AP domains. */
  34#define AP_RESET_TIMEOUT (HZ*0.7)       /* Time in ticks for reset timeouts. */
  35#define AP_CONFIG_TIME 30       /* Time in seconds between AP bus rescans. */
  36#define AP_POLL_TIME 1          /* Time in ticks between receive polls. */
  37
  38extern int ap_domain_index;
  39
  40extern spinlock_t ap_list_lock;
  41extern struct list_head ap_card_list;
  42
  43/**
  44 * The ap_qid_t identifier of an ap queue. It contains a
  45 * 6 bit card index and a 4 bit queue index (domain).
  46 */
  47typedef unsigned int ap_qid_t;
  48
  49#define AP_MKQID(_card, _queue) (((_card) & 63) << 8 | ((_queue) & 255))
  50#define AP_QID_CARD(_qid) (((_qid) >> 8) & 63)
  51#define AP_QID_QUEUE(_qid) ((_qid) & 255)
  52
  53/**
  54 * structy ap_queue_status - Holds the AP queue status.
  55 * @queue_empty: Shows if queue is empty
  56 * @replies_waiting: Waiting replies
  57 * @queue_full: Is 1 if the queue is full
  58 * @pad: A 4 bit pad
  59 * @int_enabled: Shows if interrupts are enabled for the AP
  60 * @response_code: Holds the 8 bit response code
  61 * @pad2: A 16 bit pad
  62 *
  63 * The ap queue status word is returned by all three AP functions
  64 * (PQAP, NQAP and DQAP).  There's a set of flags in the first
  65 * byte, followed by a 1 byte response code.
  66 */
  67struct ap_queue_status {
  68        unsigned int queue_empty        : 1;
  69        unsigned int replies_waiting    : 1;
  70        unsigned int queue_full         : 1;
  71        unsigned int pad1               : 4;
  72        unsigned int int_enabled        : 1;
  73        unsigned int response_code      : 8;
  74        unsigned int pad2               : 16;
  75} __packed;
  76
  77
  78static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
  79{
  80        return (*ptr & (0x80000000u >> nr)) != 0;
  81}
  82
  83#define AP_RESPONSE_NORMAL              0x00
  84#define AP_RESPONSE_Q_NOT_AVAIL         0x01
  85#define AP_RESPONSE_RESET_IN_PROGRESS   0x02
  86#define AP_RESPONSE_DECONFIGURED        0x03
  87#define AP_RESPONSE_CHECKSTOPPED        0x04
  88#define AP_RESPONSE_BUSY                0x05
  89#define AP_RESPONSE_INVALID_ADDRESS     0x06
  90#define AP_RESPONSE_OTHERWISE_CHANGED   0x07
  91#define AP_RESPONSE_Q_FULL              0x10
  92#define AP_RESPONSE_NO_PENDING_REPLY    0x10
  93#define AP_RESPONSE_INDEX_TOO_BIG       0x11
  94#define AP_RESPONSE_NO_FIRST_PART       0x13
  95#define AP_RESPONSE_MESSAGE_TOO_BIG     0x15
  96#define AP_RESPONSE_REQ_FAC_NOT_INST    0x16
  97
  98/*
  99 * Known device types
 100 */
 101#define AP_DEVICE_TYPE_PCICC    3
 102#define AP_DEVICE_TYPE_PCICA    4
 103#define AP_DEVICE_TYPE_PCIXCC   5
 104#define AP_DEVICE_TYPE_CEX2A    6
 105#define AP_DEVICE_TYPE_CEX2C    7
 106#define AP_DEVICE_TYPE_CEX3A    8
 107#define AP_DEVICE_TYPE_CEX3C    9
 108#define AP_DEVICE_TYPE_CEX4     10
 109#define AP_DEVICE_TYPE_CEX5     11
 110#define AP_DEVICE_TYPE_CEX6     12
 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 interrupt states
 124 */
 125#define AP_INTR_DISABLED        0       /* AP interrupt disabled */
 126#define AP_INTR_ENABLED         1       /* AP interrupt enabled */
 127
 128/*
 129 * AP device states
 130 */
 131enum ap_state {
 132        AP_STATE_RESET_START,
 133        AP_STATE_RESET_WAIT,
 134        AP_STATE_SETIRQ_WAIT,
 135        AP_STATE_IDLE,
 136        AP_STATE_WORKING,
 137        AP_STATE_QUEUE_FULL,
 138        AP_STATE_SUSPEND_WAIT,
 139        AP_STATE_BORKED,
 140        NR_AP_STATES
 141};
 142
 143/*
 144 * AP device events
 145 */
 146enum ap_event {
 147        AP_EVENT_POLL,
 148        AP_EVENT_TIMEOUT,
 149        NR_AP_EVENTS
 150};
 151
 152/*
 153 * AP wait behaviour
 154 */
 155enum ap_wait {
 156        AP_WAIT_AGAIN,          /* retry immediately */
 157        AP_WAIT_TIMEOUT,        /* wait for timeout */
 158        AP_WAIT_INTERRUPT,      /* wait for thin interrupt (if available) */
 159        AP_WAIT_NONE,           /* no wait */
 160        NR_AP_WAIT
 161};
 162
 163struct ap_device;
 164struct ap_message;
 165
 166struct ap_driver {
 167        struct device_driver driver;
 168        struct ap_device_id *ids;
 169
 170        int (*probe)(struct ap_device *);
 171        void (*remove)(struct ap_device *);
 172        void (*suspend)(struct ap_device *);
 173        void (*resume)(struct ap_device *);
 174};
 175
 176#define to_ap_drv(x) container_of((x), struct ap_driver, driver)
 177
 178int ap_driver_register(struct ap_driver *, struct module *, char *);
 179void ap_driver_unregister(struct ap_driver *);
 180
 181struct ap_device {
 182        struct device device;
 183        struct ap_driver *drv;          /* Pointer to AP device driver. */
 184        int device_type;                /* AP device type. */
 185};
 186
 187#define to_ap_dev(x) container_of((x), struct ap_device, device)
 188
 189struct ap_card {
 190        struct ap_device ap_dev;
 191        struct list_head list;          /* Private list of AP cards. */
 192        struct list_head queues;        /* List of assoc. AP queues */
 193        void *private;                  /* ap driver private pointer. */
 194        int raw_hwtype;                 /* AP raw hardware type. */
 195        unsigned int functions;         /* AP device function bitfield. */
 196        int queue_depth;                /* AP queue depth.*/
 197        int id;                         /* AP card number. */
 198        atomic_t total_request_count;   /* # requests ever for this AP device.*/
 199};
 200
 201#define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
 202
 203struct ap_queue {
 204        struct ap_device ap_dev;
 205        struct list_head list;          /* Private list of AP queues. */
 206        struct ap_card *card;           /* Ptr to assoc. AP card. */
 207        spinlock_t lock;                /* Per device lock. */
 208        void *private;                  /* ap driver private pointer. */
 209        ap_qid_t qid;                   /* AP queue id. */
 210        int interrupt;                  /* indicate if interrupts are enabled */
 211        int queue_count;                /* # messages currently on AP queue. */
 212        enum ap_state state;            /* State of the AP device. */
 213        int pendingq_count;             /* # requests on pendingq list. */
 214        int requestq_count;             /* # requests on requestq list. */
 215        int total_request_count;        /* # requests ever for this AP device.*/
 216        int request_timeout;            /* Request timout in jiffies. */
 217        struct timer_list timeout;      /* Timer for request timeouts. */
 218        struct list_head pendingq;      /* List of message sent to AP queue. */
 219        struct list_head requestq;      /* List of message yet to be sent. */
 220        struct ap_message *reply;       /* Per device reply message. */
 221};
 222
 223#define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
 224
 225typedef enum ap_wait (ap_func_t)(struct ap_queue *queue);
 226
 227struct ap_message {
 228        struct list_head list;          /* Request queueing. */
 229        unsigned long long psmid;       /* Message id. */
 230        void *message;                  /* Pointer to message buffer. */
 231        size_t length;                  /* Message length. */
 232        int rc;                         /* Return code for this message */
 233
 234        void *private;                  /* ap driver private pointer. */
 235        unsigned int special:1;         /* Used for special commands. */
 236        /* receive is called from tasklet context */
 237        void (*receive)(struct ap_queue *, struct ap_message *,
 238                        struct ap_message *);
 239};
 240
 241struct ap_config_info {
 242        unsigned int special_command:1;
 243        unsigned int ap_extended:1;
 244        unsigned char reserved1:6;
 245        unsigned char reserved2[15];
 246        unsigned int apm[8];            /* AP ID mask */
 247        unsigned int aqm[8];            /* AP queue mask */
 248        unsigned int adm[8];            /* AP domain mask */
 249        unsigned char reserved4[16];
 250} __packed;
 251
 252/**
 253 * ap_init_message() - Initialize ap_message.
 254 * Initialize a message before using. Otherwise this might result in
 255 * unexpected behaviour.
 256 */
 257static inline void ap_init_message(struct ap_message *ap_msg)
 258{
 259        ap_msg->psmid = 0;
 260        ap_msg->length = 0;
 261        ap_msg->rc = 0;
 262        ap_msg->special = 0;
 263        ap_msg->receive = NULL;
 264}
 265
 266#define for_each_ap_card(_ac) \
 267        list_for_each_entry(_ac, &ap_card_list, list)
 268
 269#define for_each_ap_queue(_aq, _ac) \
 270        list_for_each_entry(_aq, &(_ac)->queues, list)
 271
 272/*
 273 * Note: don't use ap_send/ap_recv after using ap_queue_message
 274 * for the first time. Otherwise the ap message queue will get
 275 * confused.
 276 */
 277int ap_send(ap_qid_t, unsigned long long, void *, size_t);
 278int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
 279
 280enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event);
 281enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event);
 282
 283void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
 284void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
 285void ap_flush_queue(struct ap_queue *aq);
 286
 287void *ap_airq_ptr(void);
 288void ap_wait(enum ap_wait wait);
 289void ap_request_timeout(unsigned long data);
 290void ap_bus_force_rescan(void);
 291
 292void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
 293struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
 294void ap_queue_remove(struct ap_queue *aq);
 295void ap_queue_suspend(struct ap_device *ap_dev);
 296void ap_queue_resume(struct ap_device *ap_dev);
 297
 298struct ap_card *ap_card_create(int id, int queue_depth, int device_type,
 299                               unsigned int device_functions);
 300
 301int ap_module_init(void);
 302void ap_module_exit(void);
 303
 304#endif /* _AP_BUS_H_ */
 305