[linux-block.git] / include / linux / ism.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Internal Shared Memory
 *
 *  Definitions for the ISM module
 *
 *  Copyright IBM Corp. 2022
 */
#ifndef _ISM_H
#define _ISM_H

#include <linux/workqueue.h>

struct ism_dmb {
	u64 dmb_tok;
	u64 rgid;
	u32 dmb_len;
	u32 sba_idx;
	u32 vlan_valid;
	u32 vlan_id;
	void *cpu_addr;
	dma_addr_t dma_addr;
};

/* Unless we gain unexpected popularity, this limit should hold for a while */
#define MAX_CLIENTS		8
#define ISM_NR_DMBS		1920

struct ism_dev {
	spinlock_t lock; /* protects the ism device */
	struct list_head list;
	struct pci_dev *pdev;

	struct ism_sba *sba;
	dma_addr_t sba_dma_addr;
	DECLARE_BITMAP(sba_bitmap, ISM_NR_DMBS);
	u8 *sba_client_arr;	/* entries are indices into 'clients' array */
	void *priv[MAX_CLIENTS];

	struct ism_eq *ieq;
	dma_addr_t ieq_dma_addr;

	struct device dev;
	u64 local_gid;
	int ieq_idx;

	atomic_t free_clients_cnt;
	atomic_t add_dev_cnt;
	wait_queue_head_t waitq;
};

struct ism_event {
	u32 type;
	u32 code;
	u64 tok;
	u64 time;
	u64 info;
};

struct ism_client {
	const char *name;
	void (*add)(struct ism_dev *dev);
	void (*remove)(struct ism_dev *dev);
	void (*handle_event)(struct ism_dev *dev, struct ism_event *event);
	/* Parameter dmbemask contains a bit vector with updated DMBEs, if sent
	 * via ism_move_data(). Callback function must handle all active bits
	 * indicated by dmbemask.
	 */
	void (*handle_irq)(struct ism_dev *dev, unsigned int bit, u16 dmbemask);
	/* Private area - don't touch! */
	struct work_struct remove_work;
	struct work_struct add_work;
	struct ism_dev *tgt_ism;
	u8 id;
};

int ism_register_client(struct ism_client *client);
int  ism_unregister_client(struct ism_client *client);
static inline void *ism_get_priv(struct ism_dev *dev,
				 struct ism_client *client) {
	return dev->priv[client->id];
}

static inline void ism_set_priv(struct ism_dev *dev, struct ism_client *client,
				void *priv) {
	dev->priv[client->id] = priv;
}

int  ism_register_dmb(struct ism_dev *dev, struct ism_dmb *dmb,
		      struct ism_client *client);
int  ism_unregister_dmb(struct ism_dev *dev, struct ism_dmb *dmb);
int  ism_move(struct ism_dev *dev, u64 dmb_tok, unsigned int idx, bool sf,
	      unsigned int offset, void *data, unsigned int size);
u8  *ism_get_seid(void);

const struct smcd_ops *ism_get_smcd_ops(void);

#endif	/* _ISM_H */
Commit	Line	Data
1baedb13 SR	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/*
	3	* Internal Shared Memory
	4	*
	5	* Definitions for the ISM module
	6	*
	7	* Copyright IBM Corp. 2022
	8	*/
	9	#ifndef _ISM_H
	10	#define _ISM_H
	11
89e7d2ba SR	12	#include <linux/workqueue.h>
89e7d2ba SR	13
1baedb13 SR	14	struct ism_dmb {
	15	u64 dmb_tok;
	16	u64 rgid;
	17	u32 dmb_len;
	18	u32 sba_idx;
	19	u32 vlan_valid;
	20	u32 vlan_id;
	21	void *cpu_addr;
	22	dma_addr_t dma_addr;
	23	};
	24
89e7d2ba SR	25	/* Unless we gain unexpected popularity, this limit should hold for a while */
	26	#define MAX_CLIENTS 8
	27	#define ISM_NR_DMBS 1920
	28
	29	struct ism_dev {
	30	spinlock_t lock; /* protects the ism device */
	31	struct list_head list;
	32	struct pci_dev *pdev;
89e7d2ba SR	33
	34	struct ism_sba *sba;
	35	dma_addr_t sba_dma_addr;
	36	DECLARE_BITMAP(sba_bitmap, ISM_NR_DMBS);
	37	u8 sba_client_arr; / entries are indices into 'clients' array */
	38	void *priv[MAX_CLIENTS];
	39
	40	struct ism_eq *ieq;
	41	dma_addr_t ieq_dma_addr;
	42
	43	struct device dev;
	44	u64 local_gid;
	45	int ieq_idx;
	46
	47	atomic_t free_clients_cnt;
	48	atomic_t add_dev_cnt;
	49	wait_queue_head_t waitq;
	50	};
	51
	52	struct ism_event {
	53	u32 type;
	54	u32 code;
	55	u64 tok;
	56	u64 time;
	57	u64 info;
	58	};
	59
	60	struct ism_client {
	61	const char *name;
	62	void (add)(struct ism_dev dev);
	63	void (remove)(struct ism_dev dev);
	64	void (handle_event)(struct ism_dev dev, struct ism_event *event);
	65	/* Parameter dmbemask contains a bit vector with updated DMBEs, if sent
	66	* via ism_move_data(). Callback function must handle all active bits
	67	* indicated by dmbemask.
	68	*/
	69	void (handle_irq)(struct ism_dev dev, unsigned int bit, u16 dmbemask);
	70	/* Private area - don't touch! */
	71	struct work_struct remove_work;
	72	struct work_struct add_work;
	73	struct ism_dev *tgt_ism;
	74	u8 id;
	75	};
	76
	77	int ism_register_client(struct ism_client *client);
	78	int ism_unregister_client(struct ism_client *client);
	79	static inline void ism_get_priv(struct ism_dev dev,
	80	struct ism_client *client) {
	81	return dev->priv[client->id];
	82	}
	83
	84	static inline void ism_set_priv(struct ism_dev dev, struct ism_client client,
	85	void *priv) {
	86	dev->priv[client->id] = priv;
	87	}
	88
9de4df7b SR	89	int ism_register_dmb(struct ism_dev dev, struct ism_dmb dmb,
	90	struct ism_client *client);
	91	int ism_unregister_dmb(struct ism_dev dev, struct ism_dmb dmb);
	92	int ism_move(struct ism_dev *dev, u64 dmb_tok, unsigned int idx, bool sf,
	93	unsigned int offset, void *data, unsigned int size);
	94	u8 *ism_get_seid(void);
	95
820f2100 SR	96	const struct smcd_ops *ism_get_smcd_ops(void);
820f2100 SR	97
1baedb13	98	#endif /* _ISM_H */