zcrypt_api.h

Go to the documentation of this file.

/*
 *  zcrypt 2.1.0
 *
 *  Copyright IBM Corp. 2001, 2012
 *  Author(s): Robert Burroughs
 *         Eric Rossman ([email protected])
 *         Cornelia Huck <[email protected]>
 *
 *  Hotplug & misc device support: Jochen Roehrig ([email protected])
 *  Major cleanup & driver split: Martin Schwidefsky <[email protected]>
 *                Ralph Wuerthner <[email protected]>
 *  MSGTYPE restruct:         Holger Dengler <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef _ZCRYPT_API_H_
#define _ZCRYPT_API_H_

#include <linux/atomic.h>
#include <asm/debug.h>
#include <asm/zcrypt.h>
#include "ap_bus.h"

/* deprecated status calls */
#define ICAZ90STATUS        _IOR(ZCRYPT_IOCTL_MAGIC, 0x10, struct ica_z90_status)
#define Z90STAT_PCIXCCCOUNT _IOR(ZCRYPT_IOCTL_MAGIC, 0x43, int)

struct ica_z90_status {
    int totalcount;
    int leedslitecount; // PCICA
    int leeds2count;    // PCICC
    // int PCIXCCCount; is not in struct for backward compatibility
    int requestqWaitCount;
    int pendingqWaitCount;
    int totalOpenCount;
    int cryptoDomain;
    // status: 0=not there, 1=PCICA, 2=PCICC, 3=PCIXCC_MCL2, 4=PCIXCC_MCL3,
    //     5=CEX2C
    unsigned char status[64];
    // qdepth: # work elements waiting for each device
    unsigned char qdepth[64];
};

#define ZCRYPT_PCICA        1
#define ZCRYPT_PCICC        2
#define ZCRYPT_PCIXCC_MCL2  3
#define ZCRYPT_PCIXCC_MCL3  4
#define ZCRYPT_CEX2C        5
#define ZCRYPT_CEX2A        6
#define ZCRYPT_CEX3C        7
#define ZCRYPT_CEX3A        8

#define ZCRYPT_RNG_BUFFER_SIZE  4096

struct zcrypt_device;

struct zcrypt_ops {
    long (*rsa_modexpo)(struct zcrypt_device *, struct ica_rsa_modexpo *);
    long (*rsa_modexpo_crt)(struct zcrypt_device *,
                struct ica_rsa_modexpo_crt *);
    long (*send_cprb)(struct zcrypt_device *, struct ica_xcRB *);
    long (*rng)(struct zcrypt_device *, char *);
    struct list_head list;      /* zcrypt ops list. */
    struct module *owner;
    int variant;
};

struct zcrypt_device {
    struct list_head list;      /* Device list. */
    spinlock_t lock;        /* Per device lock. */
    struct kref refcount;       /* device refcounting */
    struct ap_device *ap_dev;   /* The "real" ap device. */
    struct zcrypt_ops *ops;     /* Crypto operations. */
    int online;         /* User online/offline */

    int user_space_type;        /* User space device id. */
    char *type_string;      /* User space device name. */
    int min_mod_size;       /* Min number of bits. */
    int max_mod_size;       /* Max number of bits. */
    int short_crt;          /* Card has crt length restriction. */
    int speed_rating;       /* Speed of the crypto device. */

    int request_count;      /* # current requests. */

    struct ap_message reply;    /* Per-device reply structure. */
    int max_exp_bit_length;

    debug_info_t *dbf_area;     /* debugging */
};

/* transport layer rescanning */
extern atomic_t zcrypt_rescan_req;

struct zcrypt_device *zcrypt_device_alloc(size_t);
void zcrypt_device_free(struct zcrypt_device *);
void zcrypt_device_get(struct zcrypt_device *);
int zcrypt_device_put(struct zcrypt_device *);
int zcrypt_device_register(struct zcrypt_device *);
void zcrypt_device_unregister(struct zcrypt_device *);
void zcrypt_msgtype_register(struct zcrypt_ops *);
void zcrypt_msgtype_unregister(struct zcrypt_ops *);
struct zcrypt_ops *zcrypt_msgtype_request(unsigned char *, int);
void zcrypt_msgtype_release(struct zcrypt_ops *);
int zcrypt_api_init(void);
void zcrypt_api_exit(void);

#endif /* _ZCRYPT_API_H_ */