- extern QQ_detect_slave_init
- extern QQ_i2csu_read_begin
- extern QQ_i2csu_read_another
-
;######################################################################
; i2clib.inc - I2C LIBRARY - DECLARATIONS AND DOCUMENTATION
;
; COMMON ADMINISTRATIVE ROUTINES
;--------------------
- extern i2cm_init
+ extern i2cm_init
;
; Initialises the i2c system for use by a master PIC. Must be called
; exactly once, which must be before any other i2c?_... function.
; State Not-in-use Idle (as master)
;--------------------
- extern i2cs_init
+ extern i2cs_init
;
; Initialises the i2c system for use by a slave PIC. Must be called
; exactly once, which must be before any other i2c?_... function.
; W slave number any
;--------------------
- extern i2cm_interrupt
- extern i2cm_interrupt_definite
- extern i2cs_interrupt
+ extern i2cm_interrupt
+ extern i2cm_interrupt_definite
+ extern i2cs_interrupt
;
; Must be called by the main program's interrupt handler;
; high-priority for the slave or low-priority for the master.
; [*] The interrupt event on entry, if any, will be dealt with. If
; interrupt processing takes a long time, another interrupt will occur
; and this may result in the i2c interrupt flag being set on return
-; from i2c?_inerrupt.
+; from i2c?_interrupt.
;======================================================================
; // \ ,------------------<---. | |
; // \ | | | |
; VV VV | | |
-; [Writing-Setup] [Reading-Busy]<---------. | | |
-; | | | | | |
-; write_next_byte| |read_got_byte | | | |
-; must return NZ | | | | | |
-; V V | | | |
-; ,-->[Writing] [Reading-Wait] | | | |
-; `-------' \ / || `.___________,' | | |
-; write_next_byte \ / || read_another | | |
-; returns NZ | / || | | |
-; | / |`.__________________,' | |
-; | | | read_start | |
-; write_next_byte| | `._____________________,' |
-; returns Z | | write_start |
-; | |read_done |
-; V V |
+; [Writing-Setup] [Reading-Busy]<----------. | | |
+; | | | | | | |
+; | | | | | | |
+; | slave_no_ack| | | | | |
+; | (1st | | | | | |
+; write_next_byte| byte / |read_got_byte | | | |
+; must return NZ | only)/ | | | | |
+; V / V | | | |
+; ,-->[Writing] / [Reading-Wait] | | | |
+; `-------' \ | / || `.___________,' | | |
+; write_next_byte \ | / || read_another | | |
+; returns NZ | | / || | | |
+; | | / |`.__________________,' | |
+; | | | | read_start | |
+; write_next_byte| | | `._____________________,' |
+; returns Z | | | write_start |
+; | | |read_done |
+; V V V |
; [Stopping] |
; | done |
; `-------------------------------------'
;--------------------
- extern i2cmu_done
+ extern i2cmu_done
; Called to notify that the previous conversation with the slave has
; been finished as requested. The i2c system is now available and
; i2cm_*_start can be called.
;
-; (Note: If this arrangment means that main program ends up needing to
-; keep track of whether the I2C is Idle or not, it would probably be
-; straightforward to enhance the interface to be enhanced to make that
-; unnecessary, since this information is already tracked by i2clib.)
-;
; Beforehand At call
; State Stopping Idle
+;--------------------
+ extern i2cmu_slave_no_ack
+
+; Called to notify that the slave did not acknowledge its address when
+; we attempted to read from it. The i2c system is now clearing down
+; the i2c bus to prepare for another transaction.
+;
+; Beforehand At call
+; State Reading-Busy* Stopping
+;
+; * only Reading-Busy reached by calling read_start;
+; not Reading-Busy due to read_another.
+
;========================================
; MASTER - WRITES (ie, transmission of data to the slave)
;--------------------
- extern i2cm_write_start
+ extern i2cm_write_start
;
; Requests that a slave be contacted for writing. When communication
; has been established, i2cmu_write_next_byte will be called.
; State Idle/Reading-Wait Writing-Setup
; W slave number any
- extern i2cmu_write_next_byte
+ extern i2cmu_write_next_byte
;
; Called to notify the main program that we are now ready to transmit
; a byte to the slave that we're currently talking to. This may be
; MASTER - READS (ie, reception of data from the slave)
;--------------------
- extern i2cm_read_start
+ extern i2cm_read_start
;
; Requests that a slave be contacted for reading. When communication
; has been established and the first byte received,
; State Idle/Reading-Wait Reading-Busy
; W slave number any
- extern i2cmu_read_got_byte
+ extern i2cmu_read_got_byte
;
; Called to notify the main program that a byte has been recieved from
; the slave PIC. The byte value is supplied. Communication with the
; State Reading Reading-Wait
; W data from slave
- extern i2cm_read_another
+ extern i2cm_read_another
;
; Requests that the communication with the slave continue and another
; byte be read. When this is complete, i2cmu_read_got_byte will be
; At call On return
; State Reading-Wait Reading-Busy
- extern i2cm_read_done
+ extern i2cm_read_done
;
; Requests that reading from the slave be terminated. When the
; conversation is finished and the bus and i2c controller are free
; SLAVE - WRITES (ie, reception of data from the master)
;--------------------
- extern i2csu_write_begin
+ extern i2csu_write_begin
;
; Called to notify the main program that the master PIC has selected this
; slave to talk to, for writing. There is no data at this stage; when
; State Idle Receiving Receiving
;--------------------
- extern i2csu_write_data
+ extern i2csu_write_data
;
; Called to notify the main program that the master PIC has
; transmitted a byte of data. Provides the byte we received.
; SLAVE - READS (ie, transmission of data to the master)
;--------------------
- extern i2csu_read_begin
+ extern i2csu_read_begin
;
; Called to notify the main program that the master PIC has selected
; this slave to talk to, for reading. The main program should invoke
; State Idle Transmit-Wait
;--------------------
- extern i2cs_read_data
+ extern i2cs_read_data
; Transmits the byte of data to the master
;
; Beforehand At call On return
; in i2clib.incm, which does the same thing.
;--------------------
- extern i2csu_read_another
+ extern i2csu_read_another
;
; Called to notify the main program that the master PIC has continued
; by asking for another byte of data. The main program should once
~ijackson / trains.git / blobdiff