LXR linux/drivers/s390/crypto/ap

   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
  28extern int ap_domain_index;
  29
  30extern spinlock_t ap_list_lock;
  31extern struct list_head ap_card_list;
  32
  33static 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 */
  86enum 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_BORKED,
  95        NR_AP_STATES
  96};
  97
  98/*
  99 * AP device events
 100 */
 101enum ap_event {
 102        AP_EVENT_POLL,
 103        AP_EVENT_TIMEOUT,
 104        NR_AP_EVENTS
 105};
 106
 107/*
 108 * AP wait behaviour
 109 */
 110enum ap_wait {
 111        AP_WAIT_AGAIN,          /* retry immediately */
 112        AP_WAIT_TIMEOUT,        /* wait for timeout */
 113        AP_WAIT_INTERRUPT,      /* wait for thin interrupt (if available) */
 114        AP_WAIT_NONE,           /* no wait */
 115        NR_AP_WAIT
 116};
 117
 118struct ap_device;
 119struct ap_message;
 120
 121/*
 122 * The ap driver struct includes a flags field which holds some info for
 123 * the ap bus about the driver. Currently only one flag is supported and
 124 * used: The DEFAULT flag marks an ap driver as a default driver which is
 125 * used together with the apmask and aqmask whitelisting of the ap bus.
 126 */
 127#define AP_DRIVER_FLAG_DEFAULT 0x0001
 128
 129struct ap_driver {
 130        struct device_driver driver;
 131        struct ap_device_id *ids;
 132        unsigned int flags;
 133
 134        int (*probe)(struct ap_device *);
 135        void (*remove)(struct ap_device *);
 136        void (*suspend)(struct ap_device *);
 137        void (*resume)(struct ap_device *);
 138};
 139
 140#define to_ap_drv(x) container_of((x), struct ap_driver, driver)
 141
 142int ap_driver_register(struct ap_driver *, struct module *, char *);
 143void ap_driver_unregister(struct ap_driver *);
 144
 145struct ap_device {
 146        struct device device;
 147        struct ap_driver *drv;          /* Pointer to AP device driver. */
 148        int device_type;                /* AP device type. */
 149};
 150
 151#define to_ap_dev(x) container_of((x), struct ap_device, device)
 152
 153struct ap_card {
 154        struct ap_device ap_dev;
 155        struct list_head list;          /* Private list of AP cards. */
 156        struct list_head queues;        /* List of assoc. AP queues */
 157        void *private;                  /* ap driver private pointer. */
 158        int raw_hwtype;                 /* AP raw hardware type. */
 159        unsigned int functions;         /* AP device function bitfield. */
 160        int queue_depth;                /* AP queue depth.*/
 161        int id;                         /* AP card number. */
 162        atomic_t total_request_count;   /* # requests ever for this AP device.*/
 163};
 164
 165#define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
 166
 167struct ap_queue {
 168        struct ap_device ap_dev;
 169        struct list_head list;          /* Private list of AP queues. */
 170        struct ap_card *card;           /* Ptr to assoc. AP card. */
 171        spinlock_t lock;                /* Per device lock. */
 172        void *private;                  /* ap driver private pointer. */
 173        ap_qid_t qid;                   /* AP queue id. */
 174        int interrupt;                  /* indicate if interrupts are enabled */
 175        int queue_count;                /* # messages currently on AP queue. */
 176        enum ap_state state;            /* State of the AP device. */
 177        int pendingq_count;             /* # requests on pendingq list. */
 178        int requestq_count;             /* # requests on requestq list. */
 179        int total_request_count;        /* # requests ever for this AP device.*/
 180        int request_timeout;            /* Request timeout in jiffies. */
 181        struct timer_list timeout;      /* Timer for request timeouts. */
 182        struct list_head pendingq;      /* List of message sent to AP queue. */
 183        struct list_head requestq;      /* List of message yet to be sent. */
 184        struct ap_message *reply;       /* Per device reply message. */
 185};
 186
 187#define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
 188
 189typedef enum ap_wait (ap_func_t)(struct ap_queue *queue);
 190
 191struct ap_message {
 192        struct list_head list;          /* Request queueing. */
 193        unsigned long long psmid;       /* Message id. */
 194        void *message;                  /* Pointer to message buffer. */
 195        size_t length;                  /* Message length. */
 196        int rc;                         /* Return code for this message */
 197
 198        void *private;                  /* ap driver private pointer. */
 199        unsigned int special:1;         /* Used for special commands. */
 200        /* receive is called from tasklet context */
 201        void (*receive)(struct ap_queue *, struct ap_message *,
 202                        struct ap_message *);
 203};
 204
 205/**
 206 * ap_init_message() - Initialize ap_message.
 207 * Initialize a message before using. Otherwise this might result in
 208 * unexpected behaviour.
 209 */
 210static inline void ap_init_message(struct ap_message *ap_msg)
 211{
 212        memset(ap_msg, 0, sizeof(*ap_msg));
 213}
 214
 215/**
 216 * ap_release_message() - Release ap_message.
 217 * Releases all memory used internal within the ap_message struct
 218 * Currently this is the message and private field.
 219 */
 220static inline void ap_release_message(struct ap_message *ap_msg)
 221{
 222        kzfree(ap_msg->message);
 223        kzfree(ap_msg->private);
 224}
 225
 226#define for_each_ap_card(_ac) \
 227        list_for_each_entry(_ac, &ap_card_list, list)
 228
 229#define for_each_ap_queue(_aq, _ac) \
 230        list_for_each_entry(_aq, &(_ac)->queues, list)
 231
 232/*
 233 * Note: don't use ap_send/ap_recv after using ap_queue_message
 234 * for the first time. Otherwise the ap message queue will get
 235 * confused.
 236 */
 237int ap_send(ap_qid_t, unsigned long long, void *, size_t);
 238int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
 239
 240enum ap_wait ap_sm_event(struct ap_queue *aq, enum ap_event event);
 241enum ap_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_event event);
 242
 243void ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
 244void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
 245void ap_flush_queue(struct ap_queue *aq);
 246
 247void *ap_airq_ptr(void);
 248void ap_wait(enum ap_wait wait);
 249void ap_request_timeout(struct timer_list *t);
 250void ap_bus_force_rescan(void);
 251
 252void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
 253struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
 254void ap_queue_remove(struct ap_queue *aq);
 255void ap_queue_suspend(struct ap_device *ap_dev);
 256void ap_queue_resume(struct ap_device *ap_dev);
 257void ap_queue_reinit_state(struct ap_queue *aq);
 258
 259struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type,
 260                               int comp_device_type, unsigned int functions);
 261
 262struct ap_perms {
 263        unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)];
 264        unsigned long apm[BITS_TO_LONGS(AP_DEVICES)];
 265        unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)];
 266};
 267extern struct ap_perms ap_perms;
 268extern struct mutex ap_perms_mutex;
 269
 270/*
 271 * check APQN for owned/reserved by ap bus and default driver(s).
 272 * Checks if this APQN is or will be in use by the ap bus
 273 * and the default set of drivers.
 274 * If yes, returns 1, if not returns 0. On error a negative
 275 * errno value is returned.
 276 */
 277int ap_owned_by_def_drv(int card, int queue);
 278
 279/*
 280 * check 'matrix' of APQNs for owned/reserved by ap bus and
 281 * default driver(s).
 282 * Checks if there is at least one APQN in the given 'matrix'
 283 * marked as owned/reserved by the ap bus and default driver(s).
 284 * If such an APQN is found the return value is 1, otherwise
 285 * 0 is returned. On error a negative errno value is returned.
 286 * The parameter apm is a bitmask which should be declared
 287 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
 288 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
 289 */
 290int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
 291                                       unsigned long *aqm);
 292
 293/*
 294 * ap_parse_mask_str() - helper function to parse a bitmap string
 295 * and clear/set the bits in the bitmap accordingly. The string may be
 296 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
 297 * overwriting the current content of the bitmap. Or as relative string
 298 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
 299 * bits are cleared or set. Distinction is done based on the very
 300 * first character which may be '+' or '-' for the relative string
 301 * and othewise assume to be an absolute value string. If parsing fails
 302 * a negative errno value is returned. All arguments and bitmaps are
 303 * big endian order.
 304 */
 305int ap_parse_mask_str(const char *str,
 306                      unsigned long *bitmap, int bits,
 307                      struct mutex *lock);
 308
 309#endif /* _AP_BUS_H_ */
 310