11534c382SMartin Schwidefsky /* 21534c382SMartin Schwidefsky * linux/drivers/s390/crypto/ap_bus.h 31534c382SMartin Schwidefsky * 41534c382SMartin Schwidefsky * Copyright (C) 2006 IBM Corporation 51534c382SMartin Schwidefsky * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com> 61534c382SMartin Schwidefsky * Martin Schwidefsky <schwidefsky@de.ibm.com> 71534c382SMartin Schwidefsky * Ralph Wuerthner <rwuerthn@de.ibm.com> 81534c382SMartin Schwidefsky * 91534c382SMartin Schwidefsky * Adjunct processor bus header file. 101534c382SMartin Schwidefsky * 111534c382SMartin Schwidefsky * This program is free software; you can redistribute it and/or modify 121534c382SMartin Schwidefsky * it under the terms of the GNU General Public License as published by 131534c382SMartin Schwidefsky * the Free Software Foundation; either version 2, or (at your option) 141534c382SMartin Schwidefsky * any later version. 151534c382SMartin Schwidefsky * 161534c382SMartin Schwidefsky * This program is distributed in the hope that it will be useful, 171534c382SMartin Schwidefsky * but WITHOUT ANY WARRANTY; without even the implied warranty of 181534c382SMartin Schwidefsky * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 191534c382SMartin Schwidefsky * GNU General Public License for more details. 201534c382SMartin Schwidefsky * 211534c382SMartin Schwidefsky * You should have received a copy of the GNU General Public License 221534c382SMartin Schwidefsky * along with this program; if not, write to the Free Software 231534c382SMartin Schwidefsky * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 241534c382SMartin Schwidefsky */ 251534c382SMartin Schwidefsky 261534c382SMartin Schwidefsky #ifndef _AP_BUS_H_ 271534c382SMartin Schwidefsky #define _AP_BUS_H_ 281534c382SMartin Schwidefsky 291534c382SMartin Schwidefsky #include <linux/device.h> 301534c382SMartin Schwidefsky #include <linux/mod_devicetable.h> 311534c382SMartin Schwidefsky #include <linux/types.h> 321534c382SMartin Schwidefsky 331534c382SMartin Schwidefsky #define AP_DEVICES 64 /* Number of AP devices. */ 341534c382SMartin Schwidefsky #define AP_DOMAINS 16 /* Number of AP domains. */ 351534c382SMartin Schwidefsky #define AP_MAX_RESET 90 /* Maximum number of resets. */ 36af512ed0SRalph Wuerthner #define AP_RESET_TIMEOUT (HZ/2) /* Time in ticks for reset timeouts. */ 371534c382SMartin Schwidefsky #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */ 381534c382SMartin Schwidefsky #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */ 391534c382SMartin Schwidefsky 401534c382SMartin Schwidefsky extern int ap_domain_index; 411534c382SMartin Schwidefsky 421534c382SMartin Schwidefsky /** 431534c382SMartin Schwidefsky * The ap_qid_t identifier of an ap queue. It contains a 441534c382SMartin Schwidefsky * 6 bit device index and a 4 bit queue index (domain). 451534c382SMartin Schwidefsky */ 461534c382SMartin Schwidefsky typedef unsigned int ap_qid_t; 471534c382SMartin Schwidefsky 481534c382SMartin Schwidefsky #define AP_MKQID(_device,_queue) (((_device) & 63) << 8 | ((_queue) & 15)) 491534c382SMartin Schwidefsky #define AP_QID_DEVICE(_qid) (((_qid) >> 8) & 63) 501534c382SMartin Schwidefsky #define AP_QID_QUEUE(_qid) ((_qid) & 15) 511534c382SMartin Schwidefsky 521534c382SMartin Schwidefsky /** 531534c382SMartin Schwidefsky * The ap queue status word is returned by all three AP functions 541534c382SMartin Schwidefsky * (PQAP, NQAP and DQAP). There's a set of flags in the first 551534c382SMartin Schwidefsky * byte, followed by a 1 byte response code. 561534c382SMartin Schwidefsky */ 571534c382SMartin Schwidefsky struct ap_queue_status { 581534c382SMartin Schwidefsky unsigned int queue_empty : 1; 591534c382SMartin Schwidefsky unsigned int replies_waiting : 1; 601534c382SMartin Schwidefsky unsigned int queue_full : 1; 611534c382SMartin Schwidefsky unsigned int pad1 : 5; 621534c382SMartin Schwidefsky unsigned int response_code : 8; 631534c382SMartin Schwidefsky unsigned int pad2 : 16; 641534c382SMartin Schwidefsky }; 651534c382SMartin Schwidefsky 661534c382SMartin Schwidefsky #define AP_RESPONSE_NORMAL 0x00 671534c382SMartin Schwidefsky #define AP_RESPONSE_Q_NOT_AVAIL 0x01 681534c382SMartin Schwidefsky #define AP_RESPONSE_RESET_IN_PROGRESS 0x02 691534c382SMartin Schwidefsky #define AP_RESPONSE_DECONFIGURED 0x03 701534c382SMartin Schwidefsky #define AP_RESPONSE_CHECKSTOPPED 0x04 711534c382SMartin Schwidefsky #define AP_RESPONSE_BUSY 0x05 721534c382SMartin Schwidefsky #define AP_RESPONSE_Q_FULL 0x10 731534c382SMartin Schwidefsky #define AP_RESPONSE_NO_PENDING_REPLY 0x10 741534c382SMartin Schwidefsky #define AP_RESPONSE_INDEX_TOO_BIG 0x11 751534c382SMartin Schwidefsky #define AP_RESPONSE_NO_FIRST_PART 0x13 761534c382SMartin Schwidefsky #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15 771534c382SMartin Schwidefsky 781534c382SMartin Schwidefsky /** 791534c382SMartin Schwidefsky * Known device types 801534c382SMartin Schwidefsky */ 811534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCICC 3 821534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCICA 4 831534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_PCIXCC 5 841534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_CEX2A 6 851534c382SMartin Schwidefsky #define AP_DEVICE_TYPE_CEX2C 7 861534c382SMartin Schwidefsky 87af512ed0SRalph Wuerthner /** 88af512ed0SRalph Wuerthner * AP reset flag states 89af512ed0SRalph Wuerthner */ 90af512ed0SRalph Wuerthner #define AP_RESET_IGNORE 0 /* request timeout will be ignored */ 91af512ed0SRalph Wuerthner #define AP_RESET_ARMED 1 /* request timeout timer is active */ 92af512ed0SRalph Wuerthner #define AP_RESET_DO 2 /* AP reset required */ 93af512ed0SRalph Wuerthner 941534c382SMartin Schwidefsky struct ap_device; 951534c382SMartin Schwidefsky struct ap_message; 961534c382SMartin Schwidefsky 971534c382SMartin Schwidefsky struct ap_driver { 981534c382SMartin Schwidefsky struct device_driver driver; 991534c382SMartin Schwidefsky struct ap_device_id *ids; 1001534c382SMartin Schwidefsky 1011534c382SMartin Schwidefsky int (*probe)(struct ap_device *); 1021534c382SMartin Schwidefsky void (*remove)(struct ap_device *); 1031534c382SMartin Schwidefsky /* receive is called from tasklet context */ 1041534c382SMartin Schwidefsky void (*receive)(struct ap_device *, struct ap_message *, 1051534c382SMartin Schwidefsky struct ap_message *); 106af512ed0SRalph Wuerthner int request_timeout; /* request timeout in jiffies */ 1071534c382SMartin Schwidefsky }; 1081534c382SMartin Schwidefsky 1091534c382SMartin Schwidefsky #define to_ap_drv(x) container_of((x), struct ap_driver, driver) 1101534c382SMartin Schwidefsky 1111534c382SMartin Schwidefsky int ap_driver_register(struct ap_driver *, struct module *, char *); 1121534c382SMartin Schwidefsky void ap_driver_unregister(struct ap_driver *); 1131534c382SMartin Schwidefsky 1141534c382SMartin Schwidefsky struct ap_device { 1151534c382SMartin Schwidefsky struct device device; 1161534c382SMartin Schwidefsky struct ap_driver *drv; /* Pointer to AP device driver. */ 1171534c382SMartin Schwidefsky spinlock_t lock; /* Per device lock. */ 118cf352ce0SRalph Wuerthner struct list_head list; /* private list of all AP devices. */ 1191534c382SMartin Schwidefsky 1201534c382SMartin Schwidefsky ap_qid_t qid; /* AP queue id. */ 1211534c382SMartin Schwidefsky int queue_depth; /* AP queue depth.*/ 1221534c382SMartin Schwidefsky int device_type; /* AP device type. */ 1231534c382SMartin Schwidefsky int unregistered; /* marks AP device as unregistered */ 124af512ed0SRalph Wuerthner struct timer_list timeout; /* Timer for request timeouts. */ 125af512ed0SRalph Wuerthner int reset; /* Reset required after req. timeout. */ 1261534c382SMartin Schwidefsky 1271534c382SMartin Schwidefsky int queue_count; /* # messages currently on AP queue. */ 1281534c382SMartin Schwidefsky 1291534c382SMartin Schwidefsky struct list_head pendingq; /* List of message sent to AP queue. */ 1301534c382SMartin Schwidefsky int pendingq_count; /* # requests on pendingq list. */ 1311534c382SMartin Schwidefsky struct list_head requestq; /* List of message yet to be sent. */ 1321534c382SMartin Schwidefsky int requestq_count; /* # requests on requestq list. */ 1331534c382SMartin Schwidefsky int total_request_count; /* # requests ever for this AP device. */ 1341534c382SMartin Schwidefsky 1351534c382SMartin Schwidefsky struct ap_message *reply; /* Per device reply message. */ 1361534c382SMartin Schwidefsky 1371534c382SMartin Schwidefsky void *private; /* ap driver private pointer. */ 1381534c382SMartin Schwidefsky }; 1391534c382SMartin Schwidefsky 1401534c382SMartin Schwidefsky #define to_ap_dev(x) container_of((x), struct ap_device, device) 1411534c382SMartin Schwidefsky 1421534c382SMartin Schwidefsky struct ap_message { 1431534c382SMartin Schwidefsky struct list_head list; /* Request queueing. */ 1441534c382SMartin Schwidefsky unsigned long long psmid; /* Message id. */ 1451534c382SMartin Schwidefsky void *message; /* Pointer to message buffer. */ 1461534c382SMartin Schwidefsky size_t length; /* Message length. */ 1471534c382SMartin Schwidefsky 1481534c382SMartin Schwidefsky void *private; /* ap driver private pointer. */ 1491534c382SMartin Schwidefsky }; 1501534c382SMartin Schwidefsky 1511534c382SMartin Schwidefsky #define AP_DEVICE(dt) \ 1521534c382SMartin Schwidefsky .dev_type=(dt), \ 1531534c382SMartin Schwidefsky .match_flags=AP_DEVICE_ID_MATCH_DEVICE_TYPE, 1541534c382SMartin Schwidefsky 1551534c382SMartin Schwidefsky /** 1561534c382SMartin Schwidefsky * Note: don't use ap_send/ap_recv after using ap_queue_message 1571534c382SMartin Schwidefsky * for the first time. Otherwise the ap message queue will get 1581534c382SMartin Schwidefsky * confused. 1591534c382SMartin Schwidefsky */ 1601534c382SMartin Schwidefsky int ap_send(ap_qid_t, unsigned long long, void *, size_t); 1611534c382SMartin Schwidefsky int ap_recv(ap_qid_t, unsigned long long *, void *, size_t); 1621534c382SMartin Schwidefsky 1631534c382SMartin Schwidefsky void ap_queue_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 1641534c382SMartin Schwidefsky void ap_cancel_message(struct ap_device *ap_dev, struct ap_message *ap_msg); 1651534c382SMartin Schwidefsky void ap_flush_queue(struct ap_device *ap_dev); 1661534c382SMartin Schwidefsky 1671534c382SMartin Schwidefsky int ap_module_init(void); 1681534c382SMartin Schwidefsky void ap_module_exit(void); 1691534c382SMartin Schwidefsky 1701534c382SMartin Schwidefsky #endif /* _AP_BUS_H_ */ 171