drivers/s390/crypto/ap_bus.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright IBM Corp. 2006, 2012
   4  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
   5  *            Martin Schwidefsky <schwidefsky@de.ibm.com>
   6  *            Ralph Wuerthner <rwuerthn@de.ibm.com>
   7  *            Felix Beck <felix.beck@de.ibm.com>
   8  *            Holger Dengler <hd@linux.vnet.ibm.com>
   9  *
  10  * Adjunct processor bus header file.
  11  */
  12
  13 #ifndef _AP_BUS_H_
  14 #define _AP_BUS_H_
  15
  16 #include <linux/device.h>
  17 #include <linux/types.h>
  18 #include <asm/isc.h>
  19 #include <asm/ap.h>
  20
  21 #define AP_DEVICES 256          /* Number of AP devices. */
  22 #define AP_DOMAINS 256          /* Number of AP domains. */
  23 #define AP_RESET_TIMEOUT (HZ*0.7)       /* Time in ticks for reset timeouts. */
  24 #define AP_CONFIG_TIME 30       /* Time in seconds between AP bus rescans. */
  25 #define AP_POLL_TIME 1          /* Time in ticks between receive polls. */
  26
  27 extern int ap_domain_index;
  28
  29 extern spinlock_t ap_list_lock;
  30 extern struct list_head ap_card_list;
  31
  32 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
  33 {
  34         return (*ptr & (0x80000000u >> nr)) != 0;
  35 }
  36
  37 #define AP_RESPONSE_NORMAL              0x00
  38 #define AP_RESPONSE_Q_NOT_AVAIL         0x01
  39 #define AP_RESPONSE_RESET_IN_PROGRESS   0x02
  40 #define AP_RESPONSE_DECONFIGURED        0x03
  41 #define AP_RESPONSE_CHECKSTOPPED        0x04
  42 #define AP_RESPONSE_BUSY                0x05
  43 #define AP_RESPONSE_INVALID_ADDRESS     0x06
  44 #define AP_RESPONSE_OTHERWISE_CHANGED   0x07
  45 #define AP_RESPONSE_Q_FULL              0x10
  46 #define AP_RESPONSE_NO_PENDING_REPLY    0x10
  47 #define AP_RESPONSE_INDEX_TOO_BIG       0x11
  48 #define AP_RESPONSE_NO_FIRST_PART       0x13
  49 #define AP_RESPONSE_MESSAGE_TOO_BIG     0x15
  50 #define AP_RESPONSE_REQ_FAC_NOT_INST    0x16
  51
  52 /*
  53  * Known device types
  54  */
  55 #define AP_DEVICE_TYPE_PCICC    3
  56 #define AP_DEVICE_TYPE_PCICA    4
  57 #define AP_DEVICE_TYPE_PCIXCC   5
  58 #define AP_DEVICE_TYPE_CEX2A    6
  59 #define AP_DEVICE_TYPE_CEX2C    7
  60 #define AP_DEVICE_TYPE_CEX3A    8
  61 #define AP_DEVICE_TYPE_CEX3C    9
  62 #define AP_DEVICE_TYPE_CEX4     10
  63 #define AP_DEVICE_TYPE_CEX5     11
  64 #define AP_DEVICE_TYPE_CEX6     12
  65
  66 /*
  67  * Known function facilities
  68  */
  69 #define AP_FUNC_MEX4K 1
  70 #define AP_FUNC_CRT4K 2
  71 #define AP_FUNC_COPRO 3
  72 #define AP_FUNC_ACCEL 4
  73 #define AP_FUNC_EP11  5
  74 #define AP_FUNC_APXA  6
  75
  76 /*
  77  * AP interrupt states
  78  */
  79 #define AP_INTR_DISABLED        0       /* AP interrupt disabled */
  80 #define AP_INTR_ENABLED         1       /* AP interrupt enabled */
  81
  82 /*
  83  * AP device states
  84  */
  85 enum ap_state {
  86         AP_STATE_RESET_START,
  87         AP_STATE_RESET_WAIT,
  88         AP_STATE_SETIRQ_WAIT,
  89         AP_STATE_IDLE,
  90         AP_STATE_WORKING,
  91         AP_STATE_QUEUE_FULL,
  92         AP_STATE_SUSPEND_WAIT,
  93         AP_STATE_BORKED,
  94         NR_AP_STATES
  95 };
  96
  97 /*
  98  * AP device events
  99  */
 100 enum ap_event {
 101         AP_EVENT_POLL,
 102         AP_EVENT_TIMEOUT,
 103         NR_AP_EVENTS
 104 };
 105
 106 /*
 107  * AP wait behaviour
 108  */
 109 enum ap_wait {
 110         AP_WAIT_AGAIN,          /* retry immediately */
 111         AP_WAIT_TIMEOUT,        /* wait for timeout */
 112         AP_WAIT_INTERRUPT,      /* wait for thin interrupt (if available) */
 113         AP_WAIT_NONE,           /* no wait */
 114         NR_AP_WAIT
 115 };
 116
 117 struct ap_device;
 118 struct ap_message;
 119
 120 /*
 121  * The ap driver struct includes a flags field which holds some info for
 122  * the ap bus about the driver. Currently only one flag is supported and
 123  * used: The DEFAULT flag marks an ap driver as a default driver which is
 124  * used together with the apmask and aqmask whitelisting of the ap bus.
 125  */
 126 #define AP_DRIVER_FLAG_DEFAULT 0x0001
 127
 128 struct ap_driver {
 129         struct device_driver driver;
 130         struct ap_device_id *ids;
 131         unsigned int flags;
 132
 133         int (*probe)(struct ap_device *);
 134         void (*remove)(struct ap_device *);
 135         void (*suspend)(struct ap_device *);
 136         void (*resume)(struct ap_device *);
 137 };
 138
 139 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
 140
 141 int ap_driver_register(struct ap_driver *, struct module *, char *);
 142 void ap_driver_unregister(struct ap_driver *);
 143
 144 struct ap_device {
 145         struct device device;
 146         struct ap_driver *drv;          /* Pointer to AP device driver. */
 147         int device_type;                /* AP device type. */
 148 };
 149
 150 #define to_ap_dev(x) container_of((x), struct ap_device, device)
 151
 152 struct ap_card {
 153         struct ap_device ap_dev;
 154         struct list_head list;          /* Private list of AP cards. */
 155         struct list_head queues;        /* List of assoc. AP queues */
 156         void *private;                  /* ap driver private pointer. */
 157         int raw_hwtype;                 /* AP raw hardware type. */
 158         unsigned int functions;         /* AP device function bitfield. */
 159         int queue_depth;                /* AP queue depth.*/
 160         int id;                         /* AP card number. */
 161         atomic64_t total_request_count; /* # requests ever for this AP device.*/
 162 };
 163
 164 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
 165
 166 struct ap_queue {
 167         struct ap_device ap_dev;
 168         struct list_head list;          /* Private list of AP queues. */
 169         struct ap_card *card;           /* Ptr to assoc. AP card. */
 170         spinlock_t lock;                /* Per device lock. */
 171         void *private;                  /* ap driver private pointer. */
 172         ap_qid_t qid;                   /* AP queue id. */
 173         int interrupt;                  /* indicate if interrupts are enabled */
 174         int queue_count;                /* # messages currently on AP queue. */
 175         enum ap_state state;            /* State of the AP device. */
 176         int pendingq_count;             /* # requests on pendingq list. */
 177         int requestq_count;             /* # requests on requestq list. */
 178         u64 total_request_count;        /* # requests ever for this AP device.*/
 179         int request_timeout;            /* Request timeout in jiffies. */
 180         struct timer_list timeout;      /* Timer for request timeouts. */
 181         struct list_head pendingq;      /* List of message sent to AP queue. */
 182         struct list_head requestq;      /* List of message yet to be sent. */
 183         struct ap_message *reply;       /* Per device reply message. */
 184 };
 185
 186 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
 187
 188 typedef enum ap_wait (ap_func_t)(struct ap_queue *queue);
 189
 190 struct ap_message {
 191         struct list_head list;          /* Request queueing. */
 192         unsigned long long psmid;       /* Message id. */
 193         void *message;                  /* Pointer to message buffer. */
 194         size_t length;                  /* Message length. */
 195         int rc;                         /* Return code for this message */
 196
 197         void *private;                  /* ap driver private pointer. */
 198         unsigned int special:1;         /* Used for special commands. */
 199         /* receive is called from tasklet context */
 200         void (*receive)(struct ap_queue *, struct ap_message *,
 201                         struct ap_message *);
 202 };
 203
 204 /**
 205  * ap_init_message() - Initialize ap_message.
 206  * Initialize a message before using. Otherwise this might result in
 207  * unexpected behaviour.
 208  */
 209 static inline void ap_init_message(struct ap_message *ap_msg)
 210 {
 211         memset(ap_msg, 0, sizeof(*ap_msg));
 212 }
 213
 214 /**
 215  * ap_release_message() - Release ap_message.
 216  * Releases all memory used internal within the ap_message struct
 217  * Currently this is the message and private field.
 218  */
 219 static inline void ap_release_message(struct ap_message *ap_msg)
 220 {
 221         kzfree(ap_msg->message);
 222         kzfree(ap_msg->private);
 223 }
 224
 225 #define for_each_ap_card(_ac) \
 226         list_for_each_entry(_ac, &ap_card_list, list)
 227
 228 #define for_each_ap_queue(_aq, _ac) \
 229         list_for_each_entry(_aq, &(_ac)->queues, list)
 230
 231 /*
 232  * Note: don't use ap_send/ap_recv after using ap_queue_message
 233  * for the first time. Otherwise the ap message queue will get
 234  * confused.
 235  */
 236 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
 237 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
 238
 239 enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event);
 240 enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event);
 241
 242 void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
 243 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
 244 void ap_flush_queue(struct ap_queue *aq);
 245
 246 void *ap_airq_ptr(void);
 247 void ap_wait(enum ap_wait wait);
 248 void ap_request_timeout(struct timer_list *t);
 249 void ap_bus_force_rescan(void);
 250
 251 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
 252 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
 253 void ap_queue_remove(struct ap_queue *aq);
 254 void ap_queue_suspend(struct ap_device *ap_dev);
 255 void ap_queue_resume(struct ap_device *ap_dev);
 256 void ap_queue_reinit_state(struct ap_queue *aq);
 257
 258 struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type,
 259                                int comp_device_type, unsigned int functions);
 260
 261 /*
 262  * check APQN for owned/reserved by ap bus and default driver(s).
 263  * Checks if this APQN is or will be in use by the ap bus
 264  * and the default set of drivers.
 265  * If yes, returns 1, if not returns 0. On error a negative
 266  * errno value is returned.
 267  */
 268 int ap_owned_by_def_drv(int card, int queue);
 269
 270 /*
 271  * check 'matrix' of APQNs for owned/reserved by ap bus and
 272  * default driver(s).
 273  * Checks if there is at least one APQN in the given 'matrix'
 274  * marked as owned/reserved by the ap bus and default driver(s).
 275  * If such an APQN is found the return value is 1, otherwise
 276  * 0 is returned. On error a negative errno value is returned.
 277  * The parameter apm is a bitmask which should be declared
 278  * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
 279  * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
 280  */
 281 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
 282                                        unsigned long *aqm);
 283
 284 #endif /* _AP_BUS_H_ */