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