leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

soc: qcom: qmi: use const for struct qmi_elem_info

Browse Source 
Currently all usage of struct qmi_elem_info, which is used to define
the QMI message encoding/decoding rules, does not use const. This
prevents clients from registering const arrays. Since these arrays are
always pre-defined, they should be const, so add the const qualifier
to all places in the QMI interface where struct qmi_elem_info is used.

Once this patch is in place, clients can independently update their
pre-defined arrays to be const, as demonstrated in the QMI sample
code.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
Signed-off-by: Bjorn Andersson <andersson@kernel.org>
Link: https://lore.kernel.org/r/20220822153435.7856-1-quic_jjohnson@quicinc.com
This commit is contained in:
Jeff Johnson 2022-08-22 08:34:35 -07:00 committed by Bjorn Andersson
parent 7eb89c17ab
commit ff6d365898
4 changed files with 47 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
drivers/soc/qcom/qmi_encdec.c
View File

@ -57,11 +57,11 @@ do { \
#define TLV_TYPE_SIZE sizeof(u8) #define TLV_TYPE_SIZE sizeof(u8)
#define OPTIONAL_TLV_TYPE_START 0x10 #define OPTIONAL_TLV_TYPE_START 0x10
static int qmi_encode(struct qmi_elem_info *ei_array, void *out_buf, static int qmi_encode(const struct qmi_elem_info *ei_array, void *out_buf,
const void *in_c_struct, u32 out_buf_len, const void *in_c_struct, u32 out_buf_len,
int enc_level); int enc_level);
static int qmi_decode(struct qmi_elem_info *ei_array, void *out_c_struct, static int qmi_decode(const struct qmi_elem_info *ei_array, void *out_c_struct,
const void *in_buf, u32 in_buf_len, int dec_level); const void *in_buf, u32 in_buf_len, int dec_level);
/** /**
@ -76,10 +76,10 @@ static int qmi_decode(struct qmi_elem_info *ei_array, void *out_c_struct,
* *
* Return: struct info of the next element that can be encoded. * Return: struct info of the next element that can be encoded.
*/ */
static struct qmi_elem_info *skip_to_next_elem(struct qmi_elem_info *ei_array, static const struct qmi_elem_info *
int level) skip_to_next_elem(const struct qmi_elem_info *ei_array, int level)
{ {
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
u8 tlv_type; u8 tlv_type;
if (level > 1) { if (level > 1) {
@ -101,11 +101,11 @@ static struct qmi_elem_info *skip_to_next_elem(struct qmi_elem_info *ei_array,
* *
* Return: Expected minimum length of the QMI message or 0 on error. * Return: Expected minimum length of the QMI message or 0 on error.
*/ */
static int qmi_calc_min_msg_len(struct qmi_elem_info *ei_array, static int qmi_calc_min_msg_len(const struct qmi_elem_info *ei_array,
int level) int level)
{ {
int min_msg_len = 0; int min_msg_len = 0;
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
if (!ei_array) if (!ei_array)
return min_msg_len; return min_msg_len;
@ -194,13 +194,13 @@ static int qmi_encode_basic_elem(void *buf_dst, const void *buf_src,
* Return: The number of bytes of encoded information on success or negative * Return: The number of bytes of encoded information on success or negative
* errno on error. * errno on error.
*/ */
static int qmi_encode_struct_elem(struct qmi_elem_info *ei_array, static int qmi_encode_struct_elem(const struct qmi_elem_info *ei_array,
void *buf_dst, const void *buf_src, void *buf_dst, const void *buf_src,
u32 elem_len, u32 out_buf_len, u32 elem_len, u32 out_buf_len,
int enc_level) int enc_level)
{ {
int i, rc, encoded_bytes = 0; int i, rc, encoded_bytes = 0;
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
for (i = 0; i < elem_len; i++) { for (i = 0; i < elem_len; i++) {
rc = qmi_encode(temp_ei->ei_array, buf_dst, buf_src, rc = qmi_encode(temp_ei->ei_array, buf_dst, buf_src,
@ -233,13 +233,13 @@ static int qmi_encode_struct_elem(struct qmi_elem_info *ei_array,
* Return: The number of bytes of encoded information on success or negative * Return: The number of bytes of encoded information on success or negative
* errno on error. * errno on error.
*/ */
static int qmi_encode_string_elem(struct qmi_elem_info *ei_array, static int qmi_encode_string_elem(const struct qmi_elem_info *ei_array,
void *buf_dst, const void *buf_src, void *buf_dst, const void *buf_src,
u32 out_buf_len, int enc_level) u32 out_buf_len, int enc_level)
{ {
int rc; int rc;
int encoded_bytes = 0; int encoded_bytes = 0;
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
u32 string_len = 0; u32 string_len = 0;
u32 string_len_sz = 0; u32 string_len_sz = 0;
@ -289,11 +289,11 @@ static int qmi_encode_string_elem(struct qmi_elem_info *ei_array,
* Return: The number of bytes of encoded information on success or negative * Return: The number of bytes of encoded information on success or negative
* errno on error. * errno on error.
*/ */
static int qmi_encode(struct qmi_elem_info *ei_array, void *out_buf, static int qmi_encode(const struct qmi_elem_info *ei_array, void *out_buf,
const void *in_c_struct, u32 out_buf_len, const void *in_c_struct, u32 out_buf_len,
int enc_level) int enc_level)
{ {
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
u8 opt_flag_value = 0; u8 opt_flag_value = 0;
u32 data_len_value = 0, data_len_sz; u32 data_len_value = 0, data_len_sz;
u8 *buf_dst = (u8 *)out_buf; u8 *buf_dst = (u8 *)out_buf;
@ -468,13 +468,13 @@ static int qmi_decode_basic_elem(void *buf_dst, const void *buf_src,
* Return: The total size of the decoded data elements on success, negative * Return: The total size of the decoded data elements on success, negative
* errno on error. * errno on error.
*/ */
static int qmi_decode_struct_elem(struct qmi_elem_info *ei_array, static int qmi_decode_struct_elem(const struct qmi_elem_info *ei_array,
void *buf_dst, const void *buf_src, void *buf_dst, const void *buf_src,
u32 elem_len, u32 tlv_len, u32 elem_len, u32 tlv_len,
int dec_level) int dec_level)
{ {
int i, rc, decoded_bytes = 0; int i, rc, decoded_bytes = 0;
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
for (i = 0; i < elem_len && decoded_bytes < tlv_len; i++) { for (i = 0; i < elem_len && decoded_bytes < tlv_len; i++) {
rc = qmi_decode(temp_ei->ei_array, buf_dst, buf_src, rc = qmi_decode(temp_ei->ei_array, buf_dst, buf_src,
@ -514,7 +514,7 @@ static int qmi_decode_struct_elem(struct qmi_elem_info *ei_array,
* Return: The total size of the decoded data elements on success, negative * Return: The total size of the decoded data elements on success, negative
* errno on error. * errno on error.
*/ */
static int qmi_decode_string_elem(struct qmi_elem_info *ei_array, static int qmi_decode_string_elem(const struct qmi_elem_info *ei_array,
void *buf_dst, const void *buf_src, void *buf_dst, const void *buf_src,
u32 tlv_len, int dec_level) u32 tlv_len, int dec_level)
{ {
@ -522,7 +522,7 @@ static int qmi_decode_string_elem(struct qmi_elem_info *ei_array,
int decoded_bytes = 0; int decoded_bytes = 0;
u32 string_len = 0; u32 string_len = 0;
u32 string_len_sz = 0; u32 string_len_sz = 0;
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
if (dec_level == 1) { if (dec_level == 1) {
string_len = tlv_len; string_len = tlv_len;
@ -564,10 +564,10 @@ static int qmi_decode_string_elem(struct qmi_elem_info *ei_array,
* *
* Return: Pointer to struct info, if found * Return: Pointer to struct info, if found
*/ */
static struct qmi_elem_info *find_ei(struct qmi_elem_info *ei_array, static const struct qmi_elem_info *find_ei(const struct qmi_elem_info *ei_array,
u32 type) u32 type)
{ {
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
while (temp_ei->data_type != QMI_EOTI) { while (temp_ei->data_type != QMI_EOTI) {
if (temp_ei->tlv_type == (u8)type) if (temp_ei->tlv_type == (u8)type)
@ -590,11 +590,11 @@ static struct qmi_elem_info *find_ei(struct qmi_elem_info *ei_array,
* Return: The number of bytes of decoded information on success, negative * Return: The number of bytes of decoded information on success, negative
* errno on error. * errno on error.
*/ */
static int qmi_decode(struct qmi_elem_info *ei_array, void *out_c_struct, static int qmi_decode(const struct qmi_elem_info *ei_array, void *out_c_struct,
const void *in_buf, u32 in_buf_len, const void *in_buf, u32 in_buf_len,
int dec_level) int dec_level)
{ {
struct qmi_elem_info *temp_ei = ei_array; const struct qmi_elem_info *temp_ei = ei_array;
u8 opt_flag_value = 1; u8 opt_flag_value = 1;
u32 data_len_value = 0, data_len_sz = 0; u32 data_len_value = 0, data_len_sz = 0;
u8 *buf_dst = out_c_struct; u8 *buf_dst = out_c_struct;
@ -713,7 +713,7 @@ static int qmi_decode(struct qmi_elem_info *ei_array, void *out_c_struct,
* Return: Buffer with encoded message, or negative ERR_PTR() on error * Return: Buffer with encoded message, or negative ERR_PTR() on error
*/ */
void *qmi_encode_message(int type, unsigned int msg_id, size_t *len, void *qmi_encode_message(int type, unsigned int msg_id, size_t *len,
unsigned int txn_id, struct qmi_elem_info *ei, unsigned int txn_id, const struct qmi_elem_info *ei,
const void *c_struct) const void *c_struct)
{ {
struct qmi_header *hdr; struct qmi_header *hdr;
@ -767,7 +767,7 @@ EXPORT_SYMBOL(qmi_encode_message);
* errno on error. * errno on error.
*/ */
int qmi_decode_message(const void *buf, size_t len, int qmi_decode_message(const void *buf, size_t len,
struct qmi_elem_info *ei, void *c_struct) const struct qmi_elem_info *ei, void *c_struct)
{ {
if (!ei) if (!ei)
return -EINVAL; return -EINVAL;
@ -781,7 +781,7 @@ int qmi_decode_message(const void *buf, size_t len,
EXPORT_SYMBOL(qmi_decode_message); EXPORT_SYMBOL(qmi_decode_message);
/* Common header in all QMI responses */ /* Common header in all QMI responses */
struct qmi_elem_info qmi_response_type_v01_ei[] = { const struct qmi_elem_info qmi_response_type_v01_ei[] = {
{ {
.data_type = QMI_SIGNED_2_BYTE_ENUM, .data_type = QMI_SIGNED_2_BYTE_ENUM,
.elem_len = 1, .elem_len = 1,

12
drivers/soc/qcom/qmi_interface.c
View File

@ -305,7 +305,7 @@ EXPORT_SYMBOL(qmi_add_server);
* Return: Transaction id on success, negative errno on failure. * Return: Transaction id on success, negative errno on failure.
*/ */
int qmi_txn_init(struct qmi_handle *qmi, struct qmi_txn *txn, int qmi_txn_init(struct qmi_handle *qmi, struct qmi_txn *txn,
struct qmi_elem_info *ei, void *c_struct) const struct qmi_elem_info *ei, void *c_struct)
{ {
int ret; int ret;
@ -736,7 +736,8 @@ EXPORT_SYMBOL(qmi_handle_release);
static ssize_t qmi_send_message(struct qmi_handle *qmi, static ssize_t qmi_send_message(struct qmi_handle *qmi,
struct sockaddr_qrtr *sq, struct qmi_txn *txn, struct sockaddr_qrtr *sq, struct qmi_txn *txn,
int type, int msg_id, size_t len, int type, int msg_id, size_t len,
struct qmi_elem_info *ei, const void *c_struct) const struct qmi_elem_info *ei,
const void *c_struct)
{ {
struct msghdr msghdr = {}; struct msghdr msghdr = {};
struct kvec iv; struct kvec iv;
@ -787,7 +788,7 @@ static ssize_t qmi_send_message(struct qmi_handle *qmi,
*/ */
ssize_t qmi_send_request(struct qmi_handle *qmi, struct sockaddr_qrtr *sq, ssize_t qmi_send_request(struct qmi_handle *qmi, struct sockaddr_qrtr *sq,
struct qmi_txn *txn, int msg_id, size_t len, struct qmi_txn *txn, int msg_id, size_t len,
struct qmi_elem_info *ei, const void *c_struct) const struct qmi_elem_info *ei, const void *c_struct)
{ {
return qmi_send_message(qmi, sq, txn, QMI_REQUEST, msg_id, len, ei, return qmi_send_message(qmi, sq, txn, QMI_REQUEST, msg_id, len, ei,
c_struct); c_struct);
@ -808,7 +809,7 @@ EXPORT_SYMBOL(qmi_send_request);
*/ */
ssize_t qmi_send_response(struct qmi_handle *qmi, struct sockaddr_qrtr *sq, ssize_t qmi_send_response(struct qmi_handle *qmi, struct sockaddr_qrtr *sq,
struct qmi_txn *txn, int msg_id, size_t len, struct qmi_txn *txn, int msg_id, size_t len,
struct qmi_elem_info *ei, const void *c_struct) const struct qmi_elem_info *ei, const void *c_struct)
{ {
return qmi_send_message(qmi, sq, txn, QMI_RESPONSE, msg_id, len, ei, return qmi_send_message(qmi, sq, txn, QMI_RESPONSE, msg_id, len, ei,
c_struct); c_struct);
@ -827,7 +828,8 @@ EXPORT_SYMBOL(qmi_send_response);
* Return: 0 on success, negative errno on failure. * Return: 0 on success, negative errno on failure.
*/ */
ssize_t qmi_send_indication(struct qmi_handle *qmi, struct sockaddr_qrtr *sq, ssize_t qmi_send_indication(struct qmi_handle *qmi, struct sockaddr_qrtr *sq,
int msg_id, size_t len, struct qmi_elem_info *ei, int msg_id, size_t len,
const struct qmi_elem_info *ei,
const void *c_struct) const void *c_struct)
{ {
struct qmi_txn txn; struct qmi_txn txn;

20
include/linux/soc/qcom/qmi.h
View File

@ -75,7 +75,7 @@ struct qmi_elem_info {
enum qmi_array_type array_type; enum qmi_array_type array_type;
u8 tlv_type; u8 tlv_type;
u32 offset; u32 offset;
struct qmi_elem_info *ei_array; const struct qmi_elem_info *ei_array;
}; };
#define QMI_RESULT_SUCCESS_V01 0 #define QMI_RESULT_SUCCESS_V01 0
@ -102,7 +102,7 @@ struct qmi_response_type_v01 {
u16 error; u16 error;
}; };
extern struct qmi_elem_info qmi_response_type_v01_ei[]; extern const struct qmi_elem_info qmi_response_type_v01_ei[];
/** /**
* struct qmi_service - context to track lookup-results * struct qmi_service - context to track lookup-results
@ -173,7 +173,7 @@ struct qmi_txn {
struct completion completion; struct completion completion;
int result; int result;
struct qmi_elem_info *ei; const struct qmi_elem_info *ei;
void *dest; void *dest;
}; };
@ -189,7 +189,7 @@ struct qmi_msg_handler {
unsigned int type; unsigned int type;
unsigned int msg_id; unsigned int msg_id;
struct qmi_elem_info *ei; const struct qmi_elem_info *ei;
size_t decoded_size; size_t decoded_size;
void (*fn)(struct qmi_handle *qmi, struct sockaddr_qrtr *sq, void (*fn)(struct qmi_handle *qmi, struct sockaddr_qrtr *sq,
@ -249,23 +249,23 @@ void qmi_handle_release(struct qmi_handle *qmi);
ssize_t qmi_send_request(struct qmi_handle *qmi, struct sockaddr_qrtr *sq, ssize_t qmi_send_request(struct qmi_handle *qmi, struct sockaddr_qrtr *sq,
struct qmi_txn *txn, int msg_id, size_t len, struct qmi_txn *txn, int msg_id, size_t len,
struct qmi_elem_info *ei, const void *c_struct); const struct qmi_elem_info *ei, const void *c_struct);
ssize_t qmi_send_response(struct qmi_handle *qmi, struct sockaddr_qrtr *sq, ssize_t qmi_send_response(struct qmi_handle *qmi, struct sockaddr_qrtr *sq,
struct qmi_txn *txn, int msg_id, size_t len, struct qmi_txn *txn, int msg_id, size_t len,
struct qmi_elem_info *ei, const void *c_struct); const struct qmi_elem_info *ei, const void *c_struct);
ssize_t qmi_send_indication(struct qmi_handle *qmi, struct sockaddr_qrtr *sq, ssize_t qmi_send_indication(struct qmi_handle *qmi, struct sockaddr_qrtr *sq,
int msg_id, size_t len, struct qmi_elem_info *ei, int msg_id, size_t len, const struct qmi_elem_info *ei,
const void *c_struct); const void *c_struct);
void *qmi_encode_message(int type, unsigned int msg_id, size_t *len, void *qmi_encode_message(int type, unsigned int msg_id, size_t *len,
unsigned int txn_id, struct qmi_elem_info *ei, unsigned int txn_id, const struct qmi_elem_info *ei,
const void *c_struct); const void *c_struct);
int qmi_decode_message(const void *buf, size_t len, int qmi_decode_message(const void *buf, size_t len,
struct qmi_elem_info *ei, void *c_struct); const struct qmi_elem_info *ei, void *c_struct);
int qmi_txn_init(struct qmi_handle *qmi, struct qmi_txn *txn, int qmi_txn_init(struct qmi_handle *qmi, struct qmi_txn *txn,
struct qmi_elem_info *ei, void *c_struct); const struct qmi_elem_info *ei, void *c_struct);
int qmi_txn_wait(struct qmi_txn *txn, unsigned long timeout); int qmi_txn_wait(struct qmi_txn *txn, unsigned long timeout);
void qmi_txn_cancel(struct qmi_txn *txn); void qmi_txn_cancel(struct qmi_txn *txn);

10
samples/qmi/qmi_sample_client.c
View File

@ -42,7 +42,7 @@ struct test_name_type_v01 {
char name[TEST_MAX_NAME_SIZE_V01]; char name[TEST_MAX_NAME_SIZE_V01];
}; };
static struct qmi_elem_info test_name_type_v01_ei[] = { static const struct qmi_elem_info test_name_type_v01_ei[] = {
{ {
.data_type = QMI_DATA_LEN, .data_type = QMI_DATA_LEN,
.elem_len = 1, .elem_len = 1,
@ -71,7 +71,7 @@ struct test_ping_req_msg_v01 {
struct test_name_type_v01 client_name; struct test_name_type_v01 client_name;
}; };
static struct qmi_elem_info test_ping_req_msg_v01_ei[] = { static const struct qmi_elem_info test_ping_req_msg_v01_ei[] = {
{ {
.data_type = QMI_UNSIGNED_1_BYTE, .data_type = QMI_UNSIGNED_1_BYTE,
.elem_len = 4, .elem_len = 4,
@ -113,7 +113,7 @@ struct test_ping_resp_msg_v01 {
struct test_name_type_v01 service_name; struct test_name_type_v01 service_name;
}; };
static struct qmi_elem_info test_ping_resp_msg_v01_ei[] = { static const struct qmi_elem_info test_ping_resp_msg_v01_ei[] = {
{ {
.data_type = QMI_STRUCT, .data_type = QMI_STRUCT,
.elem_len = 1, .elem_len = 1,
@ -172,7 +172,7 @@ struct test_data_req_msg_v01 {
struct test_name_type_v01 client_name; struct test_name_type_v01 client_name;
}; };
static struct qmi_elem_info test_data_req_msg_v01_ei[] = { static const struct qmi_elem_info test_data_req_msg_v01_ei[] = {
{ {
.data_type = QMI_DATA_LEN, .data_type = QMI_DATA_LEN,
.elem_len = 1, .elem_len = 1,
@ -224,7 +224,7 @@ struct test_data_resp_msg_v01 {
struct test_name_type_v01 service_name; struct test_name_type_v01 service_name;
}; };
static struct qmi_elem_info test_data_resp_msg_v01_ei[] = { static const struct qmi_elem_info test_data_resp_msg_v01_ei[] = {
{ {
.data_type = QMI_STRUCT, .data_type = QMI_STRUCT,
.elem_len = 1, .elem_len = 1,