1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/* Copyright (c) 2015-2017, The Linux Foundation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 and
* only version 2 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
#ifndef _UAPI_SPCOM_H_
#define _UAPI_SPCOM_H_
#include <linux/types.h> /* uint32_t, bool */
#ifndef BIT
#define BIT(x) (1 << x)
#endif
#ifndef PAGE_SIZE
#define PAGE_SIZE 4096
#endif
/**
* @brief - Secure Processor Communication interface to user space spcomlib.
*
* Sending data and control commands by write() file operation.
* Receiving data by read() file operation.
* Getting the next request size by read() file operation,
* with special size SPCOM_GET_NEXT_REQUEST_SIZE.
*/
/*
* Maximum number of channel between Secure Processor and HLOS.
* including predefined channels, like "sp_kernel".
*/
#define SPCOM_MAX_CHANNELS 0x20
/* Maximum size (including null) for channel names */
#define SPCOM_CHANNEL_NAME_SIZE 32
/*
* file read(fd, buf, size) with this size,
* hints the kernel that user space wants to read the next-req-size.
* This size is bigger than both SPCOM_MAX_REQUEST_SIZE and
* SPCOM_MAX_RESPONSE_SIZE , so it is not a valid data size.
*/
#define SPCOM_GET_NEXT_REQUEST_SIZE (PAGE_SIZE-1)
/* Command Id between spcomlib and spcom driver, on write() */
enum spcom_cmd_id {
SPCOM_CMD_LOAD_APP = 0x4C4F4144, /* "LOAD" = 0x4C4F4144 */
SPCOM_CMD_RESET_SP = 0x52455354, /* "REST" = 0x52455354 */
SPCOM_CMD_SEND = 0x53454E44, /* "SEND" = 0x53454E44 */
SPCOM_CMD_SEND_MODIFIED = 0x534E444D, /* "SNDM" = 0x534E444D */
SPCOM_CMD_LOCK_ION_BUF = 0x4C4F434B, /* "LOCK" = 0x4C4F434B */
SPCOM_CMD_UNLOCK_ION_BUF = 0x554C434B, /* "ULCK" = 0x4C4F434B */
SPCOM_CMD_FSSR = 0x46535352, /* "FSSR" = 0x46535352 */
SPCOM_CMD_CREATE_CHANNEL = 0x43524554, /* "CRET" = 0x43524554 */
};
/*
* @note: Event types that are always implicitly polled:
* POLLERR=0x08 | POLLHUP=0x10 | POLLNVAL=0x20
* so bits 3,4,5 can't be used
*/
enum spcom_poll_events {
SPCOM_POLL_LINK_STATE = BIT(1),
SPCOM_POLL_CH_CONNECT = BIT(2),
SPCOM_POLL_READY_FLAG = BIT(14), /* output */
SPCOM_POLL_WAIT_FLAG = BIT(15), /* if set , wait for the event */
};
/* Common Command structure between User Space and spcom driver, on write() */
struct spcom_user_command {
enum spcom_cmd_id cmd_id;
uint32_t arg;
} __packed;
/* Command structure between User Space and spcom driver, on write() */
struct spcom_send_command {
enum spcom_cmd_id cmd_id;
uint32_t timeout_msec;
uint32_t buf_size;
char buf[0]; /* Variable buffer size - must be last field */
} __packed;
/* Command structure between userspace spcomlib and spcom driver, on write() */
struct spcom_user_create_channel_command {
enum spcom_cmd_id cmd_id;
char ch_name[SPCOM_CHANNEL_NAME_SIZE];
} __packed;
/* maximum ION buf for send-modfied-command */
#define SPCOM_MAX_ION_BUF 4
struct spcom_ion_info {
int32_t fd; /* ION buffer File Descriptor, set -1 for invalid fd */
uint32_t buf_offset; /* virtual address offset in request/response */
};
/* Pass this FD to unlock all ION buffer for the specific channel */
#define SPCOM_ION_FD_UNLOCK_ALL 0xFFFF
struct spcom_ion_handle {
int32_t fd; /* File Descriptor associated with the buffer */
};
/* Command structure between User Space and spcom driver, on write() */
struct spcom_user_send_modified_command {
enum spcom_cmd_id cmd_id;
struct spcom_ion_info ion_info[SPCOM_MAX_ION_BUF];
uint32_t timeout_msec;
uint32_t buf_size;
char buf[0]; /* Variable buffer size - must be last field */
} __packed;
#endif /* _UAPI_SPCOM_H_ */
|
