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 Hardware Programming Interface (HPI) Utility functions.
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun (C) Copyright AudioScience Inc. 2007
11*4882a593Smuzhiyun *******************************************************************************/
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #include "hpi_internal.h"
14*4882a593Smuzhiyun #include "hpimsginit.h"
15*4882a593Smuzhiyun #include <linux/nospec.h>
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun /* The actual message size for each object type */
18*4882a593Smuzhiyun static u16 msg_size[HPI_OBJ_MAXINDEX + 1] = HPI_MESSAGE_SIZE_BY_OBJECT;
19*4882a593Smuzhiyun /* The actual response size for each object type */
20*4882a593Smuzhiyun static u16 res_size[HPI_OBJ_MAXINDEX + 1] = HPI_RESPONSE_SIZE_BY_OBJECT;
21*4882a593Smuzhiyun /* Flag to enable alternate message type for SSX2 bypass. */
22*4882a593Smuzhiyun static u16 gwSSX2_bypass;
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun /** \internal
25*4882a593Smuzhiyun * initialize the HPI message structure
26*4882a593Smuzhiyun */
hpi_init_message(struct hpi_message * phm,u16 object,u16 function)27*4882a593Smuzhiyun static void hpi_init_message(struct hpi_message *phm, u16 object,
28*4882a593Smuzhiyun u16 function)
29*4882a593Smuzhiyun {
30*4882a593Smuzhiyun u16 size;
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun if ((object > 0) && (object <= HPI_OBJ_MAXINDEX)) {
33*4882a593Smuzhiyun object = array_index_nospec(object, HPI_OBJ_MAXINDEX + 1);
34*4882a593Smuzhiyun size = msg_size[object];
35*4882a593Smuzhiyun } else {
36*4882a593Smuzhiyun size = sizeof(*phm);
37*4882a593Smuzhiyun }
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun memset(phm, 0, size);
40*4882a593Smuzhiyun phm->size = size;
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun if (gwSSX2_bypass)
43*4882a593Smuzhiyun phm->type = HPI_TYPE_SSX2BYPASS_MESSAGE;
44*4882a593Smuzhiyun else
45*4882a593Smuzhiyun phm->type = HPI_TYPE_REQUEST;
46*4882a593Smuzhiyun phm->object = object;
47*4882a593Smuzhiyun phm->function = function;
48*4882a593Smuzhiyun phm->version = 0;
49*4882a593Smuzhiyun phm->adapter_index = HPI_ADAPTER_INDEX_INVALID;
50*4882a593Smuzhiyun /* Expect actual adapter index to be set by caller */
51*4882a593Smuzhiyun }
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun /** \internal
54*4882a593Smuzhiyun * initialize the HPI response structure
55*4882a593Smuzhiyun */
hpi_init_response(struct hpi_response * phr,u16 object,u16 function,u16 error)56*4882a593Smuzhiyun void hpi_init_response(struct hpi_response *phr, u16 object, u16 function,
57*4882a593Smuzhiyun u16 error)
58*4882a593Smuzhiyun {
59*4882a593Smuzhiyun u16 size;
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun if ((object > 0) && (object <= HPI_OBJ_MAXINDEX)) {
62*4882a593Smuzhiyun object = array_index_nospec(object, HPI_OBJ_MAXINDEX + 1);
63*4882a593Smuzhiyun size = res_size[object];
64*4882a593Smuzhiyun } else {
65*4882a593Smuzhiyun size = sizeof(*phr);
66*4882a593Smuzhiyun }
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun memset(phr, 0, sizeof(*phr));
69*4882a593Smuzhiyun phr->size = size;
70*4882a593Smuzhiyun phr->type = HPI_TYPE_RESPONSE;
71*4882a593Smuzhiyun phr->object = object;
72*4882a593Smuzhiyun phr->function = function;
73*4882a593Smuzhiyun phr->error = error;
74*4882a593Smuzhiyun phr->specific_error = 0;
75*4882a593Smuzhiyun phr->version = 0;
76*4882a593Smuzhiyun }
77*4882a593Smuzhiyun
hpi_init_message_response(struct hpi_message * phm,struct hpi_response * phr,u16 object,u16 function)78*4882a593Smuzhiyun void hpi_init_message_response(struct hpi_message *phm,
79*4882a593Smuzhiyun struct hpi_response *phr, u16 object, u16 function)
80*4882a593Smuzhiyun {
81*4882a593Smuzhiyun hpi_init_message(phm, object, function);
82*4882a593Smuzhiyun /* default error return if the response is
83*4882a593Smuzhiyun not filled in by the callee */
84*4882a593Smuzhiyun hpi_init_response(phr, object, function,
85*4882a593Smuzhiyun HPI_ERROR_PROCESSING_MESSAGE);
86*4882a593Smuzhiyun }
87*4882a593Smuzhiyun
hpi_init_messageV1(struct hpi_message_header * phm,u16 size,u16 object,u16 function)88*4882a593Smuzhiyun static void hpi_init_messageV1(struct hpi_message_header *phm, u16 size,
89*4882a593Smuzhiyun u16 object, u16 function)
90*4882a593Smuzhiyun {
91*4882a593Smuzhiyun memset(phm, 0, size);
92*4882a593Smuzhiyun if ((object > 0) && (object <= HPI_OBJ_MAXINDEX)) {
93*4882a593Smuzhiyun phm->size = size;
94*4882a593Smuzhiyun phm->type = HPI_TYPE_REQUEST;
95*4882a593Smuzhiyun phm->object = object;
96*4882a593Smuzhiyun phm->function = function;
97*4882a593Smuzhiyun phm->version = 1;
98*4882a593Smuzhiyun /* Expect adapter index to be set by caller */
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun
hpi_init_responseV1(struct hpi_response_header * phr,u16 size,u16 object,u16 function)102*4882a593Smuzhiyun void hpi_init_responseV1(struct hpi_response_header *phr, u16 size,
103*4882a593Smuzhiyun u16 object, u16 function)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun (void)object;
106*4882a593Smuzhiyun (void)function;
107*4882a593Smuzhiyun memset(phr, 0, size);
108*4882a593Smuzhiyun phr->size = size;
109*4882a593Smuzhiyun phr->version = 1;
110*4882a593Smuzhiyun phr->type = HPI_TYPE_RESPONSE;
111*4882a593Smuzhiyun phr->error = HPI_ERROR_PROCESSING_MESSAGE;
112*4882a593Smuzhiyun }
113*4882a593Smuzhiyun
hpi_init_message_responseV1(struct hpi_message_header * phm,u16 msg_size,struct hpi_response_header * phr,u16 res_size,u16 object,u16 function)114*4882a593Smuzhiyun void hpi_init_message_responseV1(struct hpi_message_header *phm, u16 msg_size,
115*4882a593Smuzhiyun struct hpi_response_header *phr, u16 res_size, u16 object,
116*4882a593Smuzhiyun u16 function)
117*4882a593Smuzhiyun {
118*4882a593Smuzhiyun hpi_init_messageV1(phm, msg_size, object, function);
119*4882a593Smuzhiyun hpi_init_responseV1(phr, res_size, object, function);
120*4882a593Smuzhiyun }
121