Real Time Clock Module with I2C Interface  0.3
⇒ back to Project Page
 All Data Structures Files Functions Variables Typedefs Macros Pages
saa1064.c
Go to the documentation of this file.
1 /****************************************************************************/
36 /******************************************
37  \internal
38  Include files
39 *******************************************/
40 
41 
42 #include <avr/pgmspace.h>
43 #include <util/delay.h>
44 
45 #include "basic_definitions.h"
46 #include "i2c.h"
47 #include "saa1064.h"
48 
49 #if GLCD_ENABLED == 1
50 #include <stdlib.h>
51 #include "glcd.h"
52 #endif
53 
54 
55 
56 
57 
58 /****************************************************************************/
89 /****************************************************************************/
90 
91 uint8_t saa1064_init(uint8_t i2c_address, uint8_t display_mode, uint8_t segment_current) {
92 
93 
94  uint8_t return_value;
95  uint8_t i2c_retry_counter;
96  uint8_t i, k;
97  static uint8_t saa1064_data[I2C_SAA1064_NUMBER_REG]; //contains slave address, instruction byte, control byte,
98  //data digit 1, data digit 2, data digit 3, data digit 4
99 
100  //init value
101  return_value = SAA1064_IO_ERROR;
102 
104  if ((i2c_address != I2C_SAA1064_ADDRESS0) &&
105  (i2c_address != I2C_SAA1064_ADDRESS1) &&
106  (i2c_address != I2C_SAA1064_ADDRESS2) &&
107  (i2c_address != I2C_SAA1064_ADDRESS3)) {
108  return SAA1064_WRONG_ADDRESS;
109  }
110 
112  if ((display_mode != SAA1064_STATIC_MODE) &&
113  (display_mode != SAA1064_DYNAMIC_MODE)) {
114  return SAA1064_WRONG_MODE;
115  }
116 
118  if (I2C_SAA1064_NUMBER_REG < 7) {
119  return SAA1064_IO_ERROR;
120  }
121 
122 
124 
125  //if segment current if 0xff, the current value will be changed by an intervall
126  if (segment_current == 0xff) {
127 
128  for (k = 0; k < 3; k++) {
129 
130  for (i = 0; i < 0x08; i++) {
131 
132  //prepare data buffer
133  saa1064_data[0] = i2c_address; //I2C address + Write Bit
134  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
135  saa1064_data[2] = 0x00 | ((i & 0x07) << 4); //instruction byte (SAA1064 register address)
136  saa1064_data[2] = saa1064_data[2] | 0x0e | display_mode; //instruction byte (bits C0, C1, C2, C3, C4)
137  //segment test, all digits are not blanked
138  saa1064_data[3] = 0xff; //digit 1
139  saa1064_data[4] = 0xff; //digit 2
140  saa1064_data[5] = 0xff; //digit 3
141  saa1064_data[6] = 0xff; //digit 4
142 
143  //I2C communication
144  i2c_retry_counter = I2C_MAX_RETRYS;
145  return_value = I2C_IO_ERROR;
146  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
147  return_value = i2c_master_data_io(saa1064_data, 7, FALSE);
148  i2c_retry_counter--;
149  _delay_us(I2C_RETRY_WAIT_US);
150  }
151 
152  //check for success
153  if (return_value != I2C_IO_SUCC) {
154  return return_value; //error occured (bus blocked or no ACK etc.)
155  }
156 
157  //wait for some time
158  _delay_ms(50);
159 
160  }
161 
162  for (i = 0x07; i > 0; i--) {
163 
164  //prepare data buffer
165  saa1064_data[0] = i2c_address; //I2C address + Write Bit
166  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
167  saa1064_data[2] = 0x00 | ((i & 0x07) << 4); //instruction byte (SAA1064 register address)
168  saa1064_data[2] = saa1064_data[2] | 0x0e | display_mode; //instruction byte (bits C0, C1, C2, C3, C4)
169  //segment test, all digits are not blanked
170  saa1064_data[3] = 0xff; //digit 1
171  saa1064_data[4] = 0xff; //digit 2
172  saa1064_data[5] = 0xff; //digit 3
173  saa1064_data[6] = 0xff; //digit 4
174 
175  //I2C communication
176  i2c_retry_counter = I2C_MAX_RETRYS;
177  return_value = I2C_IO_ERROR;
178  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
179  return_value = i2c_master_data_io(saa1064_data, 7, FALSE);
180  i2c_retry_counter--;
181  _delay_us(I2C_RETRY_WAIT_US);
182  }
183 
184  //check for success
185  if (return_value != I2C_IO_SUCC) {
186  return return_value; //error occured (bus blocked or no ACK etc.)
187  }
188 
189  //wait for some time
190  _delay_ms(50);
191 
192  }
193 
194  }
195 
196  } else {
197 
198  //prepare data buffer
199  saa1064_data[0] = i2c_address; //I2C address + Write Bit
200  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
201  saa1064_data[2] = 0x00 | ((segment_current & 0x07) << 4); //instruction byte (SAA1064 register address)
202  saa1064_data[2] = saa1064_data[2] | 0x0e | display_mode; //instruction byte (bits C0, C1, C2, C3, C4)
203  //segment test, all digits are not blanked
204  saa1064_data[3] = 0xff; //digit 1
205  saa1064_data[4] = 0xff; //digit 2
206  saa1064_data[5] = 0xff; //digit 3
207  saa1064_data[6] = 0xff; //digit 4
208 
209  //I2C communication
210  i2c_retry_counter = I2C_MAX_RETRYS;
211  return_value = I2C_IO_ERROR;
212  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
213  return_value = i2c_master_data_io(saa1064_data, 7, FALSE);
214  i2c_retry_counter--;
215  _delay_us(I2C_RETRY_WAIT_US);
216  }
217 
218  //check for success
219  if (return_value != I2C_IO_SUCC) {
220  return return_value; //error occured (bus blocked or no ACK etc.)
221  }
222 
223  }
224 
225 
226  //wait for some time
227  _delay_ms(SAA1064_INIT_DELAY_MS);
228 
229 
231 
232  //prepare data buffer
233  saa1064_data[0] = i2c_address; //I2C address + Write Bit
234  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
235  saa1064_data[2] = 0x00 | ((segment_current & 0x07) << 4); //instruction byte (SAA1064 register address)
236  saa1064_data[2] = saa1064_data[2] | 0x06 | display_mode; //instruction byte (bits C0, C1, C2, C3, C4)
237  //NO segment test, all digits are not blanked
238  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[1]); //digit 1 --> display a "1"
239  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[2]); //digit 2 --> display a "2"
240  saa1064_data[5] = pgm_read_byte(&numbers_bcd_table[3]); //digit 3 --> display a "3"
241  saa1064_data[6] = pgm_read_byte(&numbers_bcd_table[4]); //digit 4 --> display a "4"
242 
243  //I2C communication
244  i2c_retry_counter = I2C_MAX_RETRYS;
245  return_value = I2C_IO_ERROR;
246  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
247  return_value = i2c_master_data_io(saa1064_data, 7, FALSE);
248  i2c_retry_counter--;
249  _delay_us(I2C_RETRY_WAIT_US);
250  }
251 
252  //check for success
253  if (return_value != I2C_IO_SUCC) {
254  return return_value; //error occured (bus blocked or no ACK etc.)
255  }
256 
257  //wait for some time
258  _delay_ms(SAA1064_INIT_DELAY_MS);
259 
260 
262 
263  //prepare data buffer
264  saa1064_data[0] = i2c_address; //I2C address + Write Bit
265  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
266  saa1064_data[2] = 0x00 | ((segment_current & 0x07) << 4); //instruction byte (SAA1064 register address)
267  saa1064_data[2] = saa1064_data[2] | 0x06 | display_mode; //instruction byte (bits C0, C1, C2, C3, C4)
268  //NO segment test, all digits are not blanked
269 
270  for (k = 0; k < SAA1064_DEMO_LOOPS; k++) {
271  for (i = 0; i < 6; i++) {
272 
273  saa1064_data[3] = 1 << i; //digit 1 --> display only one segment
274  saa1064_data[4] = 1 << i; //digit 2 --> display only one segment
275  saa1064_data[5] = 1 << i; //digit 3 --> display only one segment
276  saa1064_data[6] = 1 << i; //digit 4 --> display only one segment
277 
278  //I2C communication
279  i2c_retry_counter = I2C_MAX_RETRYS;
280  return_value = I2C_IO_ERROR;
281  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
282  return_value = i2c_master_data_io(saa1064_data, 7, FALSE);
283  i2c_retry_counter--;
284  _delay_us(I2C_RETRY_WAIT_US);
285  }
286 
287  //check for success
288  if (return_value != I2C_IO_SUCC) {
289  return return_value; //error occured (bus blocked or no ACK etc.)
290  }
291 
292  //wait for some time
293  _delay_ms(SAA1064_DEMO_DELAY_MS);
294 
295  }
296  }
297 
298 
300 
301  //prepare data buffer
302  saa1064_data[0] = i2c_address; //I2C address + Write Bit
303  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
304  saa1064_data[2] = 0x00 | ((segment_current & 0x07) << 4); //instruction byte (SAA1064 register address)
305  saa1064_data[2] = saa1064_data[2] | 0x06 | display_mode; //instruction byte (bits C0, C1, C2, C3, C4)
306  //NO segment test, all digits are not blanked
307  saa1064_data[3] = 0x00; //digit 1
308  saa1064_data[4] = 0x00; //digit 2
309  saa1064_data[5] = 0x00; //digit 3
310  saa1064_data[6] = 0x00; //digit 4
311 
312  //I2C communication
313  i2c_retry_counter = I2C_MAX_RETRYS;
314  return_value = I2C_IO_ERROR;
315  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
316  return_value = i2c_master_data_io(saa1064_data, 7, FALSE);
317  i2c_retry_counter--;
318  _delay_us(I2C_RETRY_WAIT_US);
319  }
320 
321  //check for success
322  if (return_value != I2C_IO_SUCC) {
323  return return_value; //error occured (bus blocked or no ACK etc.)
324  }
325 
326 
327  return SAA1064_IO_SUCCESS;
328 
329 }
330 
331 
332 
333 /****************************************************************************/
359 /****************************************************************************/
360 
361 uint8_t saa1064_read_status(uint8_t i2c_address, uint8_t *register_data) {
362 
363  uint8_t return_value;
364  uint8_t i2c_retry_counter;
365  uint8_t i;
366  static uint8_t saa1064_data[I2C_SAA1064_NUMBER_STAT]; //contains slave address and address byte
367 
368  //init value
369  return_value = SAA1064_IO_ERROR;
370 
372  if ((i2c_address != I2C_SAA1064_ADDRESS0) &&
373  (i2c_address != I2C_SAA1064_ADDRESS1) &&
374  (i2c_address != I2C_SAA1064_ADDRESS2) &&
375  (i2c_address != I2C_SAA1064_ADDRESS3)) {
376  return SAA1064_WRONG_ADDRESS;
377  }
378 
379 
381  if (I2C_SAA1064_NUMBER_STAT < 2) {
382  return SAA1064_IO_ERROR;
383  }
384 
385 
387 
388  //prepare data buffer for setting read address
389  saa1064_data[0] = i2c_address; //I2C address + Write Bit
390  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
391 
392  //I2C communication
393  i2c_retry_counter = I2C_MAX_RETRYS;
394  return_value = I2C_IO_ERROR;
395  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
396  return_value = i2c_master_data_io(saa1064_data, 2, FALSE);
397  i2c_retry_counter--;
398  _delay_us(I2C_RETRY_WAIT_US);
399  }
400 
401  //check for success
402  if (return_value != I2C_IO_SUCC) {
403  return return_value; //error occured (bus blocked or no ACK etc.)
404  }
405 
406 
408 
409  //prepare data buffer
410  saa1064_data[0] = i2c_address | 0x01; //I2C address + Read Bit
411 
412  //I2C communication
413  i2c_retry_counter = I2C_MAX_RETRYS;
414  return_value = I2C_IO_ERROR;
415  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
416  return_value = i2c_master_data_io(saa1064_data, I2C_SAA1064_NUMBER_STAT, FALSE);
417  i2c_retry_counter--;
418  _delay_us(I2C_RETRY_WAIT_US);
419  }
420 
421  //check for success
422  if (return_value != I2C_IO_SUCC) {
423  return return_value; //error occured (bus blocked or no ACK etc.)
424  }
425 
426  //copy received data into output buffer
427  for (i = 0; i < I2C_SAA1064_NUMBER_STAT; i++) {
428  register_data[i] = saa1064_data[i];
429  }
430 
431 
432  return SAA1064_IO_SUCCESS;
433 
434 }
435 
436 
437 
438 /****************************************************************************/
467 /****************************************************************************/
468 
469 uint8_t saa1064_send_digits(uint8_t i2c_address, uint8_t display_mode, uint8_t segment_current,
470  uint16_t figure, uint8_t decimal_points, uint8_t clear) {
471 
472 
473  uint8_t return_value;
474  uint8_t i2c_retry_counter;
475  uint16_t digit;
476  static uint8_t saa1064_data[I2C_SAA1064_NUMBER_REG]; //contains slave address and address byte
477 
478  //init value
479  return_value = SAA1064_IO_ERROR;
480 
482  if ((i2c_address != I2C_SAA1064_ADDRESS0) &&
483  (i2c_address != I2C_SAA1064_ADDRESS1) &&
484  (i2c_address != I2C_SAA1064_ADDRESS2) &&
485  (i2c_address != I2C_SAA1064_ADDRESS3)) {
486  return SAA1064_WRONG_ADDRESS;
487  }
488 
489 
491  if (I2C_SAA1064_NUMBER_REG < 7) {
492  return SAA1064_IO_ERROR;
493  }
494 
496 
497  //prepare data buffer
498  saa1064_data[0] = i2c_address; //I2C address + Write Bit
499  saa1064_data[1] = 0x00; //instruction byte (SAA1064 register address)
500  saa1064_data[2] = 0x00 | ((segment_current & 0x07) << 4); //instruction byte (SAA1064 register address)
501  saa1064_data[2] = saa1064_data[2] | 0x06 | display_mode; //instruction byte (bits C0, C1, C2, C3, C4)
502  //NO segment test, all digits are not blanked
503 
504  //fill data depending on mode
505  if (clear > 0) {
506 
507  if (display_mode == SAA1064_STATIC_MODE) {
508 
509  digit = figure % 10;
510  if ((decimal_points & 0x01) > 0) { //decimal point for digit requested?
511  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_DECIMAL_POINT_VALUE]); //digit 1
512  } else {
513  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_OFF_VALUE]); //digit 1
514  }
515  digit = figure % 100 / 10;
516  if ((decimal_points & 0x02) > 0) { //decimal point for digit requested?
517  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_DECIMAL_POINT_VALUE]); //digit 2
518  } else {
519  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_OFF_VALUE]); //digit 2
520  }
521  saa1064_data[5] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_ERROR_VALUE]); //digit 3 --> display a "-"
522  saa1064_data[6] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_ERROR_VALUE]); //digit 4 --> display a "-"
523 
524  } else {
525 
526  digit = figure % 10;
527  if ((decimal_points & 0x01) > 0) { //decimal point for digit requested?
528  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_DECIMAL_POINT_VALUE]); //digit 1
529  } else {
530  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_OFF_VALUE]); //digit 1
531  }
532  digit = figure % 100 / 10;
533  if ((decimal_points & 0x02) > 0) { //decimal point for digit requested?
534  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_DECIMAL_POINT_VALUE]); //digit 2
535  } else {
536  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_OFF_VALUE]); //digit 2
537  }
538  digit = figure % 1000 / 100;
539  if ((decimal_points & 0x04) > 0) { //decimal point for digit requested?
540  saa1064_data[5] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_DECIMAL_POINT_VALUE]); //digit 4
541  } else {
542  saa1064_data[5] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_OFF_VALUE]); //digit 4
543  }
544  digit = figure % 10000 / 1000;
545  if ((decimal_points & 0x08) > 0) { //decimal point for digit requested?
546  saa1064_data[6] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_DECIMAL_POINT_VALUE]); //digit 5
547  } else {
548  saa1064_data[6] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_OFF_VALUE]); //digit 5
549  }
550 
551  }
552 
553  } else if (display_mode == SAA1064_STATIC_MODE) {
554 
555  digit = figure % 10;
556  if ((decimal_points & 0x01) > 0) { //decimal point for digit requested?
557  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[digit + BCD_DECIMAL_POINT_OFFSET]); //digit 1
558  } else {
559  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[digit]); //digit 1
560  }
561  digit = figure % 100 / 10;
562  if ((decimal_points & 0x02) > 0) { //decimal point for digit requested?
563  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[digit + BCD_DECIMAL_POINT_OFFSET]); //digit 2
564  } else {
565  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[digit]); //digit 2
566  }
567  saa1064_data[5] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_ERROR_VALUE]); //digit 3 --> display a "-"
568  saa1064_data[6] = pgm_read_byte(&numbers_bcd_table[BCD_TABLE_ERROR_VALUE]); //digit 4 --> display a "-"
569 
570  } else {
571 
572  digit = figure % 10;
573  if ((decimal_points & 0x01) > 0) { //decimal point for digit requested?
574  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[digit + BCD_DECIMAL_POINT_OFFSET]); //digit 1
575  } else {
576  saa1064_data[3] = pgm_read_byte(&numbers_bcd_table[digit]); //digit 1
577  }
578  digit = figure % 100 / 10;
579  if ((decimal_points & 0x02) > 0) { //decimal point for digit requested?
580  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[digit + BCD_DECIMAL_POINT_OFFSET]); //digit 2
581  } else {
582  saa1064_data[4] = pgm_read_byte(&numbers_bcd_table[digit]); //digit 2
583  }
584  digit = figure % 1000 / 100;
585  if ((decimal_points & 0x04) > 0) { //decimal point for digit requested?
586  saa1064_data[5] = pgm_read_byte(&numbers_bcd_table[digit + BCD_DECIMAL_POINT_OFFSET]); //digit 4
587  } else {
588  saa1064_data[5] = pgm_read_byte(&numbers_bcd_table[digit]); //digit 4
589  }
590  digit = figure % 10000 / 1000;
591  if ((decimal_points & 0x08) > 0) { //decimal point for digit requested?
592  saa1064_data[6] = pgm_read_byte(&numbers_bcd_table[digit + BCD_DECIMAL_POINT_OFFSET]); //digit 5
593  } else {
594  saa1064_data[6] = pgm_read_byte(&numbers_bcd_table[digit]); //digit 5
595  }
596 
597  }
598 
599  //I2C communication
600  i2c_retry_counter = I2C_MAX_RETRYS;
601  return_value = I2C_IO_ERROR;
602  while (return_value != I2C_IO_SUCC && i2c_retry_counter > 0) {
603  return_value = i2c_master_data_io(saa1064_data, 7, FALSE);
604  i2c_retry_counter--;
605  _delay_us(I2C_RETRY_WAIT_US);
606  }
607 
608  //check for success
609  if (return_value != I2C_IO_SUCC) {
610  return return_value; //error occured (bus blocked or no ACK etc.)
611  }
612 
613  return SAA1064_IO_SUCCESS;
614 
615 }