aboutsummaryrefslogtreecommitdiffstats
path: root/samsung-ipc/ipc.h
blob: dfeea11308b7c815691880d498ce9855d99ffb31 (plain)
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
 * This file is part of libsamsung-ipc.
 *
 * Copyright (C) 2011 Simon Busch <morphis@gravedo.de>
 * Copyright (C) 2014 Paul Kocialkowski <contact@paulk.fr>
 *
 * libsamsung-ipc is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * libsamsung-ipc 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with libsamsung-ipc.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#include <time.h>

#include <samsung-ipc.h>

#ifndef __IPC_H__
#define __IPC_H__

/*
 * Structures
 */

struct ipc_client_ops {
	int (*boot)(struct ipc_client *client);
	int (*send)(struct ipc_client *client, struct ipc_message *message);
	int (*recv)(struct ipc_client *client, struct ipc_message *message);
};

struct ipc_client_handlers {
	/* Transport handlers */
	int (*open)(struct ipc_client *client, void *transport_data, int type);
	int (*close)(struct ipc_client *client, void *transport_data);

	int (*read)(struct ipc_client *client, void *transport_data,
		    void *buffer, size_t length);
	int (*write)(struct ipc_client *client, void *transport_data,
		     const void *buffer, size_t length);
	int (*poll)(struct ipc_client *client, void *transport_data,
		    struct ipc_poll_fds *fds, struct timeval *timeout);

	void *transport_data;

	/* Power handlers */
	int (*power_on)(struct ipc_client *client, void *power_data);
	int (*power_off)(struct ipc_client *client, void *power_data);

	void *power_data;

	/* GPRS handlers */
	int (*gprs_activate)(struct ipc_client *client, void *gprs_data,
			     unsigned int cid);
	int (*gprs_deactivate)(struct ipc_client *client, void *gprs_data,
			       unsigned int cid);

	void *gprs_data;

	/* Data */
	int (*data_create)(struct ipc_client *client, void **transport_data,
			   void **power_data, void **gprs_data);
	int (*data_destroy)(struct ipc_client *client, void *transport_data,
			    void *power_data, void *gprs_data);
};

struct ipc_client_gprs_specs {
	char *(*gprs_get_iface)(struct ipc_client *client, unsigned int cid);
	int (*gprs_get_capabilities)(
		struct ipc_client *client,
		struct ipc_client_gprs_capabilities *capabilities);
};

struct ipc_client_modem_driver_ops {
	int (*power)(struct ipc_client *client, int device_fd, int power);
	int (*download_enable)(struct ipc_client *client, int device_fd,
			       int enable);
	int (*bus_power)(struct ipc_client *client, int power);
	int (*link_control_enable)(struct ipc_client *client, int device_fd,
				   int enable);
	int (*link_control_active)(struct ipc_client *client, int device_fd,
				   int active);
	int (*link_connected_wait)(struct ipc_client *client, int device_fd);
	int (*link_get_hostwake_wait)(struct ipc_client *client, int device_fd);
	int (*wait_status_online)(
		__attribute__((unused)) struct ipc_client *client,
		int device_fd);
	int (*open)(struct ipc_client *client, int type);
	int (*close)(struct ipc_client *client, int fd);
	int (*read)(struct ipc_client *client, int fd, void *buffer,
		    size_t length);
	int (*write)(struct ipc_client *client, int fd, const void *buffer,
		     size_t length);
	int (*poll)(struct ipc_client *client, int fd, struct ipc_poll_fds *fds,
		    struct timeval *timeout);

	int (*fmt_send)(struct ipc_client *client, struct ipc_message *message);
	int (*fmt_recv)(struct ipc_client *client, struct ipc_message *message);
	int (*rfs_send)(struct ipc_client *client, struct ipc_message *message);
	int (*rfs_recv)(struct ipc_client *client, struct ipc_message *message);
	//TODO: find a better name not to conflict with fmt/rfs send
	//      like block-data send (used for firmware)
	//      what about firmware->MAIN
	//      and data_send firmware_send
	//      or send_partition
	//      or send_block
	int (*data_send)(struct ipc_client *client, int device_fd, const void *data,
			 size_t size, int address);

	char * (*gprs_get_iface)(struct ipc_client *client, unsigned int cid);
	int (*gprs_get_capabilities)(
		struct ipc_client *client,
		struct ipc_client_gprs_capabilities *capabilities);
};


struct ipc_client_nv_data_specs {
	char *nv_data_path;
	char *nv_data_md5_path;
	char *nv_data_backup_path;
	char *nv_data_backup_md5_path;
	char *nv_data_secret;
	size_t nv_data_size;
	size_t nv_data_chunk_size;
};

struct ipc_client {
	int type;

	void (*log_callback)(void *log_data, const char *message);
	void *log_data;

	struct ipc_client_ops *ops;
	struct ipc_client_handlers *handlers;
	struct ipc_client_gprs_specs *gprs_specs;
	struct ipc_client_nv_data_specs *nv_data_specs;
	struct ipc_client_modem_driver_ops *modem_driver_ops;
};

/*
 * Helpers
 */

void ipc_client_log(struct ipc_client *client, const char *message, ...);

#endif /* __IPC_H__ */