summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/HAL/avr/common/src/i2cPacket.c
blob: 340981e1ccd39ebb1032d864436997f180917ec9 (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
/**************************************************************************//**
  \file  i2cPacket.c

  \brief Provides the functionality for the writing and the reading \n
         of packets through the TWI.

  \author
      Atmel Corporation: http://www.atmel.com \n
      Support email: avr@atmel.com

    Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
    Licensed under Atmel's Limited License Agreement (BitCloudTM).

  \internal
    History:
      5/12/07 A. Khromykh - Created
 ******************************************************************************/
/******************************************************************************
 *   WARNING: CHANGING THIS FILE MAY AFFECT CORE FUNCTIONALITY OF THE STACK.  *
 *   EXPERT USERS SHOULD PROCEED WITH CAUTION.                                *
 ******************************************************************************/

/******************************************************************************
                   Includes section
******************************************************************************/
#include <types.h>
#include <i2cPacket.h>
#include <i2c.h>
#include <halTaskManager.h>

/******************************************************************************
                   Define(s) section
******************************************************************************/
/* states of the i2c transaction */
#define I2C_CLOSE                    0
#define I2C_IDLE                     1
#define I2C_WRITE_IADDR_WRITE_DATA   2
#define I2C_WRITE_IADDR_READ_DATA    3
#define I2C_WRITE_DATA               4
#define I2C_READ_DATA                5
#define I2C_TRANSAC_SUCCESS          6
#define I2C_TRANSAC_FAIL             7

/******************************************************************************
                   Types section
******************************************************************************/
typedef struct
{
  volatile uint8_t* data;             // bytes to write to the i2c bus
  volatile uint8_t length;            // length in bytes of the request
  volatile uint8_t index;             // current index of read/write byte
  volatile uint8_t addr;              // destination address
  volatile uint32_t intAddress;       // internal address inner i2c device
  void (*done)(bool result);          // callback
} HalI2cPacketControl_t;

/******************************************************************************
                   Global variables section
******************************************************************************/
// current state of the i2c request
volatile uint8_t halI2cPacketState = I2C_CLOSE;
HalI2cPacketControl_t halI2cPacketControl;

/******************************************************************************
                   Implementations section
******************************************************************************/
/******************************************************************************
Resets TWI bus and i2c HAL.
******************************************************************************/
void halI2cBusReset(void)
{
  halI2cPacketState = I2C_TRANSAC_FAIL;
  halResetI2c();
  halPostTask4(HAL_TWI);
}

/******************************************************************************
Opens resource.
Parameters:
  i2cMode - pointer to clock rate structure.
Returns:
  Returns:
  -1 - resource was opened or pointer is NULL
   0 - success.
******************************************************************************/
int HAL_OpenI2cPacket(HAL_i2cMode_t *i2cMode)
{
  if (NULL == i2cMode)
    return -1;
  if (I2C_CLOSE == halI2cPacketState)
  {
    halInitI2c(i2cMode);
    halI2cPacketState = I2C_IDLE;
    halI2cPacketControl.index = 0;
    return 0;
  }
  return -1;
}

/******************************************************************************
Closes resource.
Returns:
  -1 - resource was not opened.
  0 -  success.
******************************************************************************/
int HAL_CloseI2cPacket(void)
{
  if (I2C_CLOSE != halI2cPacketState)
  {
    halI2cPacketControl.done = NULL;
    halI2cPacketState = I2C_CLOSE;
    return 0;
  }
  return -1;
}

/******************************************************************************
Writes the series of bytes out to the TWI bus.
Parameters:
  param - pointer to HAL_I2cParams_t structure
Returns:
  0 - the bus is free and the request is accepted.
  -1 - other case.
******************************************************************************/
int HAL_WriteI2cPacket(HAL_I2cParams_t *param)
{
  if ((I2C_IDLE == halI2cPacketState) && param)
  {
    halI2cPacketControl.addr = param->id;
    halI2cPacketControl.data = param->data;
    halI2cPacketControl.index = param->lengthAddr;
    halI2cPacketControl.length = param->length;
    halI2cPacketControl.done = param->f;
    halI2cPacketControl.intAddress = param->internalAddr;
  }
  else
  {
    return -1;
  }

  if (HAL_NO_INTERNAL_ADDRESS == halI2cPacketControl.index)
    halI2cPacketState = I2C_WRITE_DATA;
  else
    halI2cPacketState = I2C_WRITE_IADDR_WRITE_DATA;
  halSendStartI2c();
  return 0;
}

/******************************************************************************
Reads the series of bytes out to the TWI bus.
Parameters:
  param - pointer to HAL_I2cParams_t structure
Returns:
  0 - the bus is free and the request is accepted.
  -1 - other case.
******************************************************************************/
int HAL_ReadI2cPacket(HAL_I2cParams_t *param)
{
  if ((I2C_IDLE == halI2cPacketState) && param)
  {
    halI2cPacketControl.addr = param->id;
    halI2cPacketControl.index = param->lengthAddr;
    halI2cPacketControl.length = param->length;
    halI2cPacketControl.data = param->data;
    halI2cPacketControl.done = param->f;
    halI2cPacketControl.intAddress = param->internalAddr;
  }
  else
  {
    return -1;
  }

  if (HAL_NO_INTERNAL_ADDRESS == halI2cPacketControl.index)
    halI2cPacketState = I2C_READ_DATA;
  else
    halI2cPacketState = I2C_WRITE_IADDR_READ_DATA;
  halSendStartI2c();
  return 0;
}

/******************************************************************************
Notification about the start condition was sent.
Parameters:
  none.
Returns:
  none.
******************************************************************************/
void halSendStartDoneI2c(void)
{
  if ((I2C_WRITE_IADDR_WRITE_DATA == halI2cPacketState) ||
      (I2C_WRITE_IADDR_READ_DATA == halI2cPacketState) ||
      (I2C_WRITE_DATA == halI2cPacketState))
  {
    halWriteI2c(((halI2cPacketControl.addr << 1) + 0));
  }
  else if (I2C_READ_DATA == halI2cPacketState)
  {
    halWriteI2c(((halI2cPacketControl.addr << 1) + 1));
  }
  else
  { // abnormal
    halI2cBusReset();
  }
}

/******************************************************************************
Sending data to i2c bus. If last byte then send stop condition and post task.
Parameters:
  none.
Returns:
  none.
******************************************************************************/
void halWriteData(void)
{
  if (halI2cPacketControl.index < halI2cPacketControl.length)
  {
    halWriteI2c(halI2cPacketControl.data[halI2cPacketControl.index++]);
  }
  else
  {
    halI2cPacketState = I2C_TRANSAC_SUCCESS;
    halSendStopI2c();
    halPostTask4(HAL_TWI);
  }
}

/******************************************************************************
Sending internal device address to i2c bus. If address is sent then switch i2c
hal state.
Parameters:
  none.
Returns:
  none.
******************************************************************************/
void halWriteInternalAddress(void)
{
  uint8_t data;

  data = (uint8_t)(halI2cPacketControl.intAddress >> --halI2cPacketControl.index * 8);
  halWriteI2c(data);

  if (0 == halI2cPacketControl.index)
  {
    if (I2C_WRITE_IADDR_WRITE_DATA == halI2cPacketState)
      halI2cPacketState = I2C_WRITE_DATA;
    else
      halI2cPacketState = I2C_READ_DATA;
  }
}

/******************************************************************************
Notification that byte was written to the TWI.
Parameters:
  result - contains result of previous operation.
Returns:
  none.
******************************************************************************/
void halWriteDoneI2c(void)
{
  if (I2C_WRITE_DATA == halI2cPacketState)
  {
    halWriteData();
  }
  else if ((I2C_WRITE_IADDR_WRITE_DATA == halI2cPacketState) || (I2C_WRITE_IADDR_READ_DATA == halI2cPacketState))
  {
    halWriteInternalAddress();
  }
  else if (I2C_READ_DATA == halI2cPacketState)
  {
    halSendStartI2c();
  }
  else
  { // abnormal
    halI2cBusReset();
  }
}

/******************************************************************************
Notification that address byte was written to the TWI and was read ACK.
Starts reading data.
Parameters:
  none.
Returns:
  none.
******************************************************************************/
void halMasterReadWriteAddressAckI2c(void)
{
  if (I2C_READ_DATA == halI2cPacketState)
  {
    if (1 == halI2cPacketControl.length)
      halReadI2c(false); // send nack
    else
      halReadI2c(true);  // send ack
  }
  else
  { // abnormal
    halI2cBusReset();
  }
}

/******************************************************************************
Notification that byte was read from the TWI.
Parameters:
  data - contains byte that was read.
Returns:
  none.
******************************************************************************/
void halReadDoneI2c(uint8_t data)
{
  if (I2C_READ_DATA == halI2cPacketState)
  {
    halI2cPacketControl.data[halI2cPacketControl.index++] = data;
    if (halI2cPacketControl.index < (halI2cPacketControl.length - 1))
      halReadI2c(true);  // send ACK
    else
      halReadI2c(false); // send NACK
  }
  else
  { // abnormal
    halI2cBusReset();
  }
}

/******************************************************************************
Notification that last byte was read from the TWI. Needs send STOP condition
on bus.
Parameters:
  data - contains byte that was read.
Returns:
  none.
******************************************************************************/
void halReadLastByteDoneI2c(uint8_t data)
{
  if (I2C_READ_DATA == halI2cPacketState)
  {
    halI2cPacketControl.data[halI2cPacketControl.index++] = data;
    halI2cPacketState = I2C_TRANSAC_SUCCESS;
    halSendStopI2c();
    halPostTask4(HAL_TWI);
  }
  else
  { // abnormal
    halI2cBusReset();
  }
}

/******************************************************************************
Waits for end of sending and calls user's callback
******************************************************************************/
void halSig2WireSerialHandler(void)
{
  if (halI2cPacketControl.done)
  {
    if (I2C_TRANSAC_SUCCESS == halI2cPacketState)
    {
      halWaitEndOfStopStation();
      halI2cPacketState = I2C_IDLE;
      halI2cPacketControl.done(true);
    }
    else
    {
      halI2cPacketState = I2C_IDLE;
      halI2cPacketControl.done(false);
    }
  }
  else
  {
    halI2cPacketState = I2C_IDLE;
  }
}
// eof i2cPacket.c