1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */ 2*4882a593Smuzhiyun 3*4882a593Smuzhiyun #ifndef __QCOM_APR_H_ 4*4882a593Smuzhiyun #define __QCOM_APR_H_ 5*4882a593Smuzhiyun 6*4882a593Smuzhiyun #include <linux/spinlock.h> 7*4882a593Smuzhiyun #include <linux/device.h> 8*4882a593Smuzhiyun #include <linux/mod_devicetable.h> 9*4882a593Smuzhiyun #include <dt-bindings/soc/qcom,apr.h> 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun extern struct bus_type aprbus; 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun #define APR_HDR_LEN(hdr_len) ((hdr_len)/4) 14*4882a593Smuzhiyun 15*4882a593Smuzhiyun /* 16*4882a593Smuzhiyun * HEADER field 17*4882a593Smuzhiyun * version:0:3 18*4882a593Smuzhiyun * header_size : 4:7 19*4882a593Smuzhiyun * message_type : 8:9 20*4882a593Smuzhiyun * reserved: 10:15 21*4882a593Smuzhiyun */ 22*4882a593Smuzhiyun #define APR_HDR_FIELD(msg_type, hdr_len, ver)\ 23*4882a593Smuzhiyun (((msg_type & 0x3) << 8) | ((hdr_len & 0xF) << 4) | (ver & 0xF)) 24*4882a593Smuzhiyun 25*4882a593Smuzhiyun #define APR_HDR_SIZE sizeof(struct apr_hdr) 26*4882a593Smuzhiyun #define APR_SEQ_CMD_HDR_FIELD APR_HDR_FIELD(APR_MSG_TYPE_SEQ_CMD, \ 27*4882a593Smuzhiyun APR_HDR_LEN(APR_HDR_SIZE), \ 28*4882a593Smuzhiyun APR_PKT_VER) 29*4882a593Smuzhiyun /* Version */ 30*4882a593Smuzhiyun #define APR_PKT_VER 0x0 31*4882a593Smuzhiyun 32*4882a593Smuzhiyun /* Command and Response Types */ 33*4882a593Smuzhiyun #define APR_MSG_TYPE_EVENT 0x0 34*4882a593Smuzhiyun #define APR_MSG_TYPE_CMD_RSP 0x1 35*4882a593Smuzhiyun #define APR_MSG_TYPE_SEQ_CMD 0x2 36*4882a593Smuzhiyun #define APR_MSG_TYPE_NSEQ_CMD 0x3 37*4882a593Smuzhiyun #define APR_MSG_TYPE_MAX 0x04 38*4882a593Smuzhiyun 39*4882a593Smuzhiyun /* APR Basic Response Message */ 40*4882a593Smuzhiyun #define APR_BASIC_RSP_RESULT 0x000110E8 41*4882a593Smuzhiyun #define APR_RSP_ACCEPTED 0x000100BE 42*4882a593Smuzhiyun 43*4882a593Smuzhiyun struct aprv2_ibasic_rsp_result_t { 44*4882a593Smuzhiyun uint32_t opcode; 45*4882a593Smuzhiyun uint32_t status; 46*4882a593Smuzhiyun }; 47*4882a593Smuzhiyun 48*4882a593Smuzhiyun /* hdr field Ver [0:3], Size [4:7], Message type [8:10] */ 49*4882a593Smuzhiyun #define APR_HDR_FIELD_VER(h) (h & 0x000F) 50*4882a593Smuzhiyun #define APR_HDR_FIELD_SIZE(h) ((h & 0x00F0) >> 4) 51*4882a593Smuzhiyun #define APR_HDR_FIELD_SIZE_BYTES(h) (((h & 0x00F0) >> 4) * 4) 52*4882a593Smuzhiyun #define APR_HDR_FIELD_MT(h) ((h & 0x0300) >> 8) 53*4882a593Smuzhiyun 54*4882a593Smuzhiyun struct apr_hdr { 55*4882a593Smuzhiyun uint16_t hdr_field; 56*4882a593Smuzhiyun uint16_t pkt_size; 57*4882a593Smuzhiyun uint8_t src_svc; 58*4882a593Smuzhiyun uint8_t src_domain; 59*4882a593Smuzhiyun uint16_t src_port; 60*4882a593Smuzhiyun uint8_t dest_svc; 61*4882a593Smuzhiyun uint8_t dest_domain; 62*4882a593Smuzhiyun uint16_t dest_port; 63*4882a593Smuzhiyun uint32_t token; 64*4882a593Smuzhiyun uint32_t opcode; 65*4882a593Smuzhiyun } __packed; 66*4882a593Smuzhiyun 67*4882a593Smuzhiyun struct apr_pkt { 68*4882a593Smuzhiyun struct apr_hdr hdr; 69*4882a593Smuzhiyun uint8_t payload[]; 70*4882a593Smuzhiyun }; 71*4882a593Smuzhiyun 72*4882a593Smuzhiyun struct apr_resp_pkt { 73*4882a593Smuzhiyun struct apr_hdr hdr; 74*4882a593Smuzhiyun void *payload; 75*4882a593Smuzhiyun int payload_size; 76*4882a593Smuzhiyun }; 77*4882a593Smuzhiyun 78*4882a593Smuzhiyun /* Bits 0 to 15 -- Minor version, Bits 16 to 31 -- Major version */ 79*4882a593Smuzhiyun #define APR_SVC_MAJOR_VERSION(v) ((v >> 16) & 0xFF) 80*4882a593Smuzhiyun #define APR_SVC_MINOR_VERSION(v) (v & 0xFF) 81*4882a593Smuzhiyun 82*4882a593Smuzhiyun struct apr_device { 83*4882a593Smuzhiyun struct device dev; 84*4882a593Smuzhiyun uint16_t svc_id; 85*4882a593Smuzhiyun uint16_t domain_id; 86*4882a593Smuzhiyun uint32_t version; 87*4882a593Smuzhiyun char name[APR_NAME_SIZE]; 88*4882a593Smuzhiyun const char *service_path; 89*4882a593Smuzhiyun spinlock_t lock; 90*4882a593Smuzhiyun struct list_head node; 91*4882a593Smuzhiyun }; 92*4882a593Smuzhiyun 93*4882a593Smuzhiyun #define to_apr_device(d) container_of(d, struct apr_device, dev) 94*4882a593Smuzhiyun 95*4882a593Smuzhiyun struct apr_driver { 96*4882a593Smuzhiyun int (*probe)(struct apr_device *sl); 97*4882a593Smuzhiyun int (*remove)(struct apr_device *sl); 98*4882a593Smuzhiyun int (*callback)(struct apr_device *a, 99*4882a593Smuzhiyun struct apr_resp_pkt *d); 100*4882a593Smuzhiyun struct device_driver driver; 101*4882a593Smuzhiyun const struct apr_device_id *id_table; 102*4882a593Smuzhiyun }; 103*4882a593Smuzhiyun 104*4882a593Smuzhiyun #define to_apr_driver(d) container_of(d, struct apr_driver, driver) 105*4882a593Smuzhiyun 106*4882a593Smuzhiyun /* 107*4882a593Smuzhiyun * use a macro to avoid include chaining to get THIS_MODULE 108*4882a593Smuzhiyun */ 109*4882a593Smuzhiyun #define apr_driver_register(drv) __apr_driver_register(drv, THIS_MODULE) 110*4882a593Smuzhiyun 111*4882a593Smuzhiyun int __apr_driver_register(struct apr_driver *drv, struct module *owner); 112*4882a593Smuzhiyun void apr_driver_unregister(struct apr_driver *drv); 113*4882a593Smuzhiyun 114*4882a593Smuzhiyun /** 115*4882a593Smuzhiyun * module_apr_driver() - Helper macro for registering a aprbus driver 116*4882a593Smuzhiyun * @__aprbus_driver: aprbus_driver struct 117*4882a593Smuzhiyun * 118*4882a593Smuzhiyun * Helper macro for aprbus drivers which do not do anything special in 119*4882a593Smuzhiyun * module init/exit. This eliminates a lot of boilerplate. Each module 120*4882a593Smuzhiyun * may only use this macro once, and calling it replaces module_init() 121*4882a593Smuzhiyun * and module_exit() 122*4882a593Smuzhiyun */ 123*4882a593Smuzhiyun #define module_apr_driver(__apr_driver) \ 124*4882a593Smuzhiyun module_driver(__apr_driver, apr_driver_register, \ 125*4882a593Smuzhiyun apr_driver_unregister) 126*4882a593Smuzhiyun 127*4882a593Smuzhiyun int apr_send_pkt(struct apr_device *adev, struct apr_pkt *pkt); 128*4882a593Smuzhiyun 129*4882a593Smuzhiyun #endif /* __QCOM_APR_H_ */ 130