summaryrefslogtreecommitdiff
path: root/drivers/char/modem_interface/boot_protocol.c
blob: ebb96a63d3f962e9e162dedf47067423778e9faf (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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
/*
 *  kernel/driver/char/modem_interface/boot_protocol.c
 *
 *  Generic modem boot protocol
 *
 *  Author:     Jiayong Yang(Jiayong.Yang@spreadtrum.com)
 *  Created:    Jul 27, 2012
 *  Copyright:  Spreadtrum Inc.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 */
/* #define DEBUG */
/* #define VERBOSE_DEBUG */

#include <linux/init.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/semaphore.h>
#include <linux/irqflags.h>
#include "modem_buffer.h"
#include "modem_interface_driver.h"

#define SETUP_PACKET_SIZE 8
#define ACK_PACKET_SIZE 6
typedef struct dl_setup_packet{
	unsigned short	data_packet_size;
	unsigned short  data_type;
	unsigned short  data_check_sum;
	unsigned short  setup_check_sum;
}	SETUP_PACKET_T;
typedef enum   MBUS_DL_status{
	MBUS_DL_IDLE,
	MBUS_DL_WAIT_REQ,
	MBUS_DL_WAIT_RTS,
	MBUS_DL_SETUP,
	MBUS_DL_SETUP_COMP,
	MBUS_DL_DATA,
	MBUS_DL_DATA_COMP,
	MBUS_DL_ACK
}DL_STATUS_E;


extern void modem_intf_ctrl_gpio_handle_boot(int status);
extern int dloader_abort();

char *boot_status_string(DL_STATUS_E status)
{
	switch(status){
		case MBUS_DL_IDLE: return "DL_IDLE";
		case MBUS_DL_WAIT_REQ: return "DL_WAIT_REQ";
		case MBUS_DL_WAIT_RTS: return "DL_WAIT_RTS";
		case MBUS_DL_SETUP: return "DL_SETUP";
		case MBUS_DL_SETUP_COMP: return "DL_SETUP_COMP";
		case MBUS_DL_DATA: return "DL_DATA";
		case MBUS_DL_DATA_COMP: return "DL_DATA_COMP";
		case MBUS_DL_ACK: return "DL_ACK";
		default: break;
	}
	return "UNKNOWN status";
}



static void boot_idle(struct modem_message_node *msg,struct modem_intf_device *device)
{
	int send_bffer_index=0xFF;
	switch(msg->type){
		case MODEM_SLAVE_RTS:
			device->status = (int)MBUS_DL_WAIT_REQ;
		break;
		case MODEM_TRANSFER_REQ:
			send_bffer_index = pingpang_buffer_send(&device->send_buffer);
			if (send_bffer_index!= 0xFF) {
				device->out_transfering = send_bffer_index;
				device->status = (int)MBUS_DL_WAIT_RTS;
			}
		break;
		case MODEM_SET_MODE:
            modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		default:
		break;
	}
}
static void boot_wait_request(struct modem_message_node *msg,struct modem_intf_device *device)
{
	int send_bffer_index=0xFF;
	switch(msg->type){
		case MODEM_TRANSFER_REQ:
			send_bffer_index = pingpang_buffer_send(&device->send_buffer);
			if(send_bffer_index!= 0xFF){
				device->out_transfering = send_bffer_index;
				device->op->write(device->send_buffer.buffer[send_bffer_index].addr,SETUP_PACKET_SIZE);
				device->status = (int)MBUS_DL_SETUP;
			}
		break;
		case MODEM_SET_MODE:
			modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		case MODEM_TRANSFER_END:
		break;
		default:
		break;
	}
}
static void boot_wait_RTS(struct modem_message_node *msg,struct modem_intf_device *device)
{
	int send_bffer_index=0xFF;
	unsigned short *data;
	switch(msg->type){
		case MODEM_SLAVE_RTS:
			if(device->out_transfering < 2){
				send_bffer_index = device->out_transfering;
				data = (unsigned short *)device->send_buffer.buffer[send_bffer_index].addr;
				device->op->write((char *)data,SETUP_PACKET_SIZE);
				device->status = (int)MBUS_DL_SETUP;
			}
		break;
		case MODEM_TRANSFER_REQ:
			device->out_transfer_pending = 1;
		break;
		case MODEM_SET_MODE:
			modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		default:
		break;
	}
}
static void boot_setup(struct modem_message_node *msg,struct modem_intf_device *device)
{
	int send_bffer_index=0xFF;
	char *buffer;
	int size;
	switch(msg->type){
		case MODEM_TRANSFER_END:
			device->status = (int)MBUS_DL_SETUP_COMP;
		break;
		case MODEM_TRANSFER_REQ:
			device->out_transfer_pending = 1;
		break;
		case MODEM_SLAVE_RTS:
			if(device->out_transfering < 2){
				send_bffer_index = device->out_transfering;
				buffer = &device->send_buffer.buffer[send_bffer_index].addr[SETUP_PACKET_SIZE];
				size = device->send_buffer.buffer[send_bffer_index].write_point;
				if (size <= SETUP_PACKET_SIZE)
					size =  12;
					device->op->write(buffer,size - SETUP_PACKET_SIZE);
					pingpang_buffer_send_complete(&device->send_buffer,device->out_transfering);
					device->out_transfering = 0xFF;
					device->status = (int)MBUS_DL_DATA;
				}
				if(device->out_transfer_pending){
					send_bffer_index = pingpang_buffer_send(&device->send_buffer);
					if(send_bffer_index!= 0xFF){
						device->out_transfering = send_bffer_index;
						size = device->send_buffer.buffer[send_bffer_index].write_point;
						device->op->write(device->send_buffer.buffer[send_bffer_index].addr,size);
					}
					device->out_transfer_pending = 0;
				}
		break;
		case MODEM_SET_MODE:
			modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		default:
		break;
	}
}

static void boot_setup_comp(struct modem_message_node *msg,struct modem_intf_device *device)
{
	int send_bffer_index=0xFF;
	char *buffer;
	int size;

	switch(msg->type){
		case MODEM_SLAVE_RTS:
			if(device->out_transfering < 2){
				send_bffer_index = device->out_transfering;
				buffer = &device->send_buffer.buffer[send_bffer_index].addr[SETUP_PACKET_SIZE];
				size = device->send_buffer.buffer[send_bffer_index].write_point;
				if (size <= SETUP_PACKET_SIZE)
					size =  12;
				device->op->write(buffer,size - SETUP_PACKET_SIZE);
				device->status = (int)MBUS_DL_DATA;
				if(device->out_transfer_pending){
					pingpang_buffer_send_complete(&device->send_buffer,device->out_transfering);
					device->out_transfering = 0xFF;
					send_bffer_index = pingpang_buffer_send(&device->send_buffer);
					if(send_bffer_index!= 0xFF){
						device->out_transfering = send_bffer_index;
						size = device->send_buffer.buffer[send_bffer_index].write_point;
						device->op->write(device->send_buffer.buffer[send_bffer_index].addr,size);
					}
					device->out_transfer_pending = 0;
				}
			}
		break;
		case MODEM_TRANSFER_REQ:
			device->out_transfer_pending = 1;
		break;
		case MODEM_SET_MODE:
			modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		default:
		break;

	}
}
static void boot_data(struct modem_message_node *msg,struct modem_intf_device *device)
{
	unsigned short *data;
	int send_bffer_index=0xFF;
	char *buffer;
	int size;
	switch(msg->type){
		case MODEM_TRANSFER_END:
			if(device->out_transfering < 2){
				pingpang_buffer_send_complete(&device->send_buffer,device->out_transfering);
				device->out_transfering = 0xFF;
				device->status = (int)MBUS_DL_DATA_COMP;
			}
		break;
		case MODEM_TRANSFER_REQ:
			if(device->out_transfering < 2){
				pingpang_buffer_send_complete(&device->send_buffer,device->out_transfering);
				device->out_transfering = 0xFF;
			}
			send_bffer_index = pingpang_buffer_send(&device->send_buffer);
			if(send_bffer_index!= 0xFF){
				device->out_transfering = send_bffer_index;
				size = device->send_buffer.buffer[send_bffer_index].write_point;
				device->op->write(device->send_buffer.buffer[send_bffer_index].addr,size);
			}
		break;
	        case MODEM_SLAVE_RTS:
			pingpang_buffer_send_complete(&device->send_buffer,device->out_transfering);
                        device->op->read(device->recv_buffer.buffer[1].addr,8);
			device->out_transfering = 0xFF;
			data = (unsigned short *)device->recv_buffer.buffer[1].addr;
                        device->status = (int)MBUS_DL_ACK;
			if(device->out_transfer_pending){
				send_bffer_index = pingpang_buffer_send(&device->send_buffer);
				if(send_bffer_index!= 0xFF){
					device->out_transfering = send_bffer_index;
					size = device->send_buffer.buffer[send_bffer_index].write_point;
					device->op->write(device->send_buffer.buffer[send_bffer_index].addr,size);
				}
				device->out_transfer_pending = 0;
			}
		break;
		case MODEM_SET_MODE:
			modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		default:
		break;
	}
}
static void boot_data_comp(struct modem_message_node *msg,struct modem_intf_device *device)
{
	unsigned short *data;
	switch(msg->type){
		case MODEM_SLAVE_RTS:
			device->op->read(device->recv_buffer.buffer[1].addr,8);
			data = (unsigned short *)device->recv_buffer.buffer[1].addr;
			device->status = (int)MBUS_DL_ACK;
		break;
		case MODEM_TRANSFER_REQ:
			device->out_transfer_pending = 1;
		break;
		case MODEM_SET_MODE:
			modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		default:
		break;
	}
}
static void boot_ack(struct modem_message_node *msg,struct modem_intf_device *device)
{
	int send_bffer_index=0xFF;
	unsigned short *data;

	switch(msg->type){
		case MODEM_TRANSFER_END:
			save_to_receive_buffer(&device->recv_buffer,device->recv_buffer.buffer[1].addr,ACK_PACKET_SIZE);
			if(device->out_transfer_pending){
				device->out_transfer_pending = 0;
				device->out_transfering = send_bffer_index = pingpang_buffer_send(&device->send_buffer);
				if(device->out_transfering!=0xff){
					device->status = (int)MBUS_DL_WAIT_RTS;
					break;
				}
			}
			device->status = (int)MBUS_DL_IDLE;
		break;
		case MODEM_TRANSFER_REQ:
			device->out_transfer_pending = 1;
		break;
		case MODEM_SLAVE_RTS:
			data = (unsigned short *)device->recv_buffer.buffer[1].addr;
			save_to_receive_buffer(&device->recv_buffer,data,ACK_PACKET_SIZE);
			if(device->out_transfer_pending){
				device->out_transfer_pending = 0;
				device->out_transfering = send_bffer_index = pingpang_buffer_send(&device->send_buffer);

				data = (unsigned short *)device->send_buffer.buffer[send_bffer_index].addr;
				device->op->write((char *)data,SETUP_PACKET_SIZE);

				device->status = (int)MBUS_DL_SETUP;
			} else {
				device->status = (int)MBUS_DL_WAIT_REQ;
			}
		break;
		case MODEM_SET_MODE:
			modem_intf_set_mode(msg->parameter2, 1);
			device->status = (int)MBUS_DL_IDLE;
			device->out_transfering = 0;
                        dloader_abort();
		break;
		default:
		break;
	}
}
extern unsigned long sprd_get_system_tick(void);
extern void dloader_record_timestamp(unsigned long time);

void boot_protocol_process_dl_messages(struct modem_intf_device *device,
    struct modem_message_node *msg)
{
    DL_STATUS_E	status;

    status =(DL_STATUS_E) device->status;

    switch(status){
		case MBUS_DL_IDLE:
			boot_idle(msg,device);
		break;
		case MBUS_DL_SETUP:
			boot_setup(msg,device);
		break;
		case MBUS_DL_WAIT_REQ:
			boot_wait_request(msg,device);
		break;
		case MBUS_DL_WAIT_RTS:
			boot_wait_RTS(msg,device);
		break;
		case MBUS_DL_SETUP_COMP:
			boot_setup_comp(msg,device);
		break;
		case MBUS_DL_DATA:
			boot_data(msg,device);
		break;
		case MBUS_DL_DATA_COMP:
			boot_data_comp(msg,device);
		break;
		case MBUS_DL_ACK:
			boot_ack(msg,device);
		break;
	}
}

void boot_protocol(struct modem_message_node *msg)
{
	struct modem_intf_device *device;

	if((msg == NULL)||(msg->parameter1==0))
		return;

	device = (struct modem_intf_device *)msg->parameter1;

	printk(">>boot entry(%d,%d) status: %s message: %s \n",
        device->out_transfer_pending,device->out_transfering,
        boot_status_string((DL_STATUS_E )device->status),
        modem_intf_msg_string(msg->type));

    //filter messages
    switch(msg->type){
        case MODEM_CTRL_GPIO_CHG:
            modem_intf_ctrl_gpio_handle_boot(msg->parameter2);
            break;
        case MODEM_USER_REQ:
            //now, just ignore user req in boot mode
            break;
        case MODEM_BOOT_CMP:
            modem_intf_set_mode(MODEM_MODE_BOOTCOMP, 0);
            break;
        default:
            //all other messages
            boot_protocol_process_dl_messages(device, msg);
            break;
    }

}