xref: /OK3568_Linux_fs/kernel/sound/pci/asihpi/hpicmn.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /**
3*4882a593Smuzhiyun 
4*4882a593Smuzhiyun     AudioScience HPI driver
5*4882a593Smuzhiyun     Copyright (C) 1997-2014  AudioScience Inc. <support@audioscience.com>
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun struct hpi_adapter_obj;
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun /* a function that takes an adapter obj and returns an int */
13*4882a593Smuzhiyun typedef int adapter_int_func(struct hpi_adapter_obj *pao, u32 message);
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #define HPI_IRQ_NONE		(0)
16*4882a593Smuzhiyun #define HPI_IRQ_MESSAGE		(1)
17*4882a593Smuzhiyun #define HPI_IRQ_MIXER		(2)
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun struct hpi_adapter_obj {
20*4882a593Smuzhiyun 	struct hpi_pci pci;	/* PCI info - bus#,dev#,address etc */
21*4882a593Smuzhiyun 	u16 type;		/* 0x6644 == ASI6644 etc */
22*4882a593Smuzhiyun 	u16 index;
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun 	struct hpios_spinlock dsp_lock;
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 	u16 dsp_crashed;
27*4882a593Smuzhiyun 	u16 has_control_cache;
28*4882a593Smuzhiyun 	void *priv;
29*4882a593Smuzhiyun 	adapter_int_func *irq_query_and_clear;
30*4882a593Smuzhiyun 	struct hpi_hostbuffer_status *instream_host_buffer_status;
31*4882a593Smuzhiyun 	struct hpi_hostbuffer_status *outstream_host_buffer_status;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun struct hpi_control_cache {
35*4882a593Smuzhiyun 	/** indicates whether the structures are initialized */
36*4882a593Smuzhiyun 	u16 init;
37*4882a593Smuzhiyun 	u16 adap_idx;
38*4882a593Smuzhiyun 	u32 control_count;
39*4882a593Smuzhiyun 	u32 cache_size_in_bytes;
40*4882a593Smuzhiyun 	/** pointer to allocated memory of lookup pointers. */
41*4882a593Smuzhiyun 	struct hpi_control_cache_info **p_info;
42*4882a593Smuzhiyun 	/** pointer to DSP's control cache. */
43*4882a593Smuzhiyun 	u8 *p_cache;
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun struct hpi_adapter_obj *hpi_find_adapter(u16 adapter_index);
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun u16 hpi_add_adapter(struct hpi_adapter_obj *pao);
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun void hpi_delete_adapter(struct hpi_adapter_obj *pao);
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun short hpi_check_control_cache(struct hpi_control_cache *pC,
53*4882a593Smuzhiyun 	struct hpi_message *phm, struct hpi_response *phr);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun short hpi_check_control_cache_single(struct hpi_control_cache_single *pC,
56*4882a593Smuzhiyun 	struct hpi_message *phm, struct hpi_response *phr);
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun struct hpi_control_cache *hpi_alloc_control_cache(const u32
59*4882a593Smuzhiyun 	number_of_controls, const u32 size_in_bytes, u8 *pDSP_control_buffer);
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun void hpi_free_control_cache(struct hpi_control_cache *p_cache);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun void hpi_cmn_control_cache_sync_to_msg(struct hpi_control_cache *pC,
64*4882a593Smuzhiyun 	struct hpi_message *phm, struct hpi_response *phr);
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun void hpi_cmn_control_cache_sync_to_msg_single(struct hpi_control_cache_single
67*4882a593Smuzhiyun 	*pC, struct hpi_message *phm, struct hpi_response *phr);
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun u16 hpi_validate_response(struct hpi_message *phm, struct hpi_response *phr);
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun hpi_handler_func HPI_COMMON;
72