1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* FSI device & driver interfaces 3*4882a593Smuzhiyun * 4*4882a593Smuzhiyun * Copyright (C) IBM Corporation 2016 5*4882a593Smuzhiyun */ 6*4882a593Smuzhiyun 7*4882a593Smuzhiyun #ifndef LINUX_FSI_H 8*4882a593Smuzhiyun #define LINUX_FSI_H 9*4882a593Smuzhiyun 10*4882a593Smuzhiyun #include <linux/device.h> 11*4882a593Smuzhiyun 12*4882a593Smuzhiyun struct fsi_device { 13*4882a593Smuzhiyun struct device dev; 14*4882a593Smuzhiyun u8 engine_type; 15*4882a593Smuzhiyun u8 version; 16*4882a593Smuzhiyun u8 unit; 17*4882a593Smuzhiyun struct fsi_slave *slave; 18*4882a593Smuzhiyun uint32_t addr; 19*4882a593Smuzhiyun uint32_t size; 20*4882a593Smuzhiyun }; 21*4882a593Smuzhiyun 22*4882a593Smuzhiyun extern int fsi_device_read(struct fsi_device *dev, uint32_t addr, 23*4882a593Smuzhiyun void *val, size_t size); 24*4882a593Smuzhiyun extern int fsi_device_write(struct fsi_device *dev, uint32_t addr, 25*4882a593Smuzhiyun const void *val, size_t size); 26*4882a593Smuzhiyun extern int fsi_device_peek(struct fsi_device *dev, void *val); 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun struct fsi_device_id { 29*4882a593Smuzhiyun u8 engine_type; 30*4882a593Smuzhiyun u8 version; 31*4882a593Smuzhiyun }; 32*4882a593Smuzhiyun 33*4882a593Smuzhiyun #define FSI_VERSION_ANY 0 34*4882a593Smuzhiyun 35*4882a593Smuzhiyun #define FSI_DEVICE(t) \ 36*4882a593Smuzhiyun .engine_type = (t), .version = FSI_VERSION_ANY, 37*4882a593Smuzhiyun 38*4882a593Smuzhiyun #define FSI_DEVICE_VERSIONED(t, v) \ 39*4882a593Smuzhiyun .engine_type = (t), .version = (v), 40*4882a593Smuzhiyun 41*4882a593Smuzhiyun struct fsi_driver { 42*4882a593Smuzhiyun struct device_driver drv; 43*4882a593Smuzhiyun const struct fsi_device_id *id_table; 44*4882a593Smuzhiyun }; 45*4882a593Smuzhiyun 46*4882a593Smuzhiyun #define to_fsi_dev(devp) container_of(devp, struct fsi_device, dev) 47*4882a593Smuzhiyun #define to_fsi_drv(drvp) container_of(drvp, struct fsi_driver, drv) 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun extern int fsi_driver_register(struct fsi_driver *fsi_drv); 50*4882a593Smuzhiyun extern void fsi_driver_unregister(struct fsi_driver *fsi_drv); 51*4882a593Smuzhiyun 52*4882a593Smuzhiyun /* module_fsi_driver() - Helper macro for drivers that don't do 53*4882a593Smuzhiyun * anything special in module init/exit. This eliminates a lot of 54*4882a593Smuzhiyun * boilerplate. Each module may only use this macro once, and 55*4882a593Smuzhiyun * calling it replaces module_init() and module_exit() 56*4882a593Smuzhiyun */ 57*4882a593Smuzhiyun #define module_fsi_driver(__fsi_driver) \ 58*4882a593Smuzhiyun module_driver(__fsi_driver, fsi_driver_register, \ 59*4882a593Smuzhiyun fsi_driver_unregister) 60*4882a593Smuzhiyun 61*4882a593Smuzhiyun /* direct slave API */ 62*4882a593Smuzhiyun extern int fsi_slave_claim_range(struct fsi_slave *slave, 63*4882a593Smuzhiyun uint32_t addr, uint32_t size); 64*4882a593Smuzhiyun extern void fsi_slave_release_range(struct fsi_slave *slave, 65*4882a593Smuzhiyun uint32_t addr, uint32_t size); 66*4882a593Smuzhiyun extern int fsi_slave_read(struct fsi_slave *slave, uint32_t addr, 67*4882a593Smuzhiyun void *val, size_t size); 68*4882a593Smuzhiyun extern int fsi_slave_write(struct fsi_slave *slave, uint32_t addr, 69*4882a593Smuzhiyun const void *val, size_t size); 70*4882a593Smuzhiyun 71*4882a593Smuzhiyun extern struct bus_type fsi_bus_type; 72*4882a593Smuzhiyun extern const struct device_type fsi_cdev_type; 73*4882a593Smuzhiyun 74*4882a593Smuzhiyun enum fsi_dev_type { 75*4882a593Smuzhiyun fsi_dev_cfam, 76*4882a593Smuzhiyun fsi_dev_sbefifo, 77*4882a593Smuzhiyun fsi_dev_scom, 78*4882a593Smuzhiyun fsi_dev_occ 79*4882a593Smuzhiyun }; 80*4882a593Smuzhiyun 81*4882a593Smuzhiyun extern int fsi_get_new_minor(struct fsi_device *fdev, enum fsi_dev_type type, 82*4882a593Smuzhiyun dev_t *out_dev, int *out_index); 83*4882a593Smuzhiyun extern void fsi_free_minor(dev_t dev); 84*4882a593Smuzhiyun 85*4882a593Smuzhiyun #endif /* LINUX_FSI_H */ 86