AU2003302611A1 - Dead nozzle compensation - Google Patents
Dead nozzle compensation Download PDFInfo
- Publication number
- AU2003302611A1 AU2003302611A1 AU2003302611A AU2003302611A AU2003302611A1 AU 2003302611 A1 AU2003302611 A1 AU 2003302611A1 AU 2003302611 A AU2003302611 A AU 2003302611A AU 2003302611 A AU2003302611 A AU 2003302611A AU 2003302611 A1 AU2003302611 A1 AU 2003302611A1
- Authority
- AU
- Australia
- Prior art keywords
- shows
- sopec
- data
- page
- cpu
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Granted
Links
Landscapes
- Ink Jet (AREA)
Description
WO 2004/050369 PCT/AU2003/001616 TITLE: DEAD NOZZLE COMPENSATION FIELD OF INVENTION The present invention relates to techniques for compensating for one or more dead nozzles in a multi 5 nozzle printhead. The invention has primarily been developed for use with a printhead comprising one or more printhead modules constructed using microelectromechanical systems (MEMS) techniques, and will be described with reference to this application. However, it will be appreciated that the invention can be applied to 10 other types of printing technologies in which analogous problems are faced. BACKGROUND OF INVENTION Manufacturing a printhead that has relatively high resolution and print-speed raises a number of problems. 15 Difficulties in manufacturing pagewidth printheads of any substantial size arise due to the relatively small dimensions of standard silicon wafers that are used in printhead (or printhead module) manufacture. For example, if it is desired to make an 8 inch wide pagewidth printhead, only one such printhead can be laid out on a standard 8-inch wafer, since such wafers are circular in plan. Manufacturing a pagewidth 20 printhead from two or more smaller modules can reduce this limitation to some extent, but raises other problems related to providing a joint between adjacent printhead modules that is precise enough to avoid visible artefacts (which would typically take the form of noticeable lines) when the printhead is used. The problem is exacerbated in relatively high-resolution applications because of the tight tolerances dictated by the small spacing between nozzles. 25 The quality of a joint region between adjacent printhead modules relies on factors including a precision with which the abutting ends of each module can be manufactured, the accuracy with which they can be aligned when assembled into a single printhead, and other more practical factors such as management of ink channels behind the nozzles. It will be appreciated that the difficulties include relative vertical 30 displacement of the printhead modules with respect to each other. Whilst some of these issues may be dealt with by careful design and manufacture, the level of precision required renders it relatively expensive to manufacture printheads within the required tolerances. It would be desirable to provide a solution to one or more of the problems associated with precision 35 manufacture and assembly of multiple printhead modules to form a printhead, and especially a pagewidth printhead. In some cases, it is desirable to produce a number of different printhead module types or lengths on a substrate to maximise usage of the substrate's surface area. However, different sizes and types of 40 modules will have different numbers and layouts of print nozzles, potentially including different WO 2004/050369 PCT/AU2003/001616 2 horizontal and vertical offsets. Where two or more modules are to be joined to form a single printhead, there is also the problem of dealing with different seam shapes between abutting ends ofjoined modules, which again may incorporate vertical or horizontal offsets between the modules. Printhead controllers are usually dedicated application specific integrated circuits (ASICs) designed for specific use with a 5 single type of printhead module, that is used by itself rather than with other modules. It would be desirable to provide a way in which different lengths and types of printhead modules could be accounted for using a single printer controller. Printer controllers face other difficulties when two or more printhead modules are involved, especially if 10 it is desired to send dot data to each of the printheads directly (rather than via a single printhead connected to the controller). One concern is that data delivered to different length controllers at the same rate will cause the shorter of the modules to be ready for printing before any longer modules. Where there is little difference involved, the issue may not be of importance, but for large length differences, the result is that the bandwidth of a shared memory from which the dot data is supplied to the modules is 15 effectively left idle once one of the modules is full and the remaining module or modules is still being filled. It would be desirable to provide a way of improving memory bandwidth usage in a system comprising a plurality of printhead modules of uneven length. In any printing system that includes multiple nozzles on a printhead or printhead module, there is the 20 possibility of one or more of the nozzles failing in the field, or being inoperative due to manufacturing defect. Given the relatively large size of a typical printhead module, it would be desirable to provide some form of compensation for one or more " dead" nozzles. Where the printhead also outputs fixative on a per-nozzle basis, it is also desirable that the fixative is provided in such a way that dead nozzles are compensated for. 25 A printer controller can take the form of an integrated circuit, comprising a processor and one or more peripheral hardware units for implementing specific data manipulation functions. A number of these units and the processor may need access to a common resource such as memory. One way of arbitrating between multiple access requests for a common resource is timeslot arbitration, in which access to the 30 resource is guaranteed to a particular requestor during a predetermined timeslot. One difficulty with this arrangement lies in the fact that not all access requests make the same demands on the resource in terms of timing and latency. For example, a memory read requires that data be fetched from memory, which may take a number of cycles, whereas a memory write can commence immediately. 35 Timeslot arbitration does not take into account these differences, which may result in accesses being performed in a less efficient manner than might otherwise be the case. It would be desirable to provide a timeslot arbitration scheme that improved this efficiency as compared with prior art timeslot arbitration schemes. 40 Also of concern when allocating resources in a timeslot arbitration scheme is the fact that the priority of WO 2004/050369 PCT/AU2003/001616 3 an access request may not be the same for all units. For example, it would be desirable to provide a timeslot arbitration scheme in which one requestor (typically the memory) is granted special priority such that its requests are dealt with earlier than would be the case in the absence of such priority. 5 In systems that use a memory and cache, a cache miss (in which an attempt to load data or an instruction from a cache fails) results in a memory access followed by a cache update. It is often desirable when updating the cache- in this way to update data other than that which was actually missed. A typical example would be a cache miss for a byte resulting in an entire word or line of the cache associated with that byte being updated. However, this can have the effect of tying up bandwidth between the memory 10 (or a memory manager) and the processor where the bandwidth is such that several cycles are required to transfer the entire word or line to the cache. It would be desirable to provide a mechanism for updating a cache that improved cache update speed and/or efficiency. Most integrated circuits an externally provided signal as (or to generate) a clock, often provided from a 15 dedicated clock generation circuit. This is often due to the difficulties of providing an onboard clock that can operate at a speed that is predictable. Manufacturing tolerances of such on-board clock generation circuitry can result in clock rates that vary by a factor of two, and operating temperatures can increase this margin by an additional factor of two. In some cases, the particular rate at which the clock operates is not of particular concern. However, where the integrated circuit will be writing to an internal circuit 20 that is sensitive to the time over which a signal is provided, it may be undesirable to have the signal be applied for too long or short a time. For example, flash memory is sensitive to being written too for too long a period. It would be desirable to provide a mechanism for adjusting a rate of an on-chip system clock to take into account the impact of manufacturing variations on clockspeed. 25 One form of attacking a secure chip is to induce (usually by increasing) a clock speed that takes the logic outside its rated operating frequency. One way of doing this is to reduce the temperature of the integrated circuit, which can cause the clock to race. Above a certain frequency, some logic will start malfunctioning. In some cases, the malfunction can be such that information on the chip that would otherwise be secure may become available to an external connection. It would be desirable to protect an 30 integrated circuit from such attacks. In an integrated circuit comprising non-volatile memory, a power failure can result in unintentional behaviour. For example, if an address or data becomes unreliable due to falling voltage supplied to the circuit but there is still sufficient power to cause a write, incorrect data can be written. Even worse, the 35 data (incorrect or not) could be written to the wrong memory. The problem is exacerbated with multi word writes. It would be desirable to provide a mechanism for reducing or preventing spurious writes when power to an integrated circuit is failing. In an integrated circuit, it is often desirable to reduce unauthorised access to the contents of memory. 40 This is particularly the case where the memory includes a key or some other form of security information WO 2004/050369 PCT/AU2003/001616 4 that allows the integrated circuit to communicate with another entity (such as another integrated circuit, for example) in a secure manner. It would be particularly advantageous to prevent attacks involving direct probing of memory addresses by physically investigating the chip (as distinct from electronic or logical attacks via manipulation of signals and power supplied to the integrated circuit). 5 It is also desirable to provide an environment where the manufacturer of the integrated circuit (or some other authorised entity) can verify or authorize code to be run on an integrated circuit. Another desideratum would be the ability of two or more entities, such as integrated circuits, to 10 communicate with each other in a secure manner. It would also be desirable to provide a mechanism for secure communication between a first entity and a second entity, where the two entities, whilst capable of some form of secure communication, are not able to establish such communication between themselves. In a system that uses resources (such as a printer, which uses inks) it may be desirable to monitor and 15 update a record related to resource usage. Authenticating ink quality can be a major issue, since the attributes of inks used by a given printhead can be quite specific. Use of incorrect ink can result in anything from misfiring or poor performance to damage or destruction of the printhead. It would therefore be desirable to provide a system that enables authentication of the correct ink being used, as well as providing various support systems secure enabling refilling of ink cartridges. 20 In a system that prevents unauthorized programs from being loaded onto or run on an integrated circuit, it can be laborious to allow developers of software to access the circuits during software development. Enabling access to integrated circuits of a particular type requires authenticating software with a relatively high-level key. Distributing the key for use by developers is inherently unsafe, since a single 25 leak of the key outside the organization could endanger security of all chips that use a related key to authorize programs. Having a small number of people with high-security clearance available to authenticate programs for testing can be inconvenient, particularly in the case where frequent incremental changes in programs during development require testing. It would be desirable to provide a mechanism for allowing access to one or more integrated circuits without risking the security of other integrated 30 circuits in a series of such integrated circuits. In symmetric key security, a message, denoted by M, is plaintext. The process of transforming M into ciphertext C, where the substance of M is hidden, is called encryption. The process of transforming C back into M is called decryption. Referring to the encryption function as E, and the decryption function as 35 D, we have the following identities: E[M] = C D[C] M Therefore the following identity is true: WO 2004/050369 PCT/AU2003/001616 5 D[E[M]] = M A symmetric encryption algorithm is one where: e the encryption function E relies on key K 1 , 5 - the decryption function D relies on key K 2 , - K2 can be derived from Ki, and - Ki can be derived from K 2 . In most symmetric algorithms, K equals K 2 . However, even if K does not equal K 2 , given that one key 10 can be derived from the other, a single key K can suffice for the mathematical definition. Thus: EK[MI = C DK[C] = M The security of these algorithms rests very much in the key K. Knowledge of K allows anyone to encrypt 15 or decrypt. Consequently K must remain a secret for the duration of the value of M. For example, M may be a wartime message "My current position is grid position 123-456". Once the war is over the value of M is greatly reduced, and if K is made public, the knowledge of the combat unit's position may be of no relevance whatsoever. The security of the particular symmetric algorithm is a function of two things: the strength of the algorithm and the length of the key. 20 An asymmetric encryption algorithm is one where: - the encryption function E relies on key K 1 , - the decryption function D relies on key K 2 , - K 2 cannot be derived from K 1 in a reasonable amount of time, and 25 - K 1 cannot be derived from K 2 in a reasonable amount of time. Thus: EKI[M] = C Dx 2 [C] = M 30 These algorithms are also called public-key because one key K 1 can be made public. Thus anyone can encrypt a message (using KI) but only the person with the corresponding decryption key (K 2 ) can decrypt and thus read the message. In most cases, the following identity also holds: Ex2[M] = C 35
DK
1 [C] = M This identity is very important because it implies that anyone with the public key K can see M and know WO 2004/050369 PCT/AU2003/001616 6 that it came from the owner of K 2 . No-one else could have generated C because to do so would imply knowledge of K 2 . This gives rise to a different application, unrelated to encryption - digital signatures. A number of public key cryptographic algorithms exist. Most are impractical to implement, and many 5 generate a very large C for a given M or require enormous keys. Still others, while secure, are far too slow to be practical for several years. Because of this, many public key systems are hybrid - a public key mechanism is used to transmit a symmetric session key, and then the session key is used for the actual messages. 10 All of the algorithms have a problem in terms of key selection. A random number is simply not secure enough. The two large primes p and q must be chosen carefully - there are certain weak combinations that can be factored more easily (some of the weak keys can be tested for). But nonetheless, key selection is not a simple matter of randomly selecting 1024 bits for example. Consequently the key selection process must also be secure. 15 Symmetric and asymmetric schemes both suffer from a difficulty in allowing establishment of multiple relationships between one entity and a two or more others, without the need to provide multiple sets of keys. For example, if a main entity wants to establish secure communications with two or more additional entities, it will need to maintain a different key for each of the additional entities. For practical 20 reasons, it is desirable to avoid generating and storing large numbers of keys. To reduce key numbers, two or more of the entities may use the same key to communicate with the main entity. However, this means that the main entity cannot be sure which of the entities it is communicating with. Similarly, messages from the main entity to one of the entities can be decrypted by any of the other entities with the same key. It would be desirable if a mechanism could be provided to allow secure communication 25 between a main entity and one or more other entities that overcomes at least some of the shortcomings of prior art. In a system where a first entity is capable of secure communication of some form, it may be desirable to establish a relationship with another entity without providing the other entity with any information related 30 the first entity's security features. Typically, the security features might include a key or a cryptographic function. It would be desirable to provide a mechanism for enabling secure communications between a first and second entity when they do not share the requisite secret function, key or other relationship to enable them to establish trust. 35 A number of other aspects, features, preferences and embodiments are disclosed in the Detailed Description of the Preferred Embodiment below. SUMMARY OF THE INVENTION In accordance with the invention, there is provided a method of compensating for an inoperative nozzle in 40 a printhead, the method comprising the step of: WO 2004/050369 PCT/AU2003/001616 7 (a) mapping dot data intended for the inoperative nozzle into one or more operative nozzles of the printhead. Preferably, step (a) includes the substep of mapping the dot data intended for the inoperative nozzle into a 5 nozzle that will print a dot on print media close to a position at which the inoperative nozzle would have printed a dot had it been operative. Preferably also, step (a) includes the substep of mapping the dot data intended for the inoperative nozzle into a nozzle that will print a dot on print media immediately adjacent a position at which the inoperative 10 nozzle would have printed a dot had it been operative. In a preferred embodiment, step (a) includes the substeps of: (i) determining one or more operative nozzles capable of printing a dot on print media close to a position at which the inoperative nozzle would have printed a dot had it been operative; and 15 (ii) mapping the dot data from the inoperative nozzle to an operative nozzle determined in substep (i). More preferably, in the event more than one operative nozzle is determined in substep (i), the dot data is remapped to one of the operative nozzles that will print a dot on print media closest to that which would have been printed by the inoperative nozzle. 20 It is preferred that during successive firings of the printhead, the dot data is remapped alternately to operative nozzles that will print a dot on print media either side of that which would have been printed by the inoperative nozzle. 25 In an alternative embodiment, during successive firings of the printhead, the dot data is remapped randomly, pseudo-randomly, or arbitrarily to operative nozzles that will print a dot on print media either side of that which would have been printed by the inoperative nozzle. Preferably, the printhead including a plurality of sets of the nozzles for printing a corresponding plurality 30 of channels of dot data, wherein step (a) includes the substep of mapping the dot data intended for the inoperative nozzle into one or more operative nozzles from the same set. In one form, step (a) includes the substep of mapping the dot data into one or more operative nozzles that will print a dot on print media close to a position at which the inoperative nozzle would have printed a dot 35 had it been operative. In an alternative form, step (a) includes the substep of mapping the dot data intended for the inoperative nozzle into one or more operative nozzles including at least one nozzle from a different one of the sets. 40 In yet another embodiment, step (a) includes the substeps of: WO 2004/050369 PCT/AU2003/001616 8 determining which combination of one or more available operative nozzles near the inoperative nozzle will minimise perceived error in an image that the dot data forms part of, the determination being performed on the basis of a color model; and mapping the dot data intended for the inoperative nozzle to that combination of one or more 5 operative nozzles. Preferably, the inoperative nozzle is associated with a black print channel, and wherein step (a) includes remapping the dot data intended for the inoperative nozzle into a plurality of operative nozzles in other color channels to produce a process black output at or adjacent a location on print media where the 10 inoperative nozzle would have deposited a droplet of a black printing substance in accordance with the dot data. In a preferred embodiment, a plurality of dot data intended for a corresponding plurality of inoperative nozzles are mapped to operative nozzles. 15 In accordance with a second aspect of the invention, there is provided a printer controller configured to implement the method of the first aspect. In accordance with a third aspect of the invention, there is provided a printer controller configured to 20 implement the method of the first aspect to a printhead comprising a plurality of the nozzles. In accordance with the invention, there is provided a method for outputting a portion of a dither matrix stored in a memory, comprising the step of: (b) determining a start position and an end position in the memory; 25 (c) reading a plurality of dither values of the dither matrix from the memory, commencing at the start position; and (d) outputting a portion of the plurality of dither values read in step (b) Preferably two or more dither matrices are stored in the memory. A plurality of dither values are read 30 from at least two of the dither matrices with a single read. The matrices can be different sizes. It is preferred that each read from the memory reads at least one, and preferably two or more, lines from one or more dither matrices. 35 The method can also be embodied in hardware. It is also preferred that the memory is configurable to store different dither matrices for different color channels. It is particularly preferred that a single read of the memory loads a full line for two or more dither matrices into a dither buffer. Typically, each dither matrix will be for a different color channel. 40 WO 2004/050369 PCT/AU2003/001616 9 In accordance with another aspect of the invention, there is provided a printer controller for supplying dot data to a printhead in a predetermined order, the printhead comprising at least a first printhead module having a plurality of rows of printing nozzles, the printer controller being configured to order and time the supply of the dot data to the first printhead module such that a relative skew between adjacent rows of printing nozzles 5 on the at least one printhead module, in a direction normal to a direction of printing, is at least partially compensated for. Preferably, the printer controller is configured to at least partially compensate for the relative skew between adjacent rows in each of a plurality of sets of the adjacent rows. 10 In a preferred embodiment, wherein the relative skew between each of the plurality of the sets of the adjacent rows is the same. Preferably, the printer controller is configured to compensate for the skew by introducing a relative delay into 15 the dot data destined for at least one of the rows of printing nozzles. More preferably, the printhead is configured to print the dots at a predetermined spacing across its width, and the delay introduced by the printer controller equates to an integral multiple of the spacing. It is particularly preferred, that the printhead defines a printable region between printing boundaries. Nozzles 20 of at least one of the rows of at least one of the at least one printhead modules are positioned outside the printable region due to the skew between adjacent rows of the nozzles on the at least one printhead module. The printer controller is configured to introduce a relative delay into the dot data supplied to at least one of the rows such that the nozzles outside the printable region do not print. 25 Preferably, the at least one printhead module includes at least one pair of adjacent rows of the nozzles such that each row of the pair is configured to print the same ink. The printhead is configured to provide the dot data to the pair of adjacent rows such that the dot data is shifted serially through the first of the rows then through the second of the rows, until the dot data has been supplied to all the nozzles. More preferably, the printhead is configured to provide the dot data to the pair of adjacent rows such that the dot data is shifted 30 serially through the first of the rows in a first direction then looped back through the second of the rows in a second direction opposite the first, until the dot data has been supplied to all the nozzles. Preferably, the printhead is configured to print a series of printhead-width rows of the dots, and wherein the first and second rows are configured to print odd and even dots, respectively, of the printhead-width rows, the 35 printhead controller being configured to supply the one or more first rows with odd dot data and the one or more second rows with even dot data. Preferably, the printhead has a plurality of the pairs of rows. The printer controller is configured to supply the dot data such that any relative skew between the first and second rows of each pair of rows, in a direction 40 normal to a direction of printing, is at least partially compensated for.
WO 2004/050369 PCT/AU2003/001616 10 In one embodiment, each printhead module is configured to print a plurality of independent inks, and the nozzles in each row are configured to print in one of the inks. The printhead controller being configured to supply each of the inks to at least one row of at least one of the printhead modules. 5 Preferably, at least some of the printhead modules are of mutually unequal length, the printer controller being configured to order and time the supply of the dot data to the compensate for the unequal length. It is also preferable that the printer controller is configured to at least partially compensate for any relative 10 skew between adjacent rows of the nozzles on adjacent ones of the printhead modules. In a preferred form of the invention, the printer controller is selectively configurable to compensate at least partially for a plurality of potential relative skews. 15 In one form, the controller is configured to compensate at least partly for a fixed amount of the skew. In accordance with a further aspect, the invention comprises the printer engine comprising a printer controller according to the first aspect and a printhead, wherein the nozzles of the printhead are disposed in a printable region between printing boundaries of the printhead. The printhead includes at least one logical nozzle 20 located outside the printable zone that can accept data but is not capable of printing. The logical nozzles are arranged to introduce a relative delay into the dot data supplied to at least one of the rows, such that dot data is supplied to the correct nozzles for printing. In accordance with another aspect of the invention, there is provided a printer controller for supplying dot data 25 to a printhead in a predetermined order, the printhead comprising at least first and second printhead modules, each comprising a plurality of printing nozzles and being disposed adjacent each other such that a printing width of the printhead is wider than a printing width of either of the printhead modules, the printer controller being configurable during or after manufacture to order and time supply of the dot data to the printhead modules such that any relative displacement between the printhead nozzles in a direction normal to the 30 printhead printing width is at least partially compensated for. Preferably, the printer controller is configurable to provide compensation for any of a plurality of different amounts of the relative displacement. 35 More preferably, where each of the printhead modules comprises a plurality of parallel rows of the printing nozzles, the printhead is configured such that each of the rows of each printhead module has a corresponding row in each of the other printhead modules. The printer controller is controllable to introduce a relative delay into the dot data supplied to one or more of the rows, thereby to provide the compensation.
WO 2004/050369 PCT/AU2003/001616 11 In a particularly preferred embodiment, where the printhead is configured to print the dots at a predetermined spacing in a direction in which print media is supplied for printing, the delay introduced by the printer controller equates to an integral multiple of the spacing during printing. 5 In accordance with a further aspect of the invention, there is a printer controller for supplying dot data to a printhead in a predetermined order, the printhead comprising at least first and second printhead modules, each of which comprises a plurality of printing nozzles and being disposed adjacent each other such that a printing width of the printhead is wider than a printing width of either of the printhead modules, the printer controller being configured to order and time supply of the dot data to the printhead modules in accordance with their 10 respective widths, such that a difference in relative widths of the printhead modules is at least partially compensated for. Preferably, each of the printhead modules comprises a plurality of rows of the printing nozzles, the controller being configured to supply the dot data to the rows of nozzles in serial form. More preferably, each of the 15 printhead modules comprises one or more parallel pairs of the rows, the controller being configured to serially supply the data to a first of each of the rows of nozzles in the or each pair of rows, the data being serially clocked through the first row of the or each pair of rows, then through a second row of the or each pair or rows, until all printhead nozzles have received their respective data. 20 It is preferred that the data is clocked through the second row in a direction substantially opposite to that in which it was clocked through the first row. In another aspect, there is provided a printer controller for supplying dot data to a printhead comprising at least one printhead module, the printer controller being configurable to supply the dot data to a selectable one 25 of a plurality of potential printhead module types, each having a different number of nozzles for receiving the dot data. Preferably, the printer controller includes non-volatile memory for storing at least one parameter value, the at least one parameter value determining which of the potential printhead types the printer controller has been 30 configured to supply the dot data to. More preferably, the printer controller is configurable to supply the dot data to the printhead module on the basis of one or more printer module widths indicated by the at least one parameter. 35 In a preferred embodiment, the printer controller is configurable to supply the dot data to a plurality of the printhead modules, on the basis of one or more widths of the printhead modules indicated by the at least one parameter.
WO 2004/050369 PCT/AU2003/001616 12 In accordance with a further aspect of the invention, there is provided a method of accounting for dead nozzle remapping in a multi-nozzle printhead, including remapping a fixative intended for a dot to be printed by the dead nozzle. 5 In one form, the remapping includes remapping the fixative to an operative nozzle to which dot data intended for the dead nozzle for printing at or adjacent a position at which the dead nozzle would have printed. Alternatively, or in addition, the remapping includes preventing output of fixative onto the position where the dead nozzle would have printed a dot had it been operative. 10 In accordance with a further aspect of the invention, there is provided a method for arbitrating between a plurality of access requests issued in relation to a resource by a plurality of requestors, wherein each request can be one of at least two types, a first of the types having a higher latency associated with its performance than at least some of the other types, the method including the steps of: 15 (e) receiving a plurality of the access requests; (the requests are not placed anywhere, they are simply received) (f) maintaining a current pointer that points to a current timeslot in a timeslot list, and at least one lookahead pointer that points to a future timeslot in the timeslot list; and (g) in the event an access request as arbitrated via the lookahead pointer is of the first type, initiating 20 performance of the access request earlier than the position in the list suggests it would be performed should it be started when the current pointer reached the timeslot. Preferably, step (g) includes the substep of performing the access request indicated by the lookahead pointer immediately after the access request indicated by the current pointer is performed. 25 It is preferred that step (g) includes the substep of performing the access request indicated by the lookahead pointer immediately after the access request indicated by the current pointer is performed. In a preferred embodiment, the number of timeslots between the timeslot indicated by the lookahead pointer 30 and the timeslot indicated by the current pointer takes into account a latency difference between performing an access request of the first type and at least one of the other access request types. In accordance with another aspect of the invention, there is provided an integrated circuit including: a plurality of operative units, each of which is capable of issuing a request for access to a memory 35 accessible by the integrated circuit; and an timeslot arbitrator for arbitrating between requests issued by the operative units for access to the memory, wherein each request can be one of at least two types, a first of the types having a higher latency associated with its performance than at least some of the other types, the timeslot arbitrator being configured to: (h) receive a plurality of the access requests; WO 2004/050369 PCT/AU2003/001616 13 (i) maintain a current pointer that points to a current timeslot in a timeslot list, and at least one lookahead pointer that points to a future timeslot in the timeslot list; and (i) in the event the access request as arbitrated via the lookahead pointer is of the first type, performing the access request earlier than the position in the list suggests it should be performed should it be started when 5 the current pointer reached the timeslot. Preferably, the first type of access request is a memory write request. Preferably, the integrated circuit includes a memory interface unit operatively connected with, and under the 10 control of, the timeslot arbitrator, and wherein the memory interface is operatively connected to: one or more of the operative units via one or more communications buses, and the memory via a memory bus of greater width than the communications buses. In a preferred form, the number of timeslots between the timeslot indicated by the lookahead pointer and the 15 timeslot indicated by the current pointer takes into account a latency difference between performing an access request of the first type and at least one of access request types. In accordance with a further aspect of the invention, there is provided a method of arbitrating between access requests from a plurality of requesters for access to a resource, wherein at least one of the requestors is 20 defined as higher priority access to the resource, the method comprising the steps of: (k) receiving a plurality of the access requests; (1) in the event an access request from the at least one of the requestors is received, initiating performance of the access request in preference to the requestor as specified by the timeslot list and regardless of whether or not the at least one of the requesters is in the timeslot list. 25 Preferably, the at least one requestor requires lower latency access to the resource than at least one of the other requesters from which access requests can be received. Preferably, the at least one requestor is a processor and/or the resource is a memory. 30 Preferably, step (1) includes the substep of performing the access request from the requestor immediately following completion of any current access request being reformed. In a preferred form, step (1) is performed such that a frequency of the at least one requestor being granted 35 preferential performance of its access requests is limited within a time period. More preferably, early performance of access requests from the at least one requestor is restricted to a maximum number of times within a predetermined number of timeslots. Preferably, the requesters are hardware units on an integrated circuit and the method is implemented by a 40 timeslot arbitrator unit on the integrated circuit.
WO 2004/050369 PCT/AU2003/001616 14 In accordance with another aspect of the invention, there is provided a method according to the third aspect, wherein each request can also be one of at least two types, a first of the types having a higher latency associated with its performance than at least some of the other types, the method including the steps of: 5 (in) receiving a plurality of the access requests; (n) maintaining a current pointer that points to a current timeslot in the timeslot list, and at least one lookahead pointer that points to a future timeslot in the timeslot list; and (o) in the event an access request as arbitrated via the lookahead pointer is of the first type, initiating performance of the access request earlier than its position in the list suggests it should be performed should it 10 be started when the current pointer reached the timeslot. In accordance with another aspect of the invention, there is provided a method of updating a cache in an integrated circuit comprising: the cache 15 a processor connected to the cache via a cache bus; a memory interface connected to the cache via a first bus and to the processor via a second bus, the first bus being wider than the second bus or the cache bus; and memory connected to the memory interface via a memory bus; the method comprising the steps of: 20 (p) following a cache miss, using the processor to issue a request for first data via a first address, the first data being that associated with the cache miss; (q) in response to the request, using the memory interface to fetch the first data from the memory, and sending the first data to the processor; (r) sending, from the memory interface and via the first bus, the first data and additional data, the 25 additional data being that stored in the memory adjacent the first data; (s) updating the cache with the first data and the additional data via the first bus; and (t) updating flags in the cache associated with the first data and the additional data, such that the updated first data and additional data in the cache is valid. 30 Preferably, the processor is configured to attempt a cache update with the first data upon receiving it from the memory interface, the method further including the step of preventing the attempted cache update by the processor from being successful, thereby preventing interference with the cache update of steps (s) and/or (t). More preferably, steps (r), (s), and (t) are performed substantially simultaneously. 35 In one embodiment, steps (s) and (t) are performed by the memory interface. Preferably, steps (s) and (t) are performed in response to the processor attempting to update the cache following step (r). More preferably, the memory interface is configured to monitor the processor to determine 40 when it attempts to update the cache following step (r).
WO 2004/050369 PCT/AU2003/001616 15 In accordance with a further aspect of the invention, there is provided an integrated circuit, comprising a processor, an onboard system clock for generating a clock signal, and clock trim circuitry, the integrated circuit being configured to: 5 (u) receive an external signal; (v) determine either the number of cycles of the clock signal during a predetermined number of cycles of the external signal, or the number of cycles of the external signal during a predetermined number of cycles of the clock signal; (w) store a trim value in the integrated circuit, the trim value having been determined on the basis of the 10 determined number of cycles; and (x) use the trim value to control the internal clock frequency. Preferably, the integrated circuit is configured to, between steps (v) and (w): output the result of the determination of step (v); and 15 receive the trim value from an external source. Preferably, the integrated circuit includes non-volatile memory, and (w) includes storing the trim value in the memory. More preferably, the memory is flash RAM. 20 In a preferred form step (x) includes loading the trim value from the memory into a register and using the trim value in the register to control a frequency of the internal clock. In a preferred form, the trim value is determined and stored permanently in the integrated circuit. More preferably, the circuit includes one or more fuses that are intentionally blown following step (w), thereby 25 preventing the stored trim value from subsequently being changed. In a preferred embodiment, the system clock further includes a voltage controlled oscillator (VCO), an output frequency of which is controlled by the trim value. More preferably, the integrated circuit further includes a digital to analog convertor configured to convert the trim value to a voltage and supply the voltage to an input 30 of the VCO, thereby to control the output frequency of the VCO. Preferably, the integrated circuit is configured to operate under conditions in which the signal for which the number of cycles is being determined is at a considerably higher frequency than the other signal. 35 More preferably, the integrated circuit is configured to operate when a ratio of the number of cycles determined in step (v) and the predetermined number of cycles is greater than about 2. It is particularly preferred that the ratio is greater than about 4.
WO 2004/050369 PCT/AU2003/001616 16 Preferably, the integrated circuit is disposed in a package having an external pin for receiving the external signal. More preferably, the pin is a serial communication pin configurable for serial communication when the trim value is not being set. 5 Preferably, the trim value was also determined on the basis of a compensation factor that took into account a temperature of the integrated circuit when the number of cycles are being determined. Preferably, the trim value received was determined by the external source, the external source having determined the trim value including a compensation factor based on a temperature of the integrated circuit 10 when the number of cycles are being determined. Preferably, the trim value is determined by performing a number of iterations of determining the number of cycles, and averaging the determined number. 15 In accordance with a further aspect of the invention, there is provided an integrated circuit comprising a processor, non-volatile memory, an input for receiving power from a power supply and a power detection unit, wherein the integrated circuit is configured to enable multi-word writes to the non-volatile memory, the power detection unit being configured to: monitor a quality of power supplied to the input; 20 in the event the quality of the power drops below a predetermined threshold, preventing subsequent words in any multi-word write currently being performed from being written to the memory. Preferably, the integrated circuit is configured to prevent any further writes of any type to the memory once the quality is determined to have dropped below the threshold. 25 Preferably, the quality is a voltage. Preferably, the memory is flash memory. 30 Preferably, the power detection unit is configured to provide a reset signal to at least some other circuits on the integrated circuit once any current writes have been finished. In accordance with another aspect of the invention, there is provided an integrated circuit comprising a processor, a memory that the processor can access, a memory access unit for controlling accesses to the 35 memory, an input for receiving power for the integrated circuit from an external power source, and a power detection unit, the power detection unit being configured to: monitor a quality of power supplied to the input; in the event the quality of the power drops below a predetermined threshold, disabling a power supply to circuitry for use in writing to the memory, such that the memory access unit's ability to alter data in WO 2004/050369 PCT/AU2003/001616 17 the memory is disabled prior to address or data values to be written to the memory becoming unreliable due to failing power. Preferably, the memory is flash memory and the power supply is one or more charge pump circuits. More 5 preferably, a voltage output by the power supply falls fast enough that the voltage supplied to the flash memory becomes too low to enable a change in contents of the flash memory before the voltage levels of the address or data values become invalid. Preferably, the integrated circuit is configured to cause a reset of at least some of the circuitry on the 10 integrated circuit following disabling of the power supply. More preferably, the integrated circuit is programmed or designed to have a variable delay between disabling of the power supply and causing the reset. 15 In accordance with a further aspect of the invention, there is provided an integrated circuit comprising a processor and memory, the memory storing a set of data representing program code and/or an operating value, wherein each bit of the data is stored as a bit/inverse-bit pair in corresponding pairs of physically adjacent bit cells in the memory. 20 Preferably, the integrated circuit further includes a memory management unit configured to receive a request for the set of data and to test, during processing of the request, whether the respective pairs of physically adjacent bit-cells that correspond to the set of data contain bit/inverse-bit pairs, thereby to confirm the validity of the set of data as stored in the memory. More preferably, the memory management unit is configured to store sets of data as sets of bit/inverse-bit pairs in the memory. 25 Preferably, the integrated circuit is selectively operable in either of first and second modes, wherein: in the first mode, the memory management unit is configured to receive and process a request for the set of data, and to test, during processing of the request, whether the respective pairs of physically adjacent bit-cells corresponding to the set of data contain bit/inverse-bit pairs, thereby to confirm the validity of the set 30 of data as stored in the memory; and in the second mode, the memory management unit is configured to receive and process a request for data stored in the memory, without testing whether pairs of physically adjacent bit-cells contain bit/inverse-bit pairs. 35 More preferably: in the first mode, the memory management unit is configured to store a set of data associated with a memory write request as a corresponding set of bit/inverse-bit pairs, each of the bit/inverse-bit pairs being physically adjacent each other; and in the second mode, the memory management unit is configured to store a set of data associated with 40 a memory write request as the set of data without corresponding inverse-bits.
WO 2004/050369 PCT/AU2003/001616 18 Preferably, the integrated circuit is configured to boot into the first mode by default. Preferably, the integrated circuit is configured to implement a defensive action in the event the test fails. 5 More preferably, the defensive action includes resetting the integrated circuit. In an alternative embodiment, the defensive reaction includes returning second data other than that the subject of the test. 10 Preferably, the second data is a string of identical digits. Preferably, the defensive reaction is different depending upon whether the set of data represents program code or an operating value. 15 More preferably, in the event the test fails and the set of data is an operating value, the integrated circuit is configured to replace the failed value with a substitute value. More preferably, the substitute value is selected to disrupt a program running on the integrated circuit. 20 Preferably, the substitute causes at least some circuitry on the integrated circuit to reset. In a preferred embodiment, in the event the test fails, the integrated circuit is permanently prevented from running software. 25 Preferably, in the event the test fails, the integrated circuit is configured to delete from the memory some or all of the bit values associated with the set of data. More preferably, in the event the test fails, the integrated circuit is configured to delete some or all of the 30 contents of the memory. In accordance with another aspect of the invention, there is provided an integrated circuit comprising a processor and memory storing: secret information accessible via a first address, the secret information comprising a string of bit 35 values; an inverse-string accessible via a second address, the inverse-string comprising a string of bit values, wherein each of the bit values in the inverse-string is the logical inverse of a bit value at a corresponding bit position in the secret information, the integrated circuit being programmed with code configured to: (i) receive a request for the secret information; and WO 2004/050369 PCT/AU2003/001616 19 (ii) test whether the bit-values of the inverse string are the inverse of the bit-values at respective corresponding bit positions of the secret information. In accordance with a further aspect of the invention, there is provided a method of ensuring validity of secret 5 information stored in a memory in the form of a string of bit values accessible via a first address, the memory also storing an inverse-string accessible via a second address, the inverse-string comprising a string of bit values that are the logical inverses of the bit values at corresponding respective bit positions of the secret information, the method including the steps of: receiving a request for the secret information; and 10 testing whether the bit-values of the inverse string are the inverse of the bit-values at respective corresponding bit positions of the secret information. Preferably, the integrated circuit is configured and programmed to perform a defensive action in the event the test fails. 15 More preferably, the defensive action incudes deleting or destroying some or all of the contents of the memory in the event the test fails. Preferably, the defensive action includes deleting or destroying at least the secret information and/or the inverse string. 20 Preferably, the defensive action includes preventing the processor from executing software. Preferably, the defensive action includes resetting some or all of logic on the integrated circuit. Preferably, the first and second addresses are at the same address in the memory. 25 Preferably, the string and inverse string are stored at different sub-addresses within the same address. In accordance with a further aspect of the invention, there is provided method of manufacturing a plurality of the integrated circuits, comprising the steps, for each of the plurality of integrated circuits, of: 30 storing the secret information and the inverse string at the first and second addresses in the memory of the integrated circuit; and storing the code on the integrated circuit; wherein the first and second addresses are randomly, pseudo-randomly or arbitrarily selected for each of the integrated circuits and the code for each integrated circuit is customised to know the first and 35 second addresses of its secret information and inverse string. Preferably, the first and second addresses are restricted to one of two potential locations in the memory of each integrated circuit, the secret information and the inverse string for each integrated circuit being allocated to the first and second addresses randomly, pseudo-randomly or arbitrarily. 40 WO 2004/050369 PCT/AU2003/001616 20 More preferably, the secret information differs between at least two of the integrated circuits. In accordance with another aspect of the invention, there is provided a plurality of integrated circuits, each of the integrated circuits comprising a processor and non-volatile memory, and including code for running 5 identical software processes, wherein each of the integrated circuits also includes secret information used by the software process, the secret information in each chip being located in a different location in the memory relative to a plurality of the other chips. Preferably, the code on each integrated circuit is such that the software process of each chip knows the 10 location in memory via which the secret information is accessible. In accordance with a further aspect of the invention, there is provided a method of manufacturing a plurality of the integrated circuits, including the steps of: manufacturing a plurality of physical integrated circuits; and 15 injecting, into the non-volatile memory of each of the integrated circuits: code for running a software process; and secret information; wherein the secret information is positioned in relatively different locations of the non-volatile memories and the code on each integrated circuit is such that the software process of each integrated circuit knows the 20 location in memory via which the secret information is accessible on that integrated circuit. In accordance with another aspect of the invention, there is provided an integrated circuit comprising a processor and non-volatile memory, the non-volatile memory storing a first number and a second number, wherein the second number is the result of an encryption function taking a third number and secret 25 information as operands, the integrated circuit comprising software configured to decrypt the second number using the first number, thereby to determine the secret information as required. Preferably, the first and third numbers are the same. 30 Preferably, the first and second numbers are of the same length. Preferably, the first number is a random number that was generated using a stochastic process. Preferably, the encryption function is an XOR logical function. 35 Preferably, the software is configured to decrypt the second number by performing an XOR logical function using the first and second numbers as operands. In accordance with a further aspect of the invention, there is provided a method of manufacturing a plurality 40 of integrated circuits in accordance with claim 1, including the steps, for each integrated circuit, of: WO 2004/050369 PCT/AU2003/001616 21 determining the first number, the third number and the secret information; generating the second number by way of an encryption function that uses the third number and the secret information as operands; storing the first and second numbers on the integrated circuit. 5 Preferably, the first number is different amongst at least a plurality of the integrated circuits. Preferably, the first numbers are determined randomly, pseudo-randomly, or arbitrarily. 10 Preferably, the first number is stored on the integrated circuit first, then extracted therefrom for use in generating the third and thence the second number. In accordance with another aspect of the invention, there is provided a method of enabling authenticated communication of information between at least a primary entity and each of one or more secondary entities, 15 each of the one or more secondary entities having an identifier associated with it, the method including the steps of: allocating first secret information to the primary entity; for each of the one or more secondary entities, determining second secret information, the second secret information being the result of a one way function applied to that second secret entity's identifier and 20 the first secret information; allocating the second secret information to the or each secondary entity. Preferably, the identifiers allocated to the secondary entities are generated stochastically, pseudo-randomly or arbitrarily. 25 Preferably, the one way function is a hash function. Preferably, the first secret information is a key. More preferably, the one way function is a SHA function. 30 Preferably, each of the entities is implemented in an integrated circuit. Preferably, each of the entities is implemented in an integrated circuit separate from the integrated circuits in which the other entities are implemented. 35 Preferably, one or more of the secondary entities are implemented in a corresponding plurality of integrated circuits. Preferably, the primary entity is implemented in an integrated circuit. 40 Preferably, both the primary and secondary entities are implemented in integrated circuits.
WO 2004/050369 PCT/AU2003/001616 22 Preferably, the first entity wishes to communicate with one of the second entities, the method including the steps, in the first entity, of: receiving data from the second entity; 5 using the data and the first secret information to generate the second secret information associated with the second entity. Preferably, the data contains an identifier for the second entity 10 Preferably, the first entity wishes to send an authenticated message to the second entity, the method including the steps, in the first entity, of: using the generated second secret information to sign a message, thereby generating a digital signature; outputting the message and the digital signature for use by the second entity, which can validate the 15 message by using the digital signature and its own copy of the second secret information. Preferably, the generated signature includes a nonce from the first entity, and the output from the first entity includes the nonce, thereby enabling the second entity to validate the message using the digital signature, the nonce, and its own copy of the second secret information. 20 Preferably, the data contains a first nonce. Preferably, the first entity wishes to send an authenticated message to the second entity, the method including the steps, in the first entity, of: 25 using the generated second secret information and the first nonce to sign a message, thereby generating a digital signature; outputting the message and the digital signature for use by the second entity, which can validate the message by using the digital signature and its own copy of the second secret information. 30 Preferably, the generated signature includes a second nonce from the first entity, and the output from the first entity includes the second nonce, thereby enabling the second entity to validate the message using the digital signature, the first and second nonces, and its own copy of the second secret information. Preferably, the first entity wishes to send an encrypted message to the second entity, the method including the 35 steps, in the first entity, of: using the generated second secret information to encrypt a message, thereby generating an encrypted message; outputting the encrypted message for use by the second entity, which can decrypt the message by using its own copy of the second secret information. 40 WO 2004/050369 PCT/AU2003/001616 23 Preferably, the encrypted message includes a nonce from the first entity, and the output from the first entity includes the nonce, thereby enabling the second entity to decrypt the message using the nonce, and its own copy of the second secret information. 5 Preferably, the first entity wishes to send an encrypted message that incorporates the first nonce to the second entity, the method including the steps, in the first entity, of: using the generated second secret information to encrypt a message and the first nonce, thereby generating an encrypted message; outputting the encrypted message for use by the second entity, which can decrypt the encrypted 10 message by using its own copy of the second secret information. Preferably, the encrypted message includes a second nonce from the first entity, and the output from the first entity includes the second nonce. 15 In accordance with another aspect of the invention, there is provided a method of generating and sending a message from a first entity, the method including the steps of: determining a message including an action; generating an authentication code on the basis of the action and a parameter, the parameter being indicative of an attribute of the action; and 20 sending the message and authentication code from the first entity. In accordance with a further aspect of the invention, there is provided a method of generating and sending a message from a first entity, the first entity including an identifier that distinguishes it from a plurality of other entities of a similar type, the method comprising the steps of: 25 determining a message including an action; generating an authentication code on the basis of the action and a parameter, the parameter being based on the identifier; and sending the message and authentication code from the first entity. 30 Preferably, the action is a function, and the parameter is indicative of the function. More preferably, the entity is capable of generating messages for each of a plurality of types of function, and the parameter is indicative of the type of function comprised by the message that is sent. 35 Preferably, the message includes one or more operands of the function. Preferably, the function is a read function and the one or more operands include an address to be read. Preferably, the function is a write function and the one or more operands include data to be written. 40 WO 2004/050369 PCT/AU2003/001616 24 Preferably, the types of function include at least a read and a write, wherein the authentication step produces a different authentication code depending upon whether the action is a read or a write. Preferably, the authentication step produces includes authentication codes 5 In accordance with another aspect of the invention, there is provided a method of generating a first authentication code for a first message for a first function, wherein operands for the first authentication function used to generate the first authentication code include at least part of the first message and at least one identifier associated with the first function, 10 Preferably, the method further including the steps of verifying the authentication code in accordance with the at least one identifier associated with the first function. Preferably, the identifier is indicative of a type of the function. 15 Preferably, the at least one identifier is indicative of the entity generating the authentication code. Preferably, the at least one identifier is indicative of an entity for which the authentication code is generated. 20 Preferably, the method includes the step, prior to generating the authentication code, of receiving a request from the entity for the first message, the request including information indicative of an identity of the entity. In accordance with another aspect of the invention, there is provided a method of preventing a first action associated with a first message from being performed in a target entity, the method including the steps of: 25 sending the first message to the target entity, the first message being configured to cause the entity to perform the first action and a second action; and sending a second message to the target entity, the second message being configured to cause the entity to perform a third action; wherein the entity is configured such that performance of the second action and the third action is 30 mutually incompatible. In accordance with a further aspect of the invention, there is provided a method of attempting first write and a second write to first and second security fields in a target entity, the method including the steps of: sending a first message to the target entity, the first message being configured to cause the entity to 35 perform an action and to update the first and second security fields; and sending a second message to the target entity, the second message being configured to cause the entity to update the first and second security fields; wherein the security fields have write restrictions associated with them such that updating the security fields in accordance with the first message prevents subsequent updating of the security fields in 40 accordance with the second message, and wherein updating the security fields in accordance with the second WO 2004/050369 PCT/AU2003/001616 25 message prevents subsequent updating of the security fields with the first message, and wherein the first action is only performed when updating of the security fields by the first message is successful. In accordance with a further aspect of the invention, there is provided a method of performing a second 5 attempted write to two security fields in a target entity to prevent subsequent application of an earlier attempted write to a data field, wherein: each of the first and second security fields has a monotonically changeable write restriction associated with it; and the first attempted write included a first data value for the data field and first and second security 10 values for the first and second security fields respectively; the method including the step of sending a second write to the target entity, the second write including third and fourth security values for the first and second security fields respectively, wherein the write restrictions are such that application of the third and fourth security values to the first and second fields are mutually incompatible with application of the first and second security values to the first and second 15 security fields, such that if any of the fields cannot be written to, none of them are written to. Preferably, the write restrictions: prevent the second write from being performed in the event that the first write was previously performed; and 20 prevent the first write from subsequently being performed in the event that the second write is performed. Preferably, the second write is sent in response to a notification that the first write was not successfully performed. 25 Preferably, the second write is sent in response to a notification that the first write was not received. Preferably, the second write is sent after a predetermined time has elapsed after sending the first write without receiving confirmation of the first write being received or successfully performed. 30 Preferably, the method further includes the step of sending the second write a plurality of times until the second write is successfully received and/or performed. Preferably, the method further includes the step of verifying the successful second write by performing an 35 authenticated read of the first and second security fields. Preferably, the method further includes updating a value related to the data field. Preferably, the write permissions are such that only decrementing or incrementing of the security fields are 40 permitted.
WO 2004/050369 PCT/AU2003/001616 26 More preferably, the write permissions are such that only decrementing of the security fields is permitted, and wherein: the value in the first security field prior to the first attempted write was x; 5 the value in the second security field prior to the first attempted write was y; the value of the first security data was x-a; the value of the second security data was y-b; the value of the third security data being x-c; and the value of the fourth security data being y-d; 10 wherein a<b, d<c and a, b, c and d are >0. It is particularly preferable that a=d and b=c, and even more preferable that a=d=1 and b=c=2. Preferably, the target entity is a first integrated circuit and the messages are sent by a second integrated 15 circuit. In accordance with another aspect of the invention, there is provided a method of enabling selection of one or more pieces of secret information stored in a first entity, the first entity also storing at least one value indicative of at least one attribute for each of the one or more pieces of secret information, the method 20 comprising the steps of: (y) receiving at the first entity a request from a second entity for one or more of the values for one or more of the pieces of secret information stored in the first entity; and (z) in response to the request, outputting the values to the second entity. 25 Preferably, each of the pieces of secret information has an associated index and the request in step (y) includes one or more of the indexes to identify those pieces of secret information for which the values are requested. Preferably, the request in step (y) is a request for the values all of the pieces of secret information and the 30 response in step (z) orders the values such that the second entity can determine which values are associated with which piece of secret information, and can use the order to generate an index for the secret information. Preferably, the method further includes the steps, in the first entity and following step (z), of: (iii) receiving a request from the second entity identifying a function and identifying the index of a piece 35 of secret information to be used in performing the function; and (iv) performing the function using the identified piece of secret information. Preferably, the method further includes the steps, in the first entity and following step (z), of (v) receiving a request from the second entity identifying a function and a piece of secret information to 40 be used in performing the function; and WO 2004/050369 PCT/AU2003/001616 27 (vi) performing the function using at least the identified piece of secret information, the identified piece of secret information being identified in the request of step (v) on the basis of at least one of the values output in step (z). 5 Preferably, the secret information is stored in one or more physical locations of the first entity, and wherein the values are not indicative of those physical locations. Preferably, the first entity is implemented in a first integrated circuit and the second entity is implemented in a second integrated circuit. 10 Preferably, the first integrated circuit includes a memory for storing the pieces of secret information and the values. Preferably, there is a plurality of the first integrated circuits, wherein the physical location of a piece of the 15 secret information having particular attributes is mutually different for at least some of the first integrated circuits. Preferably, each of the pieces of secret information is a key for use with a corresponding authentication, encryption or decryption function. 20 Preferably, the integrated circuit is programmed and configured to apply at least one of the authentication, encryption or decryption functions to data using the corresponding key as an operand. Preferably, the attribute stored for at least one of the pieces of secret information is the length of that at least 25 one of the pieces of secret information. Preferably, the attribute stored for at least one of the pieces of secret information is the authentication, encryption or decryption type associated with that at least one of the pieces of secret information. 30 Preferably, the attribute value stored for at least one of the pieces of secret information is indicative of a permission associated with that at least one of the pieces of secret information. In accordance with a further aspect of the invention, there is provided a system including first and second integrated circuits, the first integrated circuit implementing the first entity of claim 1, the second integrated 35 circuit being programmed and configured to issue a request to the first integrated circuit for attribute values of any secret information stored by the first integrated circuit, and the first integrated circuit being programmed and configured to respond to the request by supplying the attribute values of the pieces of secret information to the external source.
WO 2004/050369 PCT/AU2003/001616 28 Preferably, the second integrated circuit is a printer controller chip and the first integrated circuit is a peripheral chip in communication with the printer controller. Preferably, the printer controller chip is installed in a printer and the peripheral chip is in a package that is 5 releasably attachable to the printer via a connector, the connector enabling communication between the printer controller chip and the peripheral chip. Preferably, the printer controller chip and the peripheral chip are installed in a printer. 10 Preferably, the package is an ink refill cartridge. Preferably, the package is a performance setting cartridge configured to set a performance level of the printer. Preferably, in the event at least one of the pieces of secret information can be altered or updated, the first 15 integrated circuit is configured to alter the attribute values associated with that at least one piece of secret information as required by the alteration or update such that the update or alteration of the at least one piece of secret information and its associated attributes is atomic. In accordance with another aspect of the invention, there is provided an integrated circuit including an on 20 board system clock, the integrated circuit including a clock filter configured to determine a temperature of the integrated circuit and to alter an output of the system clock based on the temperature. Preferably, the clock filter is configured to alter the output of the system clock in the event the temperature is outside a predetermined temperature range. 25 More preferably, altering the output includes preventing the clock signal from reaching one or more logical circuits on the integrated circuit to which it would otherwise be applied. It is particularly preferred that the predetermined temperature range is selected such that a temperature-related 30 speed of the system clock output that is not due to the clock filter is within a predetermined frequency range. It is desirable that the frequency range be within an operating frequency of some or all of the logic circuitry to which the system clock is supplied. In the preferred form of the invention, the clock filter is configured to prevent the system clock from reaching 35 some or all of the logic circuitry in the event the temperature falls below a predetermined level. This level is chosen to be high enough that race conditions, in which the clock speeds up to the point where logic circuitry behaviour becomes unpredictable, are avoided. In accordance with another aspect of the present invention, there is provided a method of manufacturing a 40 series of integrated circuits having related functionality, the method including the steps of: WO 2004/050369 PCT/AU2003/001616 29 (vii) determining an identifier; (viii) permanently storing the identifier on one of the integrated circuits; (ix) repeating steps (vii) and (viii) for each integrated circuit in the series; wherein the identifiers for the series are determined in such a way that knowing the identifier of one 5 of the integrated circuits does not improve the ability of an attacker to determine the identifier of any of the other integrated circuits. Preferably, the identifier for each integrated circuit is determined using a stochastic mechanism, thereby rendering highly improbable the replication of some or all of the series of identifiers stored on the series of the 10 integrated circuits. In accordance with another aspect of the invention, there is provided a series of integrated circuits having related functionality, wherein each of the integrated circuits incorporates an identifier determined and stored in accordance with the first aspect. 15 Preferably, each of the integrated circuits is a printer controller. In accordance with another aspect of the invention, there is provided a first integrated circuit of a series of integrated circuits according to the second aspect, operable in first and second mode, wherein in the first 20 mode, supervisor code can access the identifier and in the second mode, user code cannot access the identifier. Preferably, the supervisor mode is available to a program upon verification of that program by a boot program of the integrated circuit. 25 Preferably, the identifier is mapped into a key K. Preferably, K is the identifier. Preferably, K is created by applying a hash function or one-way function to the identifier. 30 Preferably, the integrated circuit is configured to produce and output a message, the message including a result of encrypting K. In accordance with another aspect of the invention, there is provided a method of injecting a key into a target 35 integrated circuit, comprising the step of receiving the message generated by the first integrated circuit of claim 10, and transferring a second key into the target integrated circuit, the second key being based on K. Preferably, the method includes generating the second key by manipulating K with a function. 40 More preferably, the function uses K and a code associated with the target integrated circuit as operands.
WO 2004/050369 PCT/AU2003/001616 30 Preferably, the code is a code that is relatively unique to the target integrated circuit. Preferably, K and the second key enable secure communication between the first integrated circuit and the 5 target integrated circuit. Preferably, the second integrated circuit is configured to communicate securely with a third integrated circuit, thereby enabling it to act as an intermediary between the first integrated circuit and the third integrated circuit, allowing secure communication therebetween. 10 Preferably, the first integrated circuit and the third integrated circuit do not share a key for use in the secure communication. Preferably, the first integrated circuit is a printer controller configured to perform an authenticated read of the 15 third integrated circuit by securely communicating via the second integrated circuit. Preferably, the authenticated read relates to monitoring or updating usage of a resource. In accordance with another aspect of the invention,, there is provided a method of enabling software 20 development for an integrated circuit, the integrated circuit being configured to run a boot program that prevents unverified software from subsequently being loaded onto, or run by, the integrated circuit, the method including the step of loading an intermediate program onto the integrated circuit, the intermediate program being customised for a particular one or more of a plurality of potential integrated circuits that, when run on the processor, enables loading or running of code on only the particular one or more integrated circuits. 25 Preferably, the intermediate program enables the loading or running of unverified code on only the particular one or more integrated circuits. Preferably, the intermediate program enables the loading or running of the code only when the code includes 30 data indicative of the particular one or more integrated circuits. Preferably, the intermediate program includes an intermediate boot key, such that the intermediate program enables loading or running of the code only when the code is verified in accordance with the intermediate boot key. 35 In accordance with another aspect of the invention, there is provided an integrated circuit configured to run a boot program that prevents unverified software from subsequently being loaded onto, or run by, the integrated circuit. 40 Preferably, the integrated circuit is programmed with program code configured to: WO 2004/050369 PCT/AU2003/001616 31 receive software data and a digital signature of the software data generate a first digest from the software data; and compare the first digest against a second digest obtained via the digital signature that accompanied the received software data; 5 wherein the program is considered valid when the first and second digests match. Preferably, one or both of the digests were generated using a SHAl function. Preferably, the boot program contains a plurality of keys, and one of the keys is selected for use in generating 10 the first digest, the key being selected in accordance with a selection criterion. Preferably, the selection criterion is time-based, a particular one of the keys being selected depending on the time the selection is made. 15 Preferably, the selection criteria relates to a physical arrangement or configuration of the integrated circuit. Preferably, the physical arrangement or configuration includes one or more of the following: one or more pads wired to a reference voltage or to ground; one or more fuses, one or more of which has been blown; or 20 the contents of non-volatile memory. Preferably, the integrated circuit is programmed with program code configured to: receive encrypted software data, decrypt the software data; and 25 validate the software data; wherein the decrypted software is executed only when the validation is successful. Preferably, the encryption function is RSA. 30 Preferably, the boot program contains a plurality of keys, and one of the keys is selected for use in decrypting the software data, the key being selected in accordance with a selection criterion. Preferably, the selection criterion is time-based, a particular one of the keys being selected depending on the time the selection is made. 35 Preferably, the selection criteria relates to a physical arrangement or configuration of the integrated circuit. Preferably, the physical arrangement or configuration includes one or more of the following: one or more pads wired to a reference voltage or to ground; 40 one or more fuses, one or more of which has been blown; or WO 2004/050369 PCT/AU2003/001616 32 the contents of non-volatile memory. In accordance with a further aspect of the invention, there is provided a method of passing validated information along a series of entities, the series of entities including a source entity, a series of at least one 5 intermediate entity, and a target entity, wherein each of the entities shares a validation parameter with its immediately neighbouring entity or entities in the series, the method comprising the steps, commencing in the source entity, of: (x) in the current entity, generating a validation code for the information, the validation code being based on the validation parameter shared between the current entity and the next entity in the series; 10 (xi) outputting the validation code; (xii) receiving the validation code in the next entity in the series and making that entity the current entity; (xiii) verifying the information via the validation code in the current entity using the validation parameter required to verify it; (xiv) repeating steps (x) to (xi) until the last intermediate entity in the series has output the validation code 15 it generated; (xv) receiving the validation code in the target entity and verifying the information via the validation code and the validation parameter required to verify it. Preferably, step (xi) includes the substep of outputting the information. 20 Preferably, step (xv) includes receiving the information and using it during the verification. Preferably, step (xii) includes receiving the information and using it during the verification. 25 Preferably, a controller is in contact with at least some of the entities, the controller being configured to pass the information and/or the validation codes between adjacent entities in the series. Preferably, step (x) is performed in response to an instruction issued by the controller. 30 Preferably, the instruction includes a request for the information upon which the validation is to be performed. Preferably, the validation code is a digital signature produced by a digital signature function using the information and the validation parameter as operands. 35 Preferably, the validation parameter is a key Preferably, the key is a symmetric key Preferably, the validation parameter is an asymmetric key-pair, and the public and private components of the 40 key-pair are in respective neighbouring entities in the series.
WO 2004/050369 PCT/AU2003/001616 33 Preferably, the validation code is a digital signature generated with a digital signature function using the key or key-pair component, the information and at least one nonce as inputs. 5 Preferably, the at least one nonce is generated in the current entity in response to an instruction issued by the neighbouring entity of the current entity closer to the target entity. Preferably, the at least one nonce is randomly, pseudo-randomly or arbitrarily generated number. 10 Preferably, the at least one nonce is supplied to the current entity in an instruction issued by the neighbouring entity of the current entity closer to the target entity. Preferably, the nonce is randomly, pseudo-randomly or arbitrarily generated number. 15 Preferably, a different validation parameter is used for the validation step performed at any two adjacent entities. Preferably, at least one of the entities is an integrated circuit. 20 Preferably, the target entity is a printer controller integrated circuit. Preferably, the source entity is a printer controller integrated circuit. Preferably, either the source entity or the target entity is a printer controller integrated circuit and the at least 25 one intermediate entity is a verification chip associated with the printer controller. Preferably, the controller is a printer controller integrated circuit. Preferably, one of the entities is the controller. 30 Preferably, the printer controller has a relatively unique identity and the verification chip includes a key based on the unique identity. Preferably, the source or target entity is an integrated circuit associated with a package that contains ink. 35 In accordance with a further aspect of the invention, there is provided an integrated circuit incorporating microelectromechanical systems (MEMS), having a total area greater than an area of at least one of the reticles used to manufacture it.
WO 2004/050369 PCT/AU2003/001616 34 Preferably, the integrated circuit includes a stitch region where the multiple reticle fields overlapped during manufacturing of the integrated circuit. Preferably, the surface area of the integrated circuit is larger than a single stepping field of a reticle used to 5 manufacture the integrated circuit. In accordance with another aspect of the invention, there is provided an integrated circuit according to the first aspect, manufactured using at least two different types of reticles. 10 Preferably, the integrated circuit is manufactured using multiple applications of the same reticle. Preferably, the integrated circuit is a printhead. In accordance with a further aspect of the invention, there is provided a method of manufacturing an 15 integrated circuit incorporating MEMS, comprising laying out the integrated circuit using a plurality of overlapping reticles. Preferably, the overlapping reticles are the same as each other. 20 Preferably, the reticles are different to each other. Preferably, the reticles are different lengths. Preferably, a plurality of the integrated circuits are manufactured on a single substrate wafer, wherein each of 25 the integrated circuits is manufactured incorporating MEMS, comprising laying out of the integrated circuit using a plurality of overlapping reticles. Preferably, at least some of the integrated circuits are different to each other. 30 Preferably, the integrated circuits are of different lengths. In accordance with another aspect of the invention, there is provided a method of laying out an integrated circuit, the method including the steps of: defing a layout of an integrated circuit; 35 defining a joint path; modifying at least one element within an overlap area adjacent the joint path to take into account reticle field overlap during a subsequent manufacturing step.
WO 2004/050369 PCT/AU2003/001616 35 In accordance with another embodiment of the invention, there is provided, in a system comprising a plurality of consumers of one or more common resources, a method of tracking usage of the one or more common resources, comprising the steps of: from each consumer, broadcasting to each of the other consumers a value indicative of an amount of 5 the one or more resources consumed; at each of the consumers, receiving the broadcasted values from the other consumers; and in each consumer, storing a record of the total of the values that the consumer broadcasted and the values received from the other consumers. 10 Preferably, a memory stores a total indicative of the sum of all values broadcast by the consumers, the method further comprising the steps of, for each of at least a plurality of the consumers: performing an authenticated read of the total in the memory; comparing the total in the consumer's record with the total read from the memory; and in the event the totals do not match, performing an action. 15 Preferably, the memory is in one of the consumers and comprises that consumer's record. Preferably, the action includes halting printing and or outputting an error message; 20 Preferably, the values are broadcast in a non-secure manner. Preferably, the value is signless, thereby preventing recrediting of the total in the memory. Preferably, the consumers are printer controllers. 25 Preferably, each of the printer controllers controls printing to a different part of print media to be printed. Preferably, the resource is ink and the one or more values represent one or more corresponding inks consumed by one or more printheads associated with the printer controllers. 30 WO 2004/050369 PCT/AU2003/001616 36 BRIEF DESCRIPTION OF THE DRAWINGS Preferred and other embodiments of the invention will now be described, by way of example only, with reference to the accompanying drawings, in which: Figure 1 is an example of state machine notation 5 Figure 2 shows document data flow in a printer Figure 3 is an example of a single printer controller (hereinafter "SoPEC") A4 simplex printer system Figure 4 is an example of a dual SoPEC A4 duplex printer system Figure 5 is an example of a dual SoPEC A3 simplex printer system Figure 6 is an example of a quad SoPEC A3 duplex printer system 10 Figure 7 is an example of a SoPEC A4 simplex printing system with an extra SoPEC used as DRAM storage Figure 8 is an example of an A3 duplex printing system featuring four printing SoPECs Figure 9 shows pages containing different numbers of bands Figure 10 shows the contents of a page band 15 Figure 11 illustrates a page data path from host to SoPEC Figure 12 shows a page structure Figure 13 shows a SoPEC system top level partition Figure 14 shows a SoPEC CPU memory map (not to scale) Figure 15 is a block diagram of CPU 20 Figure 16 shows CPU bus transactions Figure 17 shows a state machine for a CPU subsystem slave Figure 18 shows a SoPEC CPU memory map (not to scale) Figure 19 shows an external signal view of a memory management unit (hereinafter "MMU") sub block partition 25 Figure 20 shows an internal signal view of an MMU sub-block partition Figure 21 shows a DRAM write buffer Figure 22 shows DIU waveforms for multiple transactions Figure 23 shows a SoPEC LEON CPU core Figure 24 shows a cache data RAM wrapper 30 Figure 25 shows a realtime debug unit block diagram Figure 26 shows interrupt acknowledge cycles for single and pending interrupts Figure 27 shows an A3 duplex system featuring four printing SoPECs with a single SoPEC DRAM device Figure 28 is an SCB block diagram 35 Figure 29 is a logical view of the SCB of figure 28 Figure 30 shows an ISI configuration with four SoPEC devices Figure 31 shows half-duplex interleaved transmission from ISIMaster to ISISlave Figure 32 shows ISI transactions Figure 33 shows an ISI long packet 40 Figure 34 shows an ISI ping packet WO 2004/050369 PCT/AU2003/001616 37 Figure 35 shows a short ISI packet Figure 36 shows successful transmission of two long packets with sequence bit toggling Figure 37 shows sequence bit operation with errored long packet Figure 38 shows sequence bit operation with ACK error 5 Figure 39 shows an ISI sub-block partition Figure 40 shows an ISI serial interface engine functional block diagram Figure 41 is an SIE edge detection and data 10 diagram Figure 42 is an SIE Rx/Tx state machine Tx cycle state diagram Figure 43 shows an SIE Rx/Tx state machine Tx bit stuff '0' cycle state diagram 10 Figure 44 shows an SIE Rx/Tx state machine Tx bit stuff '1' cycle state diagram Figure 45 shows an SIE Rx/Tx state machine Rx cycle state diagram Figure 46 shows an SIE Tx functional timing example Figure 47 shows an SIE Rx functional timing example Figure 48 shows an SIE Rx/Tx FIFO block diagram 15 Figure 49 shows SIE Rx/Tx FIFO control signal gating Figure 50 shows an SIE bit stuffing state machine Tx cycle state diagram Figure 51 shows an SIE bit stripping state machine Rx cycle state diagram Figure 52 shows a CRC1 6 generation/checking shift register Figure 53 shows circular buffer operation 20 Figure 54 shows duty cycle select Figure 55 shows a GPIO partition Figure 56 shows a motor control RTL diagram Figure 57 is an input de-glitch RTL diagram Figure 58 is a frequency analyser RTL diagram 25 Figure 59 shows a brushless DC controller Figure 60 shows a period measure unit Figure 61 shows line synch generation logic Figure 62 shows an ICU partition Figure 63 is an interrupt clear state diagram 30 Figure 64 is a watchdog timer RTL diagram Figure 65 is a generic timer RTL diagram Figure 67 is a Pulse generator RTL diagram Figure 68 shows a SoPEC clock relationship Figure 69 shows a CPR block partition 35 Figure 70 shows reset deglitch logic Figure 71 shows reset synchronizer logic Figure 72 is a clock gate logic diagram Figure 73 shows a PLL and Clock divider logic Figure 74 shows a PLL control state machine diagram 40 Figure 75 shows a LSS master system-level interface WO 2004/050369 PCT/AU2003/001616 38 Figure 76 shows START and STOP conditions Figure 77 shows an LSS transfer of 2 data bytes Figure 78 is an example of an LSS write to a QA Chip Figure 79 is an example of an LSS read from QA Chip 5 Figure 80 shows an LSS block diagram Figure 81 shows an LSS multi-command transaction Figure 82 shows start and stop generation based on previous bus state Figure 83 shows an LSS master state machine Figure 84 shows LSS master timing 10 Figure 85 shows a SoPEC system top level partition Figure 86 shows an ead bus with 3 cycle random DRAM read accesses Figure 87 shows interleaving of CPU and non-CPU read accesses Figure 88 shows interleaving of read and write accesses with 3 cycle random DRAM accesses Figure 89 shows interleaving of write accesses with 3 cycle random DRAM accesses 15 Figure 90 shows a read protocol for a SoPEC Unit making a single 256-bit access Figure 91 shows a read protocol for a SoPEC Unit making a single 256-bit access Figure 92 shows a write protocol for a SoPEC Unit making a single 256-bit access Figure 93 shows a protocol for a posted, masked, 128-bit write by the CPU Figure 94 shows a write protocol shown for CDU making four contiguous 64-bit accesses 20 Figure 95 shows timeslot-based arbitration Figure 96 shows timeslot-based arbitration with separate pointers Figure 97 shows a first example (a) of separate read and write arbitration Figure 98 shows a second example (b) of separate read and write arbitration Figure 99 shows a third example (c) ofseparate read and write arbitration 25 Figure 100 shows a DIU partition Figure 101 shows a DIU partition Figure 102 shows multiplexing and address translation logic for two memory instances Figure 103 shows a timing of daudcuvalid, dcu dauadv and dcudauwadv Figure 104 shows a DCU state machine 30 Figure 105 shows random read timing Figure 106 shows random write timing Figure 107 shows refresh timing Figure 108 shows page mode write timing Figure 109 shows timing of non-CPU DIU read access 35 Figure 110 shows timing of CPU DIU read access Figure 111 shows a CPU DIU read access Figure 112 shows timing of CPU DIU write access Figure 113 shows timing of a non-CDU / non-CPU DIU write access Figure 114 shows timing of CDU DIU write access 40 Figure 115 shows command multiplexor sub-block partition WO 2004/050369 PCT/AU2003/001616 39 Figure 116 shows command multiplexor timing at DIU requestors interface Figure 117 shows generation of rearbitrate and rearbitratewadv Figure 118 shows CPU interface and arbitration logic Figure 119 shows arbitration timing 5 Figure 120 shows setting RotationSync to enable a new rotation. Figure 121 shows a timeslot based arbitration Figure 122 shows a timeslot based arbitration with separate pointers Figure 123 shows a CPU pre-access write lookahead pointer Figure 124 shows arbitration hierarchy 10 Figure 125 shows hierarchical round-robin priority comparison Figure 126 shows a read multiplexor partition Figure 127 shows a read command queue (4 deep buffer) Figure 128 shows state-machines for shared read bus accesses Figure 129 shows a write multiplexor partition 15 Figure 130 shows a read multiplexer timing for back-to-back shared read bus transfer Figure 131 shows a write multiplexer partition Figure 132 shows a block diagram of a PCU Figure 133 shows PCU accesses to PEP registers Figure 134 shows command arbitration and execution 20 Figure 135 shows DRAM command access state machine Figure 136 shows an outline of contone data flow with respect to CDU Figure 137 shows a DRAM storage arrangement for a single line of JPEG 8x8 blocks in 4 colors Figure 138 shows a read control unit state machine Figure 139 shows a memory arrangement of JPEG blocks 25 Figure 140 shows a contone data write state machine Figure 141 shows lead-in and lead-out clipping of contone data in multi-SoPEC environment Figure 142 shows a block diagram of CFU Figure 143 shows a DRAM storage arrangement for a single line of JPEG blocks in 4 colors Figure 144 shows a block diagram of color space converter 30 Figure 145 shows a converter/invertor Figure 146 shows a high-level block diagram of LBD in context Figure 147 shows a schematic outline of the LBD and the SFU Figure 148 shows a block diagram of lossless bi-level decoder Figure 149 shows a stream decoder block diagram 35 Figure 150 shows a command controller block diagram Figure 151 shows a state diagram for command controller (CC) state machine Figure 152 shows a next edge unit block diagram Figure 153 shows a next edge unit buffer diagram Figure 154 shows a next edge unit edge detect diagram 40 Figure 155 shows a state diagram for the next edge unit state machine WO 2004/050369 PCT/AU2003/001616 40 Figure 156 shows a line fill unit block diagram Figure 157 shows a state diagram for the Line Fill Unit (LFU) state machine Figure 158 shows a bi-level DRAM buffer Figure 159 shows interfaces between LBD/SFU/HCU 5 Figure 160 shows an SFU sub-block partition Figure 161 shows an LBDPrevLineFifo sub-block Figure 162 shows timing of signals on the LBDPrevLineFIFO interface to DIU and address generator Figure 163 shows timing of signals on LBDPrevLineFIFO interface to DIU and address generator 10 Figure 164 shows LBDNextLineFifo sub-block Figure 165 shows timing of signals on LBDNextLineFIFO interface to DIU and address generator Figure 166 shows LBDNextLineFIFO DIU interface state diagram Figure 167 shows an LDB to SFU write interface Figure 168 shows an LDB to SFU read interface (within a line) 15 Figure 169 shows an HCUReadLineFifo Sub-block Figure 170 shows a DIU write Interface Figure 171 shows a DIU Read Interface multiplexing by select hrfplf Figure 172 shows DIU read request arbitration logic Figure 173 shows address generation 20 Figure 174 shows an X scaling control unit Figure 175 Y shows a scaling control unit Figure 176 shows an overview of X and Y scaling at HCU interface Figure 177 shows a high level block diagram of TE in context Figure 178 shows a QR Code 25 Figure 179 shows Netpage tag structure Figure 180 shows a Netpage tag with data rendered at 1600 dpi (magnified view) Figure 181 shows an example of 2x2 dots for each block of QR code Figure 182 shows placement of tags for portrait & landscape printing Figure 183 shows agGeneral representation of tag placement 30 Figure 184 shows composition of SoPEC's tag format structure Figure 185 shows a simple 3x3 tag structure Figure 186 shows 3x3 tag redesigned for 21 x 21 area (not simple replication) Figure 187 shows a TE Block Diagram Figure 188 shows a TE Hierarchy 35 Figure 189 shows a block diagram of PCU accesses Figure 190 shows a tag encoder top-level FSM Figure 191 shows generated control signals Figure 192 shows logic to combine dot information and encoded data Figure 193 shows generation of Lastdotintag/1 40 Figure 194 shows generation of Dot Position Valid WO 2004/050369 PCT/AU2003/001616 41 Figure 195 shows generation of write enable to the TFU Figure 196 shows generation of Tag Dot Number Figure 197 shows TDI Architecture Figure 198 shows data flow through the TDI 5 Figure 199 shows raw tag data interface block diagram Figure 200 shows an RTDI State Flow Diagram Figure 201 shows a relationship between TEendoftagdata, cdustartofbandstore and cdu endofbandstore Figure 202 shows a TDi State Flow Diagram 10 Figure 203 shows mapping of the tag data to codewords 0-7 Figure 204 shows coding and mapping of uncoded fixed tag data for (15,5) RS encoder Figure 205 shows mapping of pre-coded fixed tag data Figure 206 shows coding and mapping of variable tag data for (15,7) RS encoder Figure 207 shows coding and mapping of uncoded fixed tag data for (15,7) RS encoder 15 Figure 208 shows mapping of 2D decoded variable tag data Figure 209 shows a simple block diagram for an m=4 Reed Solomon encoder Figure 210 shows an RS encoder 1/O diagram Figure 211 shows a (15,5) & (15,7) RS encoder block diagram Figure 212 shows a (15,5) RS encoder timing diagram 20 Figure 213 shows a (15,7) RS encoder timing diagram Figure 214 shows a circuit for multiplying by alpha 3 Figure 215 shows adding two field elements Figure 216 shows an RS encoder implementation Figure 217 shows an encoded tag data interface 25 Figure 218 shows an encoded fixed tag data interface Figure 219 shows an encoded variable tag data interface .Figure 220 shows an encoded variable tag data sub-buffer Figure 221 shows a breakdown of the tag format structure Figure 222 shows a TFSI FSM state flow diagram 30 Figure 223 shows a TFS block diagram Figure 224 shows a table A interface block diagram Figure 225 shows a table A address generator Figure 226 shows a table C interface block diagram Figure 227 shows a table B interface block diagram 35 Figure 228 shows interfaces between TE, TFU and HCU Figure 229 shows a 16-byte FIFO in TFU Figure 230 shows a high level block diagram showing the HCU and its external interfaces Figure 231 shows a block diagram of the HCU Figure 232 shows a block diagram of the control unit 40 Figure 233 shows a block diagram of determine advdot unit WO 2004/050369 PCT/AU2003/001616 42 Figure 234 shows a page structure Figure 235 shows a block diagram of a margin unit Figure 236 shows a block diagram of a dither matrix table interface Figure 237 shows an example of reading lines of dither matrix from DRAM 5 Figure 238 shows a state machine to read dither matrix table Figure 239 shows a contone dotgen unit Figure 240 shows a block diagram of dot reorg unit Figure 241 shows an HCU to DNC interface (also used in DNC to DWU, LLU to PHI) Figure 242 shows SFU to HCU interface (all feeders to HCU) 10 Figure 243 shows representative logic of the SFU to HCU interface Figure 244 shows a high-level block diagram of DNC Figure 245 shows a dead nozzle table format Figure 246 shows set of dots operated on for error diffusion Figure 247 shows a block diagram of DNC 15 Figure 248 shows a sub-block diagram of ink replacement unit Figure 249 shows a dead nozzle table state machine Figure 250 shows logic for dead nozzle removal and ink replacement Figure 251 shows a sub-block diagram of error diffusion unit Figure 252 shows a maximum length 32-bit LFSR used for random bit generation 20 Figure 253 shows a high-level data flow diagram of DWU in context Figure 254 shows a printhead nozzle layout for 36-nozzle bi-lithic printhead Figure 255 shows a printhead nozzle layout for a 36-nozzle bi-lithic printhead Figure 256 shows a dot line store logical representation Figure 257 shows a conceptual view of printhead row alignment 25 Figure 258 shows a conceptual view of printhead rows (as seen by the LLU and PHI) Figure 259 shows a comparison of 1.5x v 2x buffering Figure 260 shows an even dot order in DRAM (increasing sense, 13320 dot wide line) Figure 261 shows an even dot order in DRAM (decreasing sense, 13320 dot wide line) Figure 262 shows a dotline FIFO data structure in DRAM 30 Figure 263 shows a DWU partition Figure 264 shows a buffer address generator sub-block Figure 265 shows a DIU Interface sub-block Figure 266 shows an interface controller state diagram Figure 267 shows a high level data flow diagram of LLU in context 35 Figure 268 shows paper and printhead nozzles relationship (example with D 1
=D
2 =5) Figure 269 shows printhead structure and dot generate order Figure 270 shows an order of dot data generation and transmission Figure 271 shows a conceptual view of printhead rows Figure 272 shows a dotline FIFO data structure in DRAM (LLU specification) 40 Figure 273 shows an LLU partition WO 2004/050369 PCT/AU2003/001616 43 Figure 274 shows a dot generator RTL diagram Figure 275 shows a DIU interface Figure 276 shows an interface controller state diagram Figure 277 shows high-level data flow diagram of PHI in context 5 Figure 278 is intentionally omitted Figure 279 shows printhead data rate equalization Figure 280 shows a printhead structure and dot generate order Figure 281 shows an order of dot data generation and transmission Figure 282 shows an order of dot data generation and transmission (single printhead case) 10 Figure 283 shows printhead interface timing parameters Figure 284 shows printhead timing with margining Figure 285 shows a PHI block partition Figure 286 shows a sync generator state diagram Figure 287 shows a line sync de-glitch RTL diagram 15 Figure 288 shows a fire generator state diagram Figure 289 shows a PHI controller state machine Figure 290 shows a datapath unit partition Figure 291 shows a dot order controller state diagram Figure 292 shows a data generator state diagram 20 Figure 293 shows data serializer timing Figure 294 shows a data serializer RTL Diagram Figure 295 shows printhead types 0 to 7 Figure 296 shows an ideal join between two dilithic printhead segments Figure 297 shows an example of a join between two bilithic printhead segments 25 Figure 298 shows printable vs non-printable area under new definition (looking at colors as if 1 row only) Figure 299 shows identification of printhead nozzles and shift-register sequences for printheads in arrangement 1 Figure 300 shows demultiplexing of data within the printheads in arrangement 1 30 Figure 301 shows double data rate signalling for a type 0 printhead in arrangement 1 Figure 302 shows double data rate signalling for a type 1 printhead in arrangement 1 Figure 303 shows identification of printheads nozzles and shift-register sequences for printheads in arrangement 2 Figure 304 shows demultiplexing of data within the printheads in arrangement 2 35 Figure 305 shows double data rate signalling for a type 0 printhead in arrangement 2 Figure 306 shows double data rate signalling for a type 1 printhead in arrangement 2 Figure 307 shows all 8 printhead arrangements Figure 308 shows a printhead structure Figure 309 shows a column Structure 40 Figure 310 shows a printhead dot shift register dot mapping to page WO 2004/050369 PCT/AU2003/001616 44 Figure 311 shows data timing during printing Figure 312 shows print quality Figure 313 shows fire and select shift register setup for printing Figure 314 shows a fire pattern across butt end of printhead chips 5 Figure 315 shows fire pattern generation Figure 316 shows determination of select shift register value Figure 317 shows timing for printing signals figure 318 shows initialisation of printheads figure 319 shows a nozzle test latching circuit 10 figure 320 shows nozzle testing figure 321 shows a temperature reading figure 322 shows CMOS testing figure 323 shows a reticle layout figure 324 shows a stepper pattern on Wafer 15 Figure 325 shows relationship between datasets Figure 326 shows a validation hierarchy Figure 327 shows development of operating system code Figure 328 shows protocol for directly verifying reads from ChipR Figure 329 shows a protocol for signature translation protocol 20 Figure 330 shows a protocol for a direct authenticated write Figure 331 shows an alternative protocol for a direct authenticated write Figure 332 shows a protocol for basic update of permissions Figure 333 shows a protocol for a multiple-key update Figure 334 shows a protocol for a single-key authenticated read 25 Figure 335 shows a protocol for a single-key authenticated write Figure 336 shows a protocol for a single-key update of permissions Figure 337 shows a protocol for a single-key update Figure 338 shows a protocol for a multiple-key single-M authenticated read Figure 339 shows a protocol for a multiple-key authenticated write 30 Figure 340 shows a protocol for a multiple-key update of permissions Figure 341 shows a protocol for a multiple-key update Figure 342 shows a protocol for a multiple-key multiple-M authenticated read Figure 343 shows a protocol for a multiple-key authenticated write Figure 344 shows a protocol for a multiple-key update of permissions 35 Figure 345 shows a protocol for a multiple-key update Figure 346 shows relationship of permissions bits to M[n] access bits Figure 347 shows 160-bit maximal period LFSR Figure 348 shows clock filter Figure 349 shows tamper detection line 40 Figure 350 shows an oversize nMOS transistor layout of Tamper Detection Line WO 2004/050369 PCT/AU2003/001616 45 Figure 351 shows a Tamper Detection Line Figure 352 shows how Tamper Detection Lines cover the Noise Generator Figure 353 shows a prior art FET Implementation of CMOS inverter Figure 354 shows non-flashing CMOS 5 Figure 355 shows components of a printer-based refill device Figure 356 shows refilling of printers by printer-based refill device Figure 357 shows components of a home refill station Figure 358 shows a three-ink reservoir unit Figure 359 shows refill of ink cartridges in a home refill station 10 Figure 360 shows components of a commercial refill station Figure 361 shows an ink reservoir unit Figure 362 shows refill of ink cartridges in a commercial refill station (showing a single refill unit) Figure 363 shows equivalent signature generation Figure 364 shows a basic field definition 15 Figure 365 shows an example of defining field sizes and positions Figure 366 shows permissions Figure 367 shows a first example of permissions for a field Figure 368 shows a second example of permissions for a field Figure 369 shows field attributes 20 Figure 370 shows an output signature generation data format for Read Figure 371 shows an input signature verification data format for Test Figure 372 shows an output signature generation data format for Translate Figure 373 shows an input signature verification data format for WriteAuth Figure 374 shows input signature data format for ReplaceKey 25 Figure 375 shows a key replacement map Figure 376 shows a key replacement map after K 1 is replaced Figure 377 shows a key replacement process Figure 378 shows an output signature data format for GetProgramKey Figure 379 shows transfer and rollback process 30 Figure 380 shows an upgrade flow Figure 381 shows authorised ink refill paths in the printing system Figure 382 shows an input signature verification data format for XferAmount Figure 383 shows a transfer and rollback process Figure 384 shows an upgrade flow 35 Figure 385 shows authorised upgrade paths in the printing system Figure 386 shows a direct signature validation sequence Figure 387 shows signature validation using translation Figure 388 shows setup of preauth field attributes Figure 388A shows setup for multiple preauth fields 40 Figure 389 shows a high level block diagram of QA Chip WO 2004/050369 PCT/AU2003/001616 46 Figure 390 shows an analogue unit Figure 391 shows a serial bus protocol for trimming Figure 392 shows a block diagram of a trim unit Figure 393 shows a block diagram of a CPU of the QA chip 5 Figure 394 shows block diagram of an MIU Figure 395 shows a block diagram of memory components Figure 396 shows a first byte sent to an IOU Figure 397 shows a block diagram of the IOU Figure 398 shows a relationship between external SDa and SClk and generation of internal signals 10 Figure 399 shows block diagram of ALU Figure 400 shows a block diagram of DataSel Figure 401 shows a block diagram of ROR Figure 402 shows a block diagram of the ALU's 10 block Figure 403 shows a block diagram of PCU 15 Figure 404 shows a block diagram of an Address Generator Unit Figure 405 shows a block diagram for a Counter Unit Figure 406 shows a block diagram of PMU Figure 407 shows a state machine for PMU Figure 408 shows a block diagram of MRU 20 Figure 409 shows simplified MAU state machine Figure 410 shows power-on reset behaviour Figure 411 shows a ring oscillator block diagram Figure 412 shows a system clock duty cycle Figure 413 shows power-on reset WO 2004/050369 PCT/AU2003/001616 47 DETAILED DESCRIPTION OF PREFERRED AND OTHER EMBODIMENTS It will be appreciated that the detailed description that follows takes the form of a highly detailed design of the invention, including supporting hardware and software. A high level of detailed disclosure is provided to ensure that one skilled in the art will have ample guidance for 5 implementing the invention. Imperative phrases such as "must", "requires", "necessary" and "important" (and similar language) should be read as being indicative of being necessary only for the preferred embodiment actually being described. As such, unless the opposite is clear from the context, imperative wording should 10 not be interpreted as such. Nothing in the detailed description is to be understood as limiting the scope of the invention, which is intended to be defined as widely as is defined in the accompanying claims. Indications of expected rates, frequencies, costs, and other quantitative values are exemplary and 15 estimated only, and are made in good faith. Nothing in this specification should be read as implying that a particular commercial embodiment is or will be capable of a particular performance level in any measurable area. It will be appreciated that the principles, methods and hardware described throughout this document 20 can be applied to other fields. Much of the security-related disclosure, for example, can be applied to many other fields that require secure communications between entities, and certainly has application far beyond the field of printers. SYSTEM OVERVIEW 25 The preferred of the present invention is implemented in a printer using microelectromechanical systems (MEMS) printheads. The printer can receive data from, for example, a personal computer such as an IBM compatible PC or Apple computer. In other embodiments, the printer can receive data directly from, for example, a digital still or video camera. The particular choice of communication link is not important, and can be based, for example, on USB, Firewire, Bluetooth or 30 any other wireless or hardwired communications protocol. PRINT SYSTEM OVERVIEW 3 Introduction This document describes the SoPEC (Small office home office Print Engine Controller) ASIC 35 (Application Specific Integrated Circuit) suitable for use in, for example, SoHo printer products. The SoPEC ASIC is intended to be a low cost solution for bi-lithic printhead control, replacing the multichip solutions in larger more professional systems with a single chip. The increased cost competitiveness is achieved by integrating several systems such as a modified PEC1 printing pipeline, CPU control system, peripherals and memory sub-system onto one SoC ASIC, reducing 40 component count and simplifying board design.
WO 2004/050369 PCT/AU2003/001616 48 This section will give a general introduction to Memjet printing systems, introduce the components that make a bi-lithic printhead system, describe possible system architectures and show how several SoPECs can be used to achieve A3 and A4 duplex printing. The section "SoPEC ASIC" 5 describes the SoC SoPEC ASIC, with subsections describing the CPU, DRAM and Print Engine Pipeline subsystems. Each section gives a detailed description of the blocks used and their operation within the overall print system. The final section describes the bi-lithic printhead construction and associated implications to the system due to its makeup. 10 4 Nomenclature 4.1 Bi-LITHIC PRINTHEAD NOTATION A bi-lithic based printhead is constructed from 2 printhead ICs of varying sizes. The notation M:N is used to express the size relationship of each IC, where M specifies one printhead IC in inches and N specifies the remaining printhead IC in inches. 15 The 'SoPEC/MoPEC Bilithic Printhead Reference' document [10] contains a description of the bi lithic printhead and related terminology. 4.2 DEFINITIONS 20 The following terms are used throughout this specification: Bi-lithic printhead Refers to printhead constructed from 2 printhead Cs CPU Refers to CPU core, caching system and MMU. ISI-Bridge chip A device with a high speed interface (such as USB2.0, Ethernet or IEEE1 394) and one or more ISI interfaces. The 151-Bridge would be the 25 ISMaster for each of the ISI buses it interfaces to. ISIMaster The ISlMaster is the only device allowed to initiate communication on the Inter Sopec Interface (0S) bus. The ISlMaster interfaces with the host. ISISlave Multi-SoPEC systems will contain one or more ISISlave SoPECs connected to the SSa bus. ISISlaves can only respond to communication initiated by the 30 ISlMaster. LEON Refers to the LEON CPU core. LineSyncMaster The LineSyncMaster device generates the line synchronization pulse that all SoPECs in the system must synchronise their line outputs to. Multi-SoPEC Refers to SoPEC based print system with multiple SoPEC devices 35 Netpage Refers to page printed with tags (normally in infrared ink). PECi Refers to Print Engine Controller version 1, precursor to SoPEC used to control printheads constructed from multiple angled printhead segments. Printhead IC Single MEMS IC used to construct bi-lithic printhead PrintMaster The PrintMaster device is responsible for coordinating all aspects of the print 40 operation. There may only be one PrintMaster in a system.
WO 2004/050369 PCT/AU2003/001616 49 QA Chip Quality Assurance Chip Storage SoPEC An ISISlave SoPEC used as a DRAM store and which does not print. Tag Refers to pattern which encodes information about its position and orientation which allow it to be optically located and its data contents read. 5 4.3 ACRONYM AND ABBREVIATIONS The following acronyms and abbreviations are used in this specification CFU Contone FIFO Unit CPU Central Processing Unit DIU DRAM Interface Unit 10 DNC Dead Nozzle Compensator DRAM Dynamic Random Access Memory DWU DotLine Writer Unit GPIO General Purpose Input Output HCU Halftoner Compositor Unit 15 ICU Interrupt Controller Unit ISI Inter SoPEC Interface LDB Lossless Bi-level Decoder LLU Line Loader Unit LSS Low Speed Serial interface 20 MEMS Micro Electro Mechanical System MMU Memory Management Unit PCU SoPEC Controller Unit PHI PrintHead Interface PSS Power Save Storage Unit 25 RDU Real-time Debug Unit ROM Read Only Memory SCB Serial Communication Block SFU Spot FIFO Unit SMG4 Silverbrook Modified Group 4. 30 SoPEC Small office home office Print Engine Controller SRAM Static Random Access Memory TE Tag Encoder TFU Tag FIFO Unit TIM Timers Unit 35 USB Universal Serial Bus 4.4 PSEUDOCODE NOTATION In general the pseudocode examples use C like statements with some exceptions. Symbol and naming convections used for pseudocode. // Comment 40 Assignment WO 2004/050369 PCT/AU2003/001616 50 = ,!=,<,> Operator equal, not equal, less than, greater than Operator addition, subtraction, multiply, divide, modulus &,,^,<,>,~ Bitwise AND, bitwise OR, bitwise exclusive OR, left shift, right shift, complement AND,OR,NOT Logical AND, Logical OR, Logical inversion 5 [XX:YY] Array/vector specifier {a, b, c} Concatenation operation ++, - Increment and decrement 4.4.1 Register and signal naming conventions In general register naming uses the C style conventions with capitalization to denote word 10 delimiters. Signals use RTL style notation where underscore denote word delimiters. There is a direct translation between both convention. For example the CmdSourceFifo register is equivalent to cmdsourcefifo signal. 4.5 STATE MACHINE NOTATION State machines should be described using the pseudocode notation outlined above. State machine 15 descriptions use the convention of underline to indicate the cause of a transition from one state to another and plain text (no underline) to indicate the effect of the transition i.e. signal transitions which occur when the new state is entered. A sample state machine is shown in Figure 1. 5 Printing Considerations 20 A bi-lithic printhead produces 1600 dpi bi-level dots. On low-diffusion paper, each ejected drop forms a 22.5gm diameter dot. Dots are easily produced in isolation, allowing dispersed-dot dithering to be exploited to its fullest. Since the bi-lithic printhead is the width of the page and operates with a constant paper velocity, color planes are printed in perfect registration, allowing ideal dot-on-dot printing. Dot-on-dot printing minimizes 'muddying' of midtones caused by inter-color bleed. 25 A page layout may contain a mixture of images, graphics and text. Continuous-tone (contone) images and graphics are reproduced using a stochastic dispersed-dot dither. Unlike a clustered-dot (or amplitude-modulated) dither, a dispersed-dot (or frequency-modulated) dither reproduces high spatial frequencies (i.e. image detail) almost to the limits of the dot resolution, while simultaneously reproducing lower spatial frequencies to their full color depth, when spatially integrated by the eye. 30 A stochastic dither matrix is carefully designed to be free of objectionable low-frequency patterns when tiled across the image. As such its size typically exceeds the minimum size required to support a particular number of intensity levels (e.g. 16x16x 8 bits for 257 intensity levels). Human contrast sensitivity peaks at a spatial frequency of about 3 cycles per degree of visual field and then falls off logarithmically, decreasing by a factor of 100 beyond about 40 cycles per degree 35 and becoming immeasurable beyond 60 cycles per degree [25][25]. At a normal viewing distance of 12 inches (about 300mm), this translates roughly to 200-300 cycles per inch (cpi) on the printed page, or 400-600 samples per inch according to Nyquist's theorem. In practice, contone resolution above about 300 ppi is of limited utility outside special applications such as medical imaging. Offset printing of magazines, for example, uses contone resolutions in the 40 range 150 to 300 ppi. Higher resolutions contribute slightly to color error through the dither.
WO 2004/050369 PCT/AU2003/001616 51 Black text and graphics are reproduced directly using bi-level black dots, and are therefore not anti aliased (i.e. low-pass filtered) before being printed. Text should therefore be supersampled beyond the perceptual limits discussed above, to produce smoother edges when spatially integrated by the eye. Text resolution up to about 1200 dpi continues to contribute to perceived text sharpness 5 (assuming low-diffusion paper, of course). A Netpage printer, for example, may use a contone resolution of 267 ppi (i.e. 1600 dpi / 6), and a black text and graphics resolution of 800 dpi. A high end office or departmental printer may use a contone resolution of 320 ppi (1600 dpi 15) and a black text and graphics resolution of 1600 dpi. Both formats are capable of exceeding the quality of commercial (offset) printing and photographic 10 reproduction. 6 Document Data Flow 6.1 CONSIDERATIONS Because of the page-width nature of the bi-lithic printhead, each page must be printed at a constant 15 speed to avoid creating visible artifacts. This means that the printing speed can't be varied to match the input data rate. Document rasterization and document printing are therefore decoupled to ensure the printhead has a constant supply of data. A page is never printed until it is fully rasterized. This can be achieved by storing a compressed version of each rasterized page image in memory. This decoupling also allows the RIP(s) to run ahead of the printer when rasterizing simple pages, 20 buying time to rasterize more complex pages. Because contone color images are reproduced by stochastic dithering, but black text and line graphics are reproduced directly using dots, the compressed page image format contains a separate foreground bi-level black layer and background contone color layer. The black layer is composited over the contone layer after the contone layer is dithered (although the contone layer 25 has an optional black component). A final layer of Netpage tags (in infrared or black ink) is optionally added to the page for printout. Figure 2 shows the flow of a document from computer system to printed page. At 267 ppi for example, a A4 page (8.26 inches x 11.7 inches) of contone CMYK data has a size of 26.3MB. At 320 ppi, an A4 page of contone data has a size of 37.8MB. Using lossy contone 30 compression algorithms such as JPEG [27], contone images compress with a ratio up to 10:1 without noticeable loss of quality, giving compressed page sizes of 2.63MB at 267 ppi and 3.78 MB at 320 ppi. At 800 dpi, a A4 page of bi-level data has a size of 7.4MB. At 1600 dpi, a Letter page of bi-level data has a size of 29.5 MB. Coherent data such as text compresses very well. Using lossless bi 35 level compression algorithms such as SMG4 fax as discussed in Section 8.1.2.3.1, ten-point plain text compresses with a ratio of about 50:1. Lossless bi-level compression across an average page is about 20:1 with 10:1 possible for pages which compress poorly. The requirement for SoPEC is to be able to print text at 10:1 compression. Assuming 10:1 compression gives compressed page sizes of 0.74 MB at 800 dpi, and 2.95 MB at 1600 dpi.
WO 2004/050369 PCT/AU2003/001616 52 Once dithered, a page of CMYK contone image data consists of 116MB of bi-level data. Using lossless bi-level compression algorithms on this data is pointless precisely because the optimal dither is stochastic - i.e. since it introduces hard-to-compress disorder. Netpage tag data is optionally supplied with the page image. Rather than storing a compressed bi 5 level data layer for the Netpage tags, the tag data is stored in its raw form. Each tag is supplied up to 120 bits of raw variable data (combined with up to 56 bits of raw fixed data) and covers up to a 6mm x 6mm area (at 1600 dpi). The absolute maximum number of tags on a A4 page is 15,540 when the tag is only 2mm x 2mm (each tag is 126 dots x 126 dots, for a total coverage of 148 tags x 105 tags). 15,540 tags of 128 bits per tag gives a compressed tag page size of 0.24 MB. 10 The multi-layer compressed page image format therefore exploits the relative strengths of lossy JPEG contone image compression, lossless bi-level text compression, and tag encoding. The format is compact enough to be storage-efficient, and simple enough to allow straightforward real time expansion during printing. Since text and images normally don't overlap, the normal worst-case page image size is image 15 only, while the normal best-case page image size is text only. The addition of worst case Netpage tags adds 0.24MB to the page image size. The worst-case page image size is text over image plus tags. The average page size assumes a quarter of an average page contains images. Table 1 shows data sizes for compressed Letter page for these different options. Table 1. Data sizes for A4 page (8.26 inches x 11.7 inches) 20 267 ppi contone 320 ppi contone 800 dpi bi-level 1600 dpi bi-level Image only (contone), 10:1 compression 2.63 MB 3.78 MB Text only (bi-level), 10:1 compression 0.74 MB 2.95 MB Netpage tags, 1600 dpi 0.24 MB 0.24 MB Worst case (text + image + tags) 3.61 MB 6.67 MB Average (text + 25% image + tags) 1.64 MB .25 MB 6.2 DOCUMENT DATA FLOW The Host PC rasterizes and compresses the incoming document on a page by page basis. The page is restructured into bands with one or more bands used to construct a page. The compressed 25 data is then transferred to the SoPEC device via the USB link. A complete band is stored in SoPEC embedded memory. Once the band transfer is complete the SoPEC device reads the compressed data, expands the band, normalizes contone, bi-level and tag data to 1600 dpi and transfers the resultant calculated dots to the bi-lithic printhead. The document data flow is 30 a The RIP software rasterizes each page description and compress the rasterized page image. 0 The infrared layer of the printed page optionally contains encoded Netpage [5] tags at a programmable density.
WO 2004/050369 PCT/AU2003/001616 53 e The compressed page image is transferred to the SoPEC device via the USB normally on a band by band basis. e The print engine takes the compressed page image and starts the page expansion. e The first stage page expansion consists of 3 operations performed in parallel 5 * expansion of the JPEG-compressed contone layer e expansion of the SMG4 fax compressed bi-level layer * encoding and rendering of the bi-level tag data. * The second stage dithers the contone layer using a programmable dither matrix, producing up to four bi-level layers at full-resolution. 10 e The second stage then composites the bi-level tag data layer, the bi-level SMG4 fax de compressed layer and up to four bi-level JPEG de-compressed layers into the full-resolution page image. * A fixative layer is also generated as required. * The last stage formats and prints the bi-level data through the bi-lithic printhead via the 15 printhead interface. The SoPEC device can print a full resolution page with 6 color planes. Each of the color planes can be generated from compressed data through any channel (either JPEG compressed, bi-level SMG4 fax compressed, tag data generated, or fixative channel created) with a maximum number of 6 data channels from page RIP to bi-lithic printhead color planes. 20 The mapping of data channels to color planes is programmable, this allows for multiple color planes in the printhead to map to the same data channel to provide for redundancy in the printhead to assist dead nozzle compensation. Also a data channel could be used to gate data from another data channel. For example in stencil mode, data from the bilevel data channel at 1600 dpi can be used to filter the contone data channel 25 at 320 dpi, giving the effect of 1600 dpi contone image. 6.3 PAGE CONSIDERATIONS DUE TO SoPEC The SoPEC device typically stores a complete page of document data on chip. The amount of storage available for compressed pages is limited to 2Mbytes, imposing a fixed maximum on compressed page size. A comparison of the compressed image sizes in Table 2 indicates that 30 SoPEC would not be capable of printing worst case pages unless they are split into bands and printing commences before all the bands for the page have been downloaded. The page sizes in the table are shown for comparison purposes and would be considered reasonable for a professional level printing system. The SoPEC device is aimed at the consumer level and would not be required to print pages of that complexity. Target document types for the SoPEC device are 35 shown Table 2. Table 2. Page content targets for SoPEC Page Content Description Calculation Size WO 2004/050369 PCT/AU2003/001616 54 (MByte) Best Case picture Image, 267ppi with 3 colors, 8.26x11.7x267x267x3 1.97 A4 size @10:1 Full page text, 800dpi A4 size 8.26x11.7x800x800 @0.74 10:1 Mixed Graphics and Text6x4x267x267x3@5:1 1.55 - Image of 6 inches x 4 inches @ 267 ppi and 3800x800x73 @ 10:1 colors 2 - Remaining area text -73 inches , 800 dpi Best Case Photo, 3 Colors, 6.6 MegaPixel Image 6.6 Mpixel @ 10:1 2.00 If a document with more complex pages is required, the page RIP software in the host PC can determine that there is insufficient memory storage in the SoPEC for that document. In such cases the RIP software can take two courses of action. It can increase the compression ratio until the 5 compressed page size will fit in the SoPEC device, at the expense of document quality, or divide the page into bands and allow SoPEC to begin printing a page band before all bands for that page are downloaded. Once SoPEC starts printing a page it cannot stop, if SoPEC consumes compressed data faster than the bands can be downloaded a buffer underrun error could occur causing the print to fail. A buffer underrun occurs if a line synchronisation pulse is received before a 10 line of data has been transferred to the printhead. Other options which can be considered if the page does not fit completely into the compressed page store are to slow the printing or to use multiple SoPECs to print parts of the page. A Storage SoPEC ( Section 7.2.5) could be added to the system to provide guaranteed bandwidth data delivery. The print system could also be constructed using an ISI-Bridge chip (Section 7.2.6) to 15 provide guaranteed data delivery. 7 Memjet Printer Architecture The SoPEC device can be used in several printer configurations and architectures. In the general sense every SoPEC based printer architecture will contain: * One or more SoPEC devices. 20 * One or more bi-lithic printheads. * Two or more LSS busses. * Two or more QA chips. * USB 1.1 connection to host or ISI connection to Bridge Chip. * ISI bus connection between SoPECs (when multiple SoPECs are used). 25 Some example printer configurations as outlined in Section 7.2. The various system components are outlined briefly in Section 7.1. 7.1 SYSTEM COMPONENTS 7.1.1 SoPEC Print Engine Controller The SoPEC device contains several system on a chip (SoC) components, as well as the print 30 engine pipeline control application specific logic.
WO 2004/050369 PCT/AU2003/001616 55 7.1.1.1 Print Engine Pipeline (PEP) Logic The PEP reads compressed page store data from the embedded memory, optionally decompresses the data and formats it for sending to the printhead. The print engine pipeline functionality includes expanding the page image, dithering the contone layer, compositing the black layer over the 5 contone layer, rendering of Netpage tags, compensation for dead nozzles in the printhead, and sending the resultant image to the bi-lithic printhead. 7.1.1.2 Embedded CPU SoPEC contains an embedded CPU for general purpose system configuration and management. The CPU performs page and band header processing, motor control and sensor monitoring (via the 10 GPIO) and other system control functions. The CPU can perform buffer management or report buffer status to the host. The CPU can optionally run vendor application specific code for general print control such as paper ready monitoring and LED status update. 7.1.1.3 Embedded Memory Buffer A 2.5Mbyte embedded memory buffer is integrated onto the SoPEC device, of which approximately 15 2Mbytes are available for compressed page store data. A compressed page is divided into one or more bands, with a number of bands stored in memory. As a band of the page is consumed by the PEP for printing a new band can be downloaded. The new band may be for the current page or the next page. Using banding it is possible to begin printing a page before the complete compressed page is 20 downloaded, but care must be taken to ensure that data is always available for printing or a buffer underrun may occur. An Storage SoPEC acting as a memory buffer (Section 7.2.5) or an ISI-Bridge chip with attached DRAM (Section 7.2.6) could be used to provide guaranteed data delivery. 7.1.1.4 Embedded USB 1.1 Device 25 The embedded USB 1.1 device accepts compressed page data and control commands from the host PC, and facilitates the data transfer to either embedded memory or to another SoPEC device in multi-SoPEC systems. 7.1.2 Bi-lithic Printhead The printhead is constructed by abutting 2 printhead ICs together. The printhead ICs can vary in 30 size from 2 inches to 8 inches, so to produce an A4 printhead several combinations are possible. For example two printhead ICs of 7 inches and 3 inches could be used to create a A4 printhead (the notation is 7:3). Similarly 6 and 4 combination (6:4), or 5:5 combination. For an A3 printhead it can be constructed from 8:6 or an 7:7 printhead IC combination. For photographic printing smaller printheads can be constructed. 35 7.1.3 LSS interface bus Each SoPEC device has 2 LSS system buses for communication with QA devices for system authentication and ink usage accounting. The number of QA devices per bus and their position in the system is unrestricted with the exception that PRINTERQA and INKQA devices should be on separate LSS busses. 40 7.1.4 QA devices WO 2004/050369 PCT/AU2003/001616 56 Each SoPEC system can have several QA devices. Normally each printing SoPEC will have an associated PRINTERQA. Ink cartridges will contain an INKQA chip. PRINTERQA and INKQA devices should be on separate LSS busses. All QA chips in the system are physically identical with flash memory contents defining PRINTERQA from INKQA chip. 5 7.1.5 ISI interface The Inter-SoPEC Interface (ISI) provides a communication channel between SoPECs in a multi SoPEC system. The ISIMaster can be SoPEC device or an ISI-Bridge chip depending on the printer configuration. Both compressed data and control commands are transferred via the interface. 7.1.6 ISI-Bridge Chip 10 A device, other than a SoPEC with a USB connection, which provides print data to a number of slave SoPECs. A bridge chip will typically have a high bandwidth connection, such as USB2.0, Ethernet or IEEE1394, to a host and may have an attached external DRAM for compressed page storage. A bridge chip would have one or more 1SI interfaces. The use of multiple ISI buses would allow the construction of independent print systems within the one printer. The ISI-Bridge would be 15 the ISIMaster for each of the ISI buses it interfaces to. 7.2 POSSIBLE SOPEC SYSTEMS Several possible SoPEC based system architectures exist. The following sections outline some possible architectures. It is possible to have extra SoPEC devices in the system used for DRAM storage. The QA chip configurations shown are indicative of the flexibility of LSS bus architecture, 20 but not limited to those configurations. 7.2.1 A4 Simplex with 1 SoPEC device In Figure 3, a single SoPEC device can be used to control two printhead ICs. The SoPEC receives compressed data through the USB device from the host. The compressed data is processed and 25 transferred to the printhead. 7.2.2 A4 Duplex with 2 SoPEC devices In Figure 4, two SoPEC devices are used to control two bi-lithic printheads, each with two printhead ICs. Each bi-lithic printhead prints to opposite sides of the same page to achieve duplex printing. The SoPEC connected to the USB is the ISIMaster SoPEC, the remaining SoPEC is an ISISlave. 30 The ISIMaster receives all the compressed page data for both SoPECs and re-distributes the compressed data over the Inter-SoPEC Interface (ISI) bus. It may not be possible to print an A4 page every 2 seconds in this configuration since the USB 1.1 connection to the host may not have enough bandwidth. An alternative would be for each SoPEC to have its own USB 1.1 connection. This would allow a faster average print speed. 35 7.2.3 A3 Simplex with 2 SoPEC devices In Figure 5, two SoPEC devices are used to control one A3 bi-lithic printhead. Each SoPEC controls only one printhead IC (the remaining PHI port typically remains idle). This system uses the SoPEC with the USB connection as the ISiMaster. In this dual SoPEC configuration the compressed page 40 store data is split across 2 SoPECs giving a total of 4Mbyte page store, this allows the system to WO 2004/050369 PCT/AU2003/001616 57 use compression rates as in an A4 architecture, but with the increased page size of A3. The ISIMaster receives all the compressed page data for all SoPECs and re-distributes the compressed data over the Inter-SoPEC Interface (ISI) bus. It may not be possible to print an A3 page every 2 seconds in this configuration since the USB 1.1 5 connection to the host will only have enough bandwidth to supply 2Mbytes every 2 seconds. Pages which require more than 2MBytes every 2 seconds will therefore print more slowly. An alternative would be for each SoPEC to have its own USB 1.1 connection. This would allow a faster average print speed. 7.2.4 A3 Duplex with 4 SoPEC devices 10 In Figure 6 a 4 SoPEC system is shown. It contains 2 A3 bi-lithic printheads, one for each side of an A3 page. Each printhead contain 2 printhead ICs, each printhead IC is controlled by an independent SoPEC device, with the remaining PHI port typically unused. Again the SoPEC with USB 1.1 connection is the ISIMaster with the other SoPECs as ISISlaves. In total, the system contains 8Mbytes of compressed page store (2Mbytes per SoPEC), so the increased page size does not 15 degrade the system print quality, from that of an A4 simplex printer. The ISIMaster receives all the compressed page data for all SoPECs and re-distributes the compressed data over the Inter SoPEC Interface (ISI) bus. It may not be possible to print an A3 page every 2 seconds in this configuration since the USB 1.1 connection to the host will only have enough bandwidth to supply 2Mbytes every 2 seconds. Pages 20 which require more than 2MBytes every 2 seconds will therefore print more slowly. An alternative would be for each SoPEC or set of SoPECs on the same side of the page to have their own USB 1.1 connection (as ISISlaves may also have direct USB connections to the host). This would allow a faster average print speed. 7.2.5 SoPEC DRAM storage solution: A4 Simplex with I printing SoPEC and 1 memory SoPEC 25 Extra SoPECs can be used for DRAM storage e.g. in Figure 7 an A4 simplex printer can be built with a single extra SoPEC used for DRAM storage. The DRAM SoPEC can provide guaranteed bandwidth delivery of data to the printing SoPEC. SoPEC configurations can have multiple extra SoPECs used for DRAM storage. 7.2.6 ISI-Bridge chip solution: A3 Duplex system with 4 SoPEC devices 30 In Figure 8, an ISI-Bridge chip provides slave-only ISI connections to SoPEC devices. Figure 8 shows a ISI-Bridge chip with 2 separate ISI ports. The ISI-Bridge chip is the ISIMaster on each of the ISI busses it is connected to. All connected SoPECs are ISISlaves. The ISI-Bridge chip will typically have a high bandwidth connection to a host and may have an attached external DRAM for compressed page storage. 35 An alternative to having a ISI-Bridge chip would be for each SoPEC or each set of SoPECs on the same side of a page to have their own USB 1.1 connection. This would allow a faster average print speed. 8 Page Format and Printflow When rendering a page, the RIP produces a page header and a number of bands (a non-blank 40 page requires at least one band) for a page. The page header contains high level rendering WO 2004/050369 PCT/AU2003/001616 58 parameters, and each band contains compressed page data. The size of the band will depend on the memory available to the RIP, the speed of the RIP, and the amount of memory remaining in SoPEC while printing the previous band(s). Figure 9 shows the high level data structure of a number of pages with different numbers of bands in the page. 5 Each compressed band contains a mandatory band header, an optional bi-level plane, optional sets of interleaved contone planes, and an optional tag data plane (for Netpage enabled applications). Since each of these planes is optional', the band header specifies which planes are included with the band. Figure 10 gives a high-level breakdown of the contents of a page band. 10 A single SoPEC has maximum rendering restrictions as follows: * 1 bi-level plane e 1 contone interleaved plane set containing a maximum of 4 contone planes * 1 tag data plane * a bi-lithic printhead with a maximum of 2 printhead lCs 15 The requirement for single-sided A4 single SoPEC printing is * average contone JPEG compression ratio of 10:1, with a local minimum compression ratio of 5:1 for a single line of interleaved JPEG blocks. " average bi-level compression ratio of 10:1, with a local minimum compression ratio of 1:1 for a single line. 20 If the page contains rendering parameters that exceed these specifications, then the RIP or the Host PC must split the page into a format that can be handled by a single SoPEC. In the general case, the SoPEC CPU must analyze the page and band headers and generate an appropriate set of register write commands to configure the units in SoPEC for that page. The various bands are passed to the destination SoPEC(s) to locations in DRAM determined by the 25 host. The host keeps a memory map for the DRAM, and ensures that as a band is passed to a SoPEC, it is stored in a suitable free area in DRAM. Each SoPEC is connected to the IS[ bus or USB bus via its Serial communication Block (SCB). The SoPEC CPU configures the SCB to allow compressed data bands to pass from the USB or ISI through the SCB to SoPEC DRAM. Figure 11 shows an 30 example data flow for a page destined to be printed by a single SoPEC. Band usage information is generated by the individual SoPECs and passed back to the host. SoPEC has an addressing mechanism that permits circular band memory allocation, thus facilitating easy memory management. However it is not strictly necessary that all bands be stored together. 35 As long as the appropriate registers in SoPEC are set up for each band, and a given band is contiguous 2 , the memory can be allocated in any way. 'Although a band must contain at least one plane 2Contiguous allocation also includes wrapping around in SoPEC's band store memory.
WO 2004/050369 PCT/AU2003/001616 59 8.1 PRINT ENGINE EXAMPLE PAGE FORMAT This section describes a possible format of compressed pages expected by the embedded CPU in SoPEC. The format is generated by software in the host PC and interpreted by embedded software in SoPEC. This section indicates the type of information in a page format structure, but 5 implementations need not be limited to this format. The host PC can optionally perform the majority of the header processing. The compressed format and the print engines are designed to allow real-time page expansion during printing, to ensure that printing is never interrupted in the middle of a page due to data underrun. 10 The page format described here is for a single black bi-level layer, a contone layer, and a Netpage tag layer. The black bi-level layer is defined to composite over the contone layer. The black bi-level layer consists of a bitmap containing a 1-bit opacity for each pixel. This black layer matte has a resolution which is an integer or non-integer factor of the printer's dot resolution. The highest supported resolution is 1600 dpi, i.e. the printer's full dot resolution. 15 The contone layer, optionally passed in as YCrCb, consists of a 24-bit CMY or 32-bit CMYK co/or for each pixel. This contone image has a resolution which is an integer or non-integer factor of the printer's dot resolution. The requirement for a single SoPEC is to support 1 side per 2 seconds A4/Letter printing at a resolution of 267 ppi, i.e. one-sixth the printer's dot resolution. Non-integer scaling can be performed on both the contone and bi-level images. Only integer 20 scaling can be performed on the tag data. The black bi-level layer and the contone layer are both in compressed form for efficient storage in the printer's internal memory. 8.1.1 Page structure A single SoPEC is able to print with full edge bleed for Letter and A3 via different stitch part 25 combinations of the bi-lithic printhead. It imposes no margins and so has a printable page area which corresponds to the size of its paper. The target page size is constrained by the printable page area, less the explicit (target) left and top margins specified in the page description. These relationships are illustrated below. 8.1.2 Compressed page format 30 Apart from being implicitly defined in relation to the printable page area, each page description is complete and self-contained. There is no data stored separately from the page description to which the page description refers.
3 The page description consists of a page header which describes the size and resolution of the page, followed by one or more page bands which describe the actual page content. 8.1.2.1 Page header 35 Table 3 shows an example format of a page header. 3 SoPEC relies on dither matrices and tag structures to have already been set up, but these are not considered to be part of a general page format. It is trivial to extend the page format to allow exact specification of dither matrices and tag structures.
WO 2004/050369 PCT/AU2003/001616 60 Table 3. Page header format field format description signature 16-bit integer Page header format signature. version 16-bit integer Page header format version number. structure size 16-bit integer Size of page header. band count 16-bit integer Number of bands specified for this page. target resolution (dpi) 16-bit integer Resolution of target page. This is always 1600 for the Memjet printer. target page width 16-bit integer Width of target page, in dots. target page height 32-bit integer Height of target page, in dots. target left margin for black and 16-bit integer Width of target left margin, in dots, for black contone and contone. target top margin for black and 16-bit integer Height of target top margin, in dots, for black contone and contone. target right margin for black and 16-bit integer Width of target right margin, in dots, for black contone and contone. target bottom margin for black 16-bit integer Height of target bottom margin, in dots, for and contone black and contone. target left margin for tags 16-bit integer Width of target left margin, in dots, for tags. target top margin for tags 16-bit integer Height of target top margin, in dots, for tags. target right margin for tags 16-bit integer Width of target right margin, in dots, for tags. target bottom margin for tags 16-bit integer Height of target bottom margin, in dots, for tags. generate tags 16-bit integer Specifies whether to generate tags for this page (0 - no, 1 - yes). fixed tag data 128-bit integer This is only valid if generate tags is set. tag vertical scale factor 16-bit integer Scale factor in vertical direction from tag data resolution to target resolution. Valid range 1-511. Integer scaling only tag horizontal scale factor 16-bit integer Scale factor in horizontal direction from tag data resolution to target resolution. Valid range = 1-511. Integer scaling only. bi-level layer vertical scale factor 16-bit integer Scale factor in vertical direction from bi-level resolution to target resolution (must be 1 or greater). May be non-integer. Expressed as a fraction with upper 8-bits the numerator and the lower 8 bits the denominator.
WO 2004/050369 PCT/AU2003/001616 61 bi-level layer horizontal scale fac-16-bit integer Scale factor in horizontal direction from bi tor level resolution to target resolution (must be 1 or greater). May be non-integer. Expressed as a fraction with upper 8-bits the numerator and the lower 8 bits the denominator. bi-level layer page width 16-bit integer Width of bi-level layer page, in pixels. bi-level layer page height 32-bit integer Height of bi-level layer page, in pixels. contone flags 16 bit integer Defines the color conversion that is required or the JPEG data. Bits 2-0 specify how many contone planes there are (e.g. 3 for CMY and 4 for CMYK). Bit 3 specifies whether the first 3 color planes need to be converted back from YCrCb to CMY. Only valid if b2-0 = 3 or 4. 0 - no conversion, leave JPEG colors alone 1 - color convert. Bits 7-4 specifies whether the YCrCb was generated directly from CMY, or whether it was converted to RGB first via the step: R = 255-C, G = 255-M, B = 255-Y. Each of the color planes can be individually inverted. Bit 4: 0 - do not invert color plane 0 1 - invert color plane 0 Bit 5: 0 - do not invert color plane I 1 - invert color plane 1 Bit 6: 0 - do not invert color plane 2 1 - invert color plane 2 Bit 7: 0 - do not invert color plane 3 1 - invert color plane 3 Bit 8 specifies whether the contone data is JPEG compressed or non-compressed: 0 - JPEG compressed 1 - non-compressed The remaining bits are reserved (0). contone vertical scale factor 16-bit integer Scale factor in vertical direction from contone channel resolution to target resolution. Valid WO 2004/050369 PCT/AU2003/001616 62 range = 1-255. May be non-integer. Expressed as a fraction with upper 8-bits the numerator and the lower 8 bits the denominator. contone horizontal scale factor 16-bit integer Scale factor in horizontal direction from contone channel resolution to target resolution. Valid range = 1-255. May be non integer. Expressed as a fraction with upper 8-bits the numerator and the lower 8 bits the denominator. contone page width 16-bit integer Width of contone page, in contone pixels. contone page height 32-bit integer Height of contone page, in contone pixels. reserved up to 128 bytes Reserved and 0 pads out page header to multiple of 128 bytes. The page header contains a signature and version which allow the CPU to identify the page header format. If the signature and/or version are missing or incompatible with the CPU, then the CPU can 5 reject the page. The contone flags define how many contone layers are present, which typically is used for defining whether the contone layer is CMY or CMYK. Additionally, if the color planes are CMY, they can be optionally stored as YCrCb, and further optionally color space converted from CMY directly or via RGB. Finally the contone data is specified as being either JPEG compressed or non-compressed. 10 The page header defines the resolution and size of the target page. The bi-level and contone layers are clipped to the target page if necessary. This happens whenever the bi-level or contone scale factors are not factors of the target page width or height. The target left, top, right and bottom margins define the positioning of the target page within the printable page area. 15 The tag parameters specify whether or not Netpage tags should be produced for this page and what orientation the tags should be produced at (landscape or portrait mode). The fixed tag data is also provided. The contone, bi-level and tag layer parameters define the page size and the scale factors. 8.1.2.2 Band format 20 Table 4 shows the format of the page band header. Table 4. Band header format field format description signature 16-bit integer Page band header format signature.
WO 2004/050369 PCT/AU2003/001616 63 version 16-bit integer Page band header format version number. structure size 16-bit integer Size of page band header. bi-level layer band height 16-bit integer Height of bi-level layer band, in black pixels. bi-level layer band data size 32-bit integer Size of bi-level layer band data, in bytes. contone band height 16-bit integer Height of contone band, in contone pixels. contone band data size 32-bit integer Size of contone plane band data, in bytes. tag band height 16-bit integer Height of tag band, in dots. tag band data size 32-bit integer Size of unencoded tag data band, in bytes. Can be 0 which indicates that no tag data is provided. reserved up to 128 bytes Reserved and 0 pads out band header to multiple of 128 bytes. The bi-level layer parameters define the height of the black band, and the size of its compressed band data. The variable-size black data follows the page band header. The contone layer parameters define the height of the contone band, and the size of its compressed page data. The variable-size contone data follows the black data. 5 The tag band data is the set of variable tag data half-lines as required by the tag encoder. The format of the tag data is found in Section 26.5.2. The tag band data follows the contone data. Table 5 shows the format of the variable-size compressed band data which follows the page band header. Table 5. Page band data format field format Description black data Modified G4 facsimile bitstream 4 Compressed bi-level layer. contone data JPEG bytestream Compressed contone datalayer. tag data map Tag data array Tag data format. See Section 26.5.2. 10 The start of each variable-size segment of band data should be aligned to a 256-bit DRAM word boundary. The following sections describe the format of the compressed bi-level layers and the compressed contone layer. section 26.5.1 on page 442 describes the format of the tag data structures. 8.1.2.3 Bi-level data compression 15 The (typically 1600 dpi) black bi-level layer is losslessly compressed using Silverbrook Modified Group 4 (SMG4) compression which is a version of Group 4 Facsimile compression [22] without Huffman and with simplified run length encodings. Typically compression ratios exceed 10:1. The encoding are listed in Table 6 and Table 7. Table 6. Bi-Level group 4 facsimile style compression encodings 20 Encoding Description same as Group 41000 Pass Command: aO <- b2, skip next two edges 4 See section 8.1.2.3 on page 63 for note regarding the use of this standard WO 2004/050369 PCT/AU2003/001616 64 Facsimile 1 Vertical(0): aO +- b1, color = !color 110 Vertical(1): aO +- bI + 1, color = !color 010 Vertical(-1): aO <- b1 - 1, color = !color 110000 Vertical(2): aO +- b1 + 2, color =!color 010000 Vertical(-2): aO <- bI - 2, color = !color Unique to this 100000 Vertical(3): a0 <- b1 + 3, color = !color implementation 000000 ertical(-3): aO +- b1 - 3, color = !color <RL><RL>100 Horizontal: aO +- aO + <RL> + <RL> SMG4 has a pass through mode to cope with local negative compression. Pass through mode is activated by a special run-length code. Pass through mode continues to either end of line or for a pre-programmed number of bits, whichever is shorter. The special run-length code is always executed as a run-length code, followed by pass through. The pass through escape code is a 5 medium length run-length with a run of less than or equal to 31. Table 7. Run length (RL) encodings Encoding Description Unique to this RRRRR1 Short Black Runlength (5 bits) implementation RRRRR1 Short White Runlength (5 bits) RRRRRRRRRRIO Medium Black Runlength (10 bits) RRRRRRRR10 Medium White Runlength (8 bits) RRRRRRRRRR10 Medium Black Runlength with RRRRRRRRRR <= 31, Enter pass through RRRRRRRRI0 Medium White Runlength with RRRRRRRR <= 31, Enter pass through RRRRRRRRRRRRRRROO Long Black Runlength (15 bits) iRRRRRRRRRRRRRRR00 Long White Runlength (15 bits) Since the compression is a bitstream, the encodings are read right (least significant bit) to left (most significant bit). The run lengths given as RRRR in Table are read in the same way (least 10 significant bit at the right to most significant bit at the left). Each band of bi-level data is optionally self contained. The first line of each band therefore is based on a 'previous' blank line or the last line of the previous band. 8.1.2.3.1 Group 3 and 4 facsimile compression The Group 3 Facsimile compression algorithm [22] losslessly compresses bi-level data for 15 transmission over slow and noisy telephone lines. The bi-level data represents scanned black text and graphics on a white background, and the algorithm is tuned for this class of images (it is explicitly not tuned, for example, for ha/ftoned bi-level images). The ID Group 3 algorithm WO 2004/050369 PCT/AU2003/001616 65 runlength-encodes each scanline and then Huffman-encodes the resulting runlengths. Runlengths in the range 0 to 63 are coded with terminating codes. Runlengths in the range 64 to 2623 are coded with rhake-up codes, each representing a multiple of 64, followed by a terminating code. Runlengths exceeding 2623 are coded with multiple make-up codes followed by a terminating code. 5 The Huffman tables are fixed, but are separately tuned for black and white runs (except for make-up codes above 1728, which are common). When possible, the 2D Group 3 algorithm encodes a scanline as a set of short edge deltas (0, ±1, ±2, +3) with reference to the previous scanline. The delta symbols are entropy-encoded (so that the zero delta symbol is only one bit long etc.) Edges within a 2D-encoded line which can't be delta-encoded are runlength-encoded, and are identified by 10 a prefix. 1 D- and 2D-encoded lines are marked differently. I D-encoded lines are generated at regular intervals, whether actually required or not, to ensure that the decoder can recover from line noise with minimal image degradation. 2D Group 3 achieves compression ratios of up to 6:1 [32]. The Group 4 Facsimile algorithm [22] losslessly compresses bi-level data for transmission over error-free communications lines (i.e. the lines are truly error-free, or error-correction is done at a 15 lower protocol level). The Group 4 algorithm is based on the 2D Group 3 algorithm, with the essential modification that since transmission is assumed to be error-free, 1D-encoded lines are no longer generated at regular intervals as an aid to error-recovery. Group 4 achieves compression ratios ranging from 20:1 to 60:1 for the CCITT set of test images [32]. The design goals and performance of the Group 4 compression algorithm qualify it as a 20 compression algorithm for the bi-level layers. However, its Huffman tables are tuned to a lower scanning resolution (100-400 dpi), and it encodes runlengths exceeding 2623 awkwardly. 8.1.2.4 Contone data compression The contone layer (CMYK) is either a non-compressed bytestream or is compressed to an interleaved JPEG bytestream. The JPEG bytestream is complete and self-contained. It contains all 25 data required for decompression, including quantization and Huffman tables. The contone data is optionally converted to YCrCb before being compressed (there is no specific advantage in color-space converting if not compressing). Additionally, the CMY contone pixels are optionally converted (on an individual basis) to RGB before color conversion using R=255-C, G=255-M, B=255-Y. Optional bitwise inversion of the K plane may also be performed. Note that this 30 CMY to RGB conversion is not intended to be accurate for display purposes, but rather for the purposes of later converting to YCrCb. The inverse transform will be applied before printing. 8.1.2.4.1 JPEG compression The JPEG compression algorithm [27] lossily compresses a contone image at a specified quality level. It introduces imperceptible image degradation at compression ratios below 5:1, and negligible 35 image degradation at compression ratios below 10:1 [33]. JPEG typically first transforms the image into a color space which separates luminance and chrominance into separate color channels. This allows the chrominance channels to be subsampled without appreciable loss because of the human visual system's relatively greater sensitivity to luminance than chrominance. After this first step, each color channel is compressed separately.
WO 2004/050369 PCT/AU2003/001616 66 The image is divided into 8x8 pixel blocks. Each block is then transformed into the frequency domain via a discrete cosine transform (DCT). This transformation has the effect of concentrating image energy in relatively lower-frequency coefficients, which allows higher-frequency coefficients to be more crudely quantized. This quantization is the principal source of compression in JPEG. 5 Further compression is achieved by ordering coefficients by frequency to maximize the likelihood of adjacent zero coefficients, and then runlength-encoding runs of zeroes. Finally, the runlengths and non-zero frequency coefficients are entropy coded. Decompression is the inverse process of compression. 8.1.2.4.2 Non-compressed format 10 If the contone data is non-compressed, it must be in a block-based format bytestream with the same pixel order as would be produced by a JPEG decoder. The bytestream therefore consists of a series of 8x8 block of the original image, starting with the top left 8x8 block, and working horizontally across the page (as it will be printed) until the top rightmost 8x8 block, then the next row of 8x8 blocks (left to right) and so on until the lower row of 8x8 blocks (left to right). Each 8x8 15 block consists of 64 8-bit pixels for color plane 0 (representing 8 rows of 8 pixels in the order top left to bottom right) followed by 64 8-bit pixels for color plane 1 and so on for up to a maximum of 4 color planes. If the original image is not a multiple of 8 pixels in X or Y, padding must be present (the extra pixel data will be ignored by the setting of margins). 20 8.1.2.4.3 Compressed format If the contone data is compressed the first memory band contains JPEG headers (including tables) plus MCUs (minimum coded units). The ratio of space between the various color planes in the JPEG stream is 1:1:1:1. No subsampling is permitted. Banding can be completely arbitrary i.e there can be multiple JPEG images per band or 1 JPEG image divided over multiple bands. The break 25 between bands is only memory alignment based. 8.1.2.4.4 Conversion of RGB to YCrCb (in RIP) YCrCb is defined as per CCIR 601-1 [24] except that Y, Cr and Cb are normalized to occupy all 256 levels of an 8-bit binary encoding and take account of the actual hardware implementation of the inverse transform within SoPEC. 30 The exact color conversion computation is as follows: * Y* = (9805/32768)R + (1 9235/32768)G + (3728/32768)B * Cr* = (16375/32768)R - (13716/32768)G - (2659/32768)B + 128 * Cb* = -(5529/32768)R - (10846/32768)G + (16375/32768)B + 128 Y, Cr and Cb are obtained by rounding to the nearest integer. There is no need for saturation since 35 ranges of Y*, Cr* and Cb* after rounding are [0-255], [1-255] and [1-255] respectively. Note that full accuracy is possible with 24 bits. See [14] for more information. SoPEC ASIC 9 Overview The Small Office Home Office Print Engine Controller (SoPEC) is a page rendering engine ASIC 40 that takes compressed page images as input, and produces decompressed page images at up to 6 WO 2004/050369 PCT/AU2003/001616 67 channels of bi-level dot data as output. The bi-level dot data is generated for the Memjet bi-lithic printhead. The dot generation process takes account of printhead construction, dead nozzles, and allows for fixative generation. A single SoPEC can control 2 bi-lithic printheads and up to 6 color channels at 10,000 lines/sec 5 , 5 equating to 30 pages per minute. A single SoPEC can perform full-bleed printing of A3, A4 and Letter pages. The 6 channels of colored ink are the expected maximum in a consumer SOHO, or office Bi-lithic printing environment: - CMY, for regular color printing. - K, for black text, line graphics and gray-scale printing. 10 - IR (infrared), for Netpage-enabled [5] applications. - F (fixative), to enable printing at high speed. Because the bi-lithic printer is capable of printing so fast, a fixative may be required to enable the ink to dry before the page touches the page already printed. Otherwise the pages may bleed on each other. In low speed printing environments the fixative may not be required. 15 SoPEC is color space agnostic. Although it can accept contone data as CMYX or RGBX, where X is an optional 4th channel, it also can accept contone data in any print color space. Additionally, SoPEC provides a mechanism for arbitrary mapping of input channels to output channels, including combining dots for ink optimization, generation of channels based on any number of other channels etc. However, inputs are typically CMYK for contone input, K for the bi-level input, and the optional 20 Netpage tag dots are typically rendered to an infra-red layer. A fixative channel is typically generated for fast printing applications. SoPEC is resolution agnostic. It merely provides a mapping between input resolutions and output resolutions by means of scale factors. The expected output resolution is 1600 dpi, but SoPEC actually has no knowledge of the physical resolution of the Bi-lithic printhead. 25 SoPEC is page-length agnostic. Successive pages are typically split into bands and downloaded into the page store as each band of information is consumed and becomes free. SoPEC provides an interface for synchronization with other SoPECs. This allows simple multi SoPEC solutions for simultaneous A3/A4/Letter duplex printing. However, SoPEC is also capable of printing only a portion of a page image. Combining synchronization functionality with partial page 30 rendering allows multiple SoPECs to be readily combined for alternative printing requirements including simultaneous duplex printing and wide format printing. Table 8 lists some of the features and corresponding benefits of SoPEC. Table 8. Features and Benefits of SoPEC Feature Benefits Optimised print architecture in 30ppm full page photographic quality color printing from a hardware desktop PC 510,000 lines per second equates to 30 A4/Letter pages per minute at 1600 dpi WO 2004/050369 PCT/AU2003/001616 68 0.1 3micron CMOS High speed (>3 million transistors) Low cost High functionality 900 Million dots per second Extremely fast page generation 10,000 lines per second at 1600 0.5 A4/Letter pages per SoPEC chip per second dpi 1 chip drives up to 133,920 Low cost page-width printers nozzles 1 chip drives up to 6 color planes 99% of SoHo printers can use I SoPEC device Integrated DRAM No external memory required, leading to low cost systems Power saving sleep mode SoPEC can enter a power saving sleep mode to reduce power dissipation between print jobs JPEG expansion Low bandwidth from PC Low memory requirements in printer Lossless bitplane expansion High resolution text and line art with low bandwidth from PC (e.g. over USB) Netpage tag expansion Generates interactive paper Stochastic dispersed dot dither Optically smooth image quality No moire effects Hardware compositor for 6 image Pages composited in real-time planes Dead nozzle compensation Extends printhead life and yield Reduces printhead cost Color space agnostic Compatible with all inksets and image sources including RGB, CMYK, spot, CIE L*a*b*, hexachrome, YCrCbK, sRGB and other Color space conversion Higher quality / lower bandwidth Computer interface USB1.1 interface to host and ISI interface to ISI-Bridge chip thereby allowing connection to IEEE 1394, Bluetooth etc. Cascadable in resolution Printers of any resolution Cascadable in color depth Special color sets e.g. hexachrome can be used Cascadable in image size Printers of any width up to 16 inches Cascadable in pages Printers can print both sides simultaneously Cascadable in speed Higher speeds are possible by having each SoPEC print one vertical strip of the page. Fixative channel data generation Extremely fast ink drying without wastage Built-in security Revenue models are protected Undercolor removal on dot-by-dot Reduced ink usage basis WO 2004/050369 PCT/AU2003/001616 69 Does not require fonts for high No font substitution or missing fonts speed operation Flexible printhead configuration Many configurations of printheads are supported by one chip type Drives Bi-lithic printheads directly No print driver chips required, results in lower cost Determines dot accurate ink usage Removes need for physical ink monitoring system in ink cartridges 9.1 PRINTING RATES The required printing rate for SoPEC is 30 sheets per minute with an inter-sheet spacing of 4 cm. To achieve a 30 sheets per minute print rate, this requires: 5 300mm x 63 (dot/mm) / 2 sec = 105.8 seconds per line, with no inter-sheet gap. 340mm x 63 (dot/mm) /2 sec = 93.3 seconds per line, with a 4 cm inter-sheet gap. A printline for an A4 page consists of 13824 nozzles across the page [2]. At a system clock rate of 160 MHz 13824 dots of data can be generated in 86.4 seconds. Therefore data can be generated fast enough to meet the printing speed requirement. It is necessary to deliver this print data to the 10 print-heads. Printheads can be made up of 5:5, 6:4, 7:3 and 8:2 inch printhead combinations [2]. Print data is transferred to both print heads in a pair simultaneously. This means the longest time to print a line is determined by the time to transfer print data to the longest print segment. There are 9744 nozzles across a 7 inch printhead. The print data is transferred to the printhead at a rate of 106 MHz (2/3 of 15 the system clock rate) per color plane. This means that it will take 91.9 us to transfer a single line for a 7:3 printhead configuration. So we can meet the requirement of 30 sheets per minute printing with a 4 cm gap with a 7:3 printhead combination. There are 11160 across an 8 inch printhead. To transfer the data to the printhead at 106 MHz will take 105.3 ps. So an 8:2 printhead combination printing with an inter-sheet gap will print slower than 30 sheets per minute. 20 9.2 SoPEC BASIC ARCHITECTURE From the highest point of view the SoPEC device consists of 3 distinct subsystems - CPU Subsystem - DRAM Subsystem - Print Engine Pipeline (PEP) Subsystem 25 See Figure 13 for a block level diagram of SoPEC. 9.2.1 CPU Subsystem The CPU subsystem controls and configures all aspects of the other subsystems. It provides general support for interfacing and synchronising the external printer with the internal print engine. It also controls the low speed communication to the QA chips. The CPU subsystem contains various 30 peripherals to aid the CPU, such as GPIO (includes motor control), interrupt controller, LSS Master and general timers. The Serial Communications Block (SCB) on the CPU subsystem provides a full speed USB1.1 interface to the host as well as an Inter SoPEC Interface (ISI) to other SoPEC devices. 9.2.2 DRAM Subsystem WO 2004/050369 PCT/AU2003/001616 70 The DRAM subsystem accepts requests from the CPU, Serial Communications Block (SCB) and blocks within the PEP subsystem. The DRAM subsystem (in particular the DIU) arbitrates the various requests and determines which request should win access to the DRAM. The DIU arbitrates based on configured parameters, to allow sufficient access to DRAM for all requestors. The DIU 5 also hides the implementation specifics of the DRAM such as page size, number of banks, refresh rates etc. 9.2.3 Print Engine Pipeline (PEP) subsystem The Print Engine Pipeline (PEP) subsystem accepts compressed pages from DRAM and renders them to bi-level dots for a given print line destined for a printhead interface that communicates 10 directly with up to 2 segments of a bi-lithic printhead. The first stage of the page expansion pipeline is the CDU, LBD and TE. The CDU expands the JPEG-compressed contone (typically CMYK) layer, the LBD expands the compressed bi-level layer (typically K), and the TE encodes Netpage tags for later rendering (typically in IR or K ink). The output from the first stage is a set of buffers: the CFU, SFU, and TFU. The CFU and SFU buffers 15 are implemented in DRAM. The second stage is the HCU, which dithers the contone layer, and composites position tags and the bi-level spotO layer over the resulting bi-level dithered layer. A number of options exist for the way in which compositing occurs. Up to 6 channels of bi-level data are produced from this stage. Note that not all 6 channels may be present on the printhead. For example, the printhead may be 20 CMY only, with K pushed into the CMY channels and IR ignored. Alternatively, the position tags may be printed in K if IR ink is not available (or for testing purposes). The third stage (DNC) compensates for dead nozzles in the printhead by color redundancy and error diffusing dead nozzle data into surrounding dots. The resultant bi-level 6 channel dot-data (typically CMYK-IRF) is buffered and written out to a set of 25 line buffers stored in DRAM via the DWU. Finally, the dot-data is loaded back from DRAM, and passed to the printhead interface via a dot FIFO. The dot FIFO accepts data from the LLU at the system clock rate (pclk), while the PHI removes data from the FIFO and sends it to the printhead at a rate of 2/3 times the system clock rate (see Section 9.1). 30 9.3 SoPEC BLOCK DESCRIPTION Looking at Figure 13, the various units are described here in summary form: Table 9. Units within SoPEC Subsystem Unit Unit Name Description Acronym DRAM DIU DRAM interface unit Provides the interface for DRAM read and write access for the various SoPEC units, CPU and the SCB block. The DIU provides arbitration between competing units controls DRAM WO 2004/050369 PCT/AU2003/001616 71 access. DRAM Embedded DRAM 20Mbits of embedded DRAM, CPU CPU Central Processing CPU for system configuration and control Unit MMU Memory Management Limits access to certain memory address areas Unit in CPU user mode RDU Real-time Debug Unit Facilitates the observation of the contents of most of the CPU addressable registers in SoPEC in addition to some pseudo-registers in realtime. TIM General Timer Contains watchdog and general system timers LSS Low Speed Serial Low level controller for interfacing with the QA Interfaces chips GPIO General Purpose 10s General 10 controller, with built-in Motor control unit, LED pulse units and de-glitch circuitry ROM Boot ROM 16 KBytes of System Boot ROM code ICU Interrupt Controller General Purpose interrupt controller with Unit configurable priority, and masking. CPR Clock, Power and Central Unit for controlling and generating the Reset block system clocks and resets and powerdown mechanisms PSS Power Save Storage Storage retained while system is powered down USB Universal Serial Bus USB device controller for interfacing with the Device host USB. ISI Inter-SoPEC Interface ISI controller for data and control communication with other SoPEC's in a multi SoPEC system SCB Serial Communication Contains both the USB and ISI blocks. Block Print Engine PCU PEP controller Provides external CPU with the means to read Pipeline and write PEP Unit registers, and read and (PEP) write DRAM in single 32-bit chunks. CDU Contone decoder unit Expands JPEG compressed contone layer and writes decompressed contone to DRAM CFU Contone FIFO Unit Provides line buffering between CDU and HCU LBD Lossless Bi-level Expands compressed bi-level layer. Decoder SFU Spot FIFO Unit Provides line buffering between LBD and HCU TE Tag encoder Encodes tag data into line of tag dots.
WO 2004/050369 PCT/AU2003/001616 72 TFU Tag FIFO Unit Provides tag data storage between TE and HCU HCU Halftoner compositor Dithers contone layer and composites the bi unit level spot 0 and position tag dots. DNC Dead Nozzle Compensates for dead nozzles by color Compensator redundancy and error diffusing dead nozzle data into surrounding dots. DWU Dotline Writer Unit Writes out the 6 channels of dot data for a given printline to the line store DRAM LLU Line Loader Unit Reads the expanded page image from line store, formatting the data appropriately for the bi-lithic printhead. PHI PrintHead Interface Is responsible for sending dot data to the bi lithic printheads and for providing line synchronization between multiple SoPECs. Also provides test interface to printhead such as temperature monitoring and Dead Nozzle Identification. 9.4 ADDRESSING SCHEME IN SoPEC SoPEC must address - 20 Mbit DRAM. 5 - PCU addressed registers in PEP. - CPU-subsystem addressed registers. SoPEC has a unified address space with the CPU capable of addressing all CPU-subsystem and PCU-bus accessible registers (in PEP) and all locations in DRAM. The CPU generates byte-aligned addresses for the whole of SoPEC. 10 22 bits are sufficient to byte address the whole SoPEC address space. 9.4.1 DRAM addressing scheme The embedded DRAM is composed of 256-bit words. However the CPU-subsystem may need to write individual bytes of DRAM. Therefore it was decided to make the DIU byte addressable. 22 bits are required to byte address 20 Mbits of DRAM. 15 Most blocks read or write 256-bit words of DRAM. Therefore only the top 17 bits i.e. bits 21 to 5 are required to address 256-bit word aligned locations. The exceptions are - CDU which can write 64-bits so only the top 19 address bits i.e. bits 21-3 are required. The CPU-subsystem always generates a 22-bit byte-aligned DIU address but it will send 20 flags to the DIU indicating whether it is an 8, 16 or 32-bit write. All DIU accesses must be within the same 256-bit aligned DRAM word. 9.4.2 PEP Unit DRAM addressing WO 2004/050369 PCT/AU2003/001616 73 PEP Unit configuration registers which specify DRAM locations should specify 256-bit aligned DRAM addresses i.e. using address bits 21:5. Legacy blocks from PEC1 e.g. the LBD and TE may need to specify 64-bit aligned DRAM addresses if these reused blocks DRAM addressing is difficult to modify. These 64-bit aligned addresses require address bits 21:3. However, these 64-bit aligned 5 addresses should be programmed to start at a 256-bit DRAM word boundary. Unlike PEC1, there are no constraints in SoPEC on data organization in DRAM except that all data structures must start on a 256-bit DRAM boundary. If data stored is not a multiple of 256-bits then the last word should be padded. 9.4.3 CPU subsystem bus addressed registers 10 The CPU subsystem bus supports 32-bit word aligned read and write accesses with variable access timings. See section 11.4 for more details of the access protocol used on this bus. The CPU subsystem bus does not currently support byte reads and writes but this can be added at a later date if required by imported IP. 9.4.4 PCU addressed registers in PEP 15 The PCU only supports 32-bit register reads and writes for the PEP blocks. As the PEP blocks only occupy a subsection of the overall address map and the PCU is explicitly selected by the MMU when a PEP block is being accessed the PCU does not need to perform a decode of the higher order address bits. See Table 11 for the PEP subsystem address map. 9.5 SoPEC MEMORY MAP 20 9.5.1 Main memory map The system wide memory map is shown in Figure 14 below. The memory map is discussed in detail in Section 11 11 Central Processing Unit (CPU). 9.5.2 CPU-bus peripherals address map The address mapping for the peripherals attached to the CPU-bus is shown in Table 10 below. The 25 MMU performs the decode of cpu adr[21:12] to generate the relevant cpu blockselect signal for each block. The addressed blocks decode however many of the lower order bits of cpuadr[11:2] are required to address all the registers within the block. Table 10. CPU-bus peripherals address map Block-base Address ROM-base Ox00000000 MMUbase Ox0001_0000 TIMbase x0001_1000 LSS base Ox00012000 GPIO base Ox0001_3000 SCBbase Ox0001_4000 ICU-base Ox00015000 CPRbase Ox0001_6000 DIU-base Ox0001_7000 WO 2004/050369 PCT/AU2003/001616 74 PSS base OxOO01_8000 Reserved 0xO001l9000 to OxOO01iFFFF PCU base Ox0002_0000 to 0x0002.BFFF 9.5.3 PCU Mapped Registers (PEP blocks) address map The PEP blocks are addressed via the PCU. From Figure 14, the PCU mapped registers are in the range Ox0002_0000 to 0x0002_BFFF. From Table 11 it can be seen that there are 12 sub-blocks within the PCU address space. Therefore, only four bits are necessary to address each of the sub 5 blocks within the PEP part of SoPEC. A further 12 bits may be used to address any configurable register within a PEP block. This gives scope for 1024 configurable registers per sub-block (the PCU mapped registers are all 32-bit addressed registers so the upper 10 bits are required to individually address them). This address will come either from the CPU or from a command stored in DRAM. The bus is assembled as follows: 10 - address[15:12] = sub-block address, - address[n:2] = register address within sub-block, only the number of bits required to decode the registers within each sub-block are used, - address[1:0] = byte address, unused as PCU mapped registers are all 32-bit addressed registers. 15 So for the case of the HCU, its addresses range from 0x7000 to 0x7FFF within the PEP subsystem or from 0x0002_7000 to 0x0002_7FFF in the overall system. Table 11. PEP blocks address map Blockbase Address PCUbase Ox0002_0000 CDUbase Ox0002_1000 CFUbase Ox0002_2000 LBDbase Ox0002_3000 SFUbase Ox0002_4000 TE_base Ox0002 5000 TFUbase Ox0002_6000 HCUbase Ox0002_7000 DNCbase Ox0002_8000 DWUbase Ox0002_9000 LLUbase 0x0002AOOO PHIbase 0x0002_BOOO to 0x0002_BFFF 9.6 BUFFER MANAGEMENT IN SoPEC 20 As outlined in Section 9.1, SoPEC has a requirement to print 1 side every 2 seconds i.e. 30 sides per minute. 9.6.1 Page buffering WO 2004/050369 PCT/AU2003/001616 75 Approximately 2 Mbytes of DRAM are reserved for compressed page buffering in SoPEC. If a page is compressed to fit within 2 Mbyte then a complete page can be transferred to DRAM before printing. However, the time to transfer 2 Mbyte using USB 1.1 is approximately 2 seconds. The .worst case cycle time to print a page then approaches 4 seconds. This reduces the worst-case print 5 speed to 15 pages per minute. 9.6.2 Band buffering The SoPEC page-expansion blocks support the notion of page banding. The page can be divided into bands and another band can be sent down to SoPEC while we are printing the current band. Therefore we can start printing once at least one band has been downloaded. 10 The band size granularity should be carefully chosen to allow efficient use of the USB bandwidth and DRAM buffer space. It should be small enough to allow seamless 30 sides per minute printing but not so small as to introduce excessive CPU overhead in orchestrating the data transfer and parsing the band headers. Band-finish interrupts have been provided to notify the CPU of free buffer space. It is likely that the host PC will supervise the band transfer and buffer management instead 15 of the SoPEC CPU. If SoPEC starts printing before the complete page has been transferred to memory there is a risk of a buffer underrun occurring if subsequent bands are not transferred to SoPEC in time e.g. due to insufficient USB bandwidth caused by another USB peripheral consuming USB bandwidth. A buffer underrun occurs if a line synchronisation pulse is received before a line of data has been 20 transferred to the printhead and causes the print job to fail at that line. If there is no risk of buffer underrun then printing can safely start once at least one band has been downloaded. If there is a risk of a buffer underrun occurring due to an interruption of compressed page data transfer, then the safest approach is to only start printing once we have loaded up the data for a complete page. This means that a worst case latency in the region of 2 seconds (with USBI.1) will 25 be incurred before printing the first page. Subsequent pages will take 2 seconds to print giving us the required sustained printing rate of 30 sides per minute. A Storage SoPEC (Section 7.2.5) could be added to the system to provide guaranteed bandwidth data delivery. The print system could also be constructed using an ISI-Bridge chip (Section 7.2.6) to provide guaranteed data delivery. 30 The most efficient page banding strategy is likely to be determined on a per page print job basis and so SoPEC will support the use of bands of any size. 10 SoPEC Use Cases 10.1 INTRODUCTION This chapter is intended to give an overview of a representative set of scenarios or use cases which 35 SoPEC can perform. SoPEC is by no means restricted to the particular use cases described and not every SoPEC system is considered here. In this chapter we discuss SoPEC use cases under four headings: 1) Normal operation use cases. 2) Security use cases. 40 3) Miscellaneous use cases.
WO 2004/050369 PCT/AU2003/001616 76 4) Failure mode use cases. Use cases for both single and multi-SoPEC systems are outlined. Some tasks may be composed of a number of sub-tasks. The realtime requirements for SoPEC software tasks are discussed in " 11 Central Processing Unit 5 (CPU)" under Section 11.3 Realtime requirements. 10.2 NORMAL OPERATION IN A SINGLE SoPEC SYSTEM WITH USB HOST CONNECTION SoPEC operation is broken up into a number of sections which are outlined below. Buffer management in a SoPEC system is normally performed by the host. 10.2.1 Powerup 10 Powerup describes SoPEC initialisation following an external reset or the watchdog timer system reset. A typical powerup sequence is: 1) Execute reset sequence for complete SoPEC. 2) CPU boot from ROM. 15 3) Basic configuration of CPU peripherals, SCB and DIU. DRAM initialisation. USB Wakeup. 4) Download and authentication of program (see Section 10.5.2). 5) Execution of program from DRAM. 6) Retrieve operating parameters from PRINTER_QA and authenticate operating parameters. 7) Download and authenticate any further datasets. 20 10.2.2 USB wakeup The CPU can put different sections of SoPEC into sleep mode by writing to registers in the CPR block (chapter 16). Normally the CPU sub-system and the DRAM will be put in sleep mode but the SCB and power-safe storage (PSS) will still be enabled. Wakeup describes SoPEC recovery from sleep mode with the SCB and power-safe storage (PSS) 25 still enabled. In a single SoPEC system, wakeup can be initiated following a USB reset from the SCB. A typical USB wakeup sequence is: 1) Execute reset sequence for sections of SoPEC in sleep mode. 2) CPU boot from ROM, if CPU-subsystem was in sleep mode. 30 3) Basic configuration of CPU peripherals and DIU, and DRAM initialisation, if required. 4) Download and authentication of program using results in Power-Safe Storage (PSS) (see Section 10.5.2). 5) Execution of program from DRAM. 6) Retrieve operating parameters from PRINTERQA and authenticate operating parameters. 35 7) Download and authenticate using results in PSS of any further datasets (programs). 10.2.3 Print initialization This sequence is typically performed at the start of a print job following powerup or wakeup: 1) Check amount of ink remaining via QA chips. 2) Download static data e.g. dither matrices, dead nozzle tables from host to DRAM.
WO 2004/050369 PCT/AU2003/001616 77 3) Check printhead temperature, if required, and configure printhead with firing pulse profile etc. accordingly. 4) Initiate printhead pre-heat sequence, if required. 10.2.4 First page download 5 Buffer management in a SoPEC system is normally performed by the host. First page, first band download and processing: 1) The host communicates to the SoPEC CPU over the USB to check that DRAM space remaining is sufficient to download the first band. 2) The host downloads the first band (with the page header) to DRAM. 10 3) When the complete page header has been downloaded the SoPEC CPU processes the page header, calculates PEP register commands and writes directly to PEP registers or to DRAM. 4) If PEP register commands have been written to DRAM, execute PEP commands from DRAM via PCU. Remaining bands download and processing: 15 1) Check DRAM space remaining is sufficient to download the next band. 2) Download the next band with the band header to DRAM. 3) When the complete band header has been downloaded, process the band header according to whichever band-related register updating mechanism is being used. 10.2.5 Start printing 20 1) Wait until at least one band of the first page has been downloaded. One approach is to only start printing once we have loaded up the data for a complete page. If we start printing before the complete page has been transferred to memory we run the risk of a buffer underrun occurring because compressed page data was not transferred to SoPEC in time e.g. due to insufficient USB bandwidth caused by another USB peripheral consuming 25 USB bandwidth. 2) Start all the PEP Units by writing to their Go registers, via PCU commands executed from DRAM or direct CPU writes. A rapid startup order for the PEP units is outlined in Table 12. Table 12. Typical PEP Unit startup order for printing a page. Step# Unit 1 DNC 2 DWU 3 HCU 4 PHI 5 LLU 6 CFU,SFU,TFU 7 CDU 8 TE,LBD 30 3) Print ready interrupt occurs (from PHI).
WO 2004/050369 PCT/AU2003/001616 78 4) Start motor control, if first page, otherwise feed the next page. This step could occur before the print ready interrupt. 5) Drive LEDs, monitor paper status. 6) Wait for page alignment via page sensor(s) GPIO interrupt. 5 7) CPU instructs PHI to start producing line syncs and hence commence printing, or wait for an external device to produce line syncs. 8) Continue to download bands and process page and band headers for next page. 10.2.6 Next page(s) download As for first page download, performed during printing of current page. 10 10.2.7 Between bands When the finished band flags are asserted band related registers in the CDU, LBD, TE need to be re-programmed before the subsequent band can be printed. This can be via PCU commands from DRAM. Typically only 3-5 commands per decompression unit need to be executed. These registers can also be reprogrammed directly by the CPU or most likely by updating from shadow registers. 15 The finished band flag interrupts the CPU to tell the CPU that the area of memory associated with the band is now free. 10.2.8 During page print Typically during page printing ink usage is communicated to the QA chips. 1) Calculate ink printed (from PHI). 20 2) Decrement ink remaining (via QA chips). 3) Check amount of ink remaining (via QA chips). This operation may be better performed while the page is being printed rather than at the end of the page. 10.2.9 Page finish These operations are typically performed when the page is finished: 25 1) Page finished interrupt occurs from PHI. 2) Shutdown the PEP blocks by de-asserting their Go registers. A typical shutdown order is defined in Table 13. This will set the PEP Unit state-machines to their idle states without resetting their configuration registers. 3) Communicate ink usage to QA chips, if required. 30 Table 13. End of page shutdown order for PEP Units. Step# Unit 1 PHI (will shutdown by itself in the normal case at the end of a page) 2 DWU (shutting this down stalls the DNC and therefore the HCU and above) 3 LLU (should already be halted due to PHI at end of last line of page) 4 TE (this is the only dot supplier likely to be running, halted by the HCU) 5 CDU (this is likely to already be halted due to end of contone band) WO 2004/050369 PCT/AU2003/001616 79 6 CFU, SFU, TFU, LBD (order unimportant, and should already be halted due to end of band) 7 HCU, DNC (order unimportant, should already have halted) 10.2.10 Start of next page These operations are typically performed before printing the next page: 1) Re-program the PEP Units via PCU command processing from DRAM based on page header. 2) Go to Start printing. 5 10.2.11 End of document 1) Stop motor control. 10.2.12 Sleep mode The CPU can put different sections of SoPEC into sleep mode by writing to registers in the CPR block described in Section 16. 10 1) Instruct host PC via USB that SoPEC is about to sleep. 2) Store reusable authentication results in Power-Safe Storage (PSS). 3) Put SoPEC into defined sleep mode. 10.3 NORMAL OPERATION IN A MULTI-SoPEC SYSTEM - ISIMASTER SoPEC In a multi-SoPEC system the host generally manages program and compressed page download to 15 all the SoPECs. Inter-SoPEC communication is over the ISI link which will add a latency. In the case of a multi-SoPEC system with just one USB 1.1 connection, the SoPEC with the USB connection is the ISIMaster. The ISI-bridge chip is the ISIMaster in the case of an ISI-Bridge SoPEC configuration. While it is perfectly possible for an ISISlave to have a direct USB connection to the host we do not treat this scenario explicitly here to avoid possible confusion. 20 In a multi-SoPEC system one of the SoPECs will be the PrintMaster. This SoPEC must manage and control sensors and actuators e.g. motor control. These sensors and actuators could be distributed over all the SoPECs in the system. An ISIMaster SoPEC may also be the PrintMaster SoPEC. In a multi-SoPEC system each printing SoPEC will generally have its own PRINTERQA chip (or at 25 least access to a PRINTERQA chip that contains the SoPEC's SOPEC_id_key) to validate operating parameters and ink usage. The results of these operations may be communicated to the PrintMaster SoPEC. In general the ISIMaster may need to be able to: " Send messages to the ISISlaves which will cause the ISISlaves to send 30 their status to the ISIMaster. " Instruct the ISISlaves to perform certain operations. As the ISI is an insecure interface commands issued over the ISI are regarded as user mode commands. Supervisor mode code running on the SoPEC CPUs will allow or disallow these commands. The software protocol needs to be constructed with this in mind. 35 The ISIMaster will initiate all communication with the ISISlaves. SoPEC operation is broken up into a number of sections which are outlined below. 10.3.1 Powerup WO 2004/050369 PCT/AU2003/001616 80 Powerup describes SoPEC initialisation following an external reset or the watchdog timer system reset. 1) Execute reset sequence for complete SoPEC. 2) CPU boot from ROM. 5 3) Basic configuration of CPU peripherals, SCB and DIU. DRAM initialisation USB Wakeup 4) SoPEC identification by activity on USB end-points 2-4 indicates it is the ISIMaster (unless the SoPEC CPU has explicitly disabled this function). 5) Download and authentication of program (see Section 10.5.3). 6) Execution of program from DRAM. 10 7) Retrieve operating parameters from PRINTERQA and authenticate operating parameters. 8) Download and authenticate any further datasets (programs). 9) The initial dataset may be broadcast to all the ISISlaves. 10) ISiMaster master SoPEC then waits for a short time to allow the authentication to take place on the ISISlave SoPECs. 15 11) Each ISISlave SoPEC is polled for the result of its program code authentication process. 12) If all ISISlaves report successful authentication the OEM code module can be distributed and authenticated. OEM code will most likely reside on one SoPEC. 10.3.2 USB wakeup The CPU can put different sections of SoPEC into sleep mode by writing to registers in the CPR 20 block [16]. Normally the CPU sub-system and the DRAM will be put in sleep mode but the SCB and power-safe storage (PSS) will still be enabled. Wakeup describes SoPEC recovery from sleep mode with the SCB and power-safe storage (PSS) still enabled. For an ISIMaster SoPEC connected to the host via USB, wakeup can be initiated following a USB reset from the SCB. 25 A typical USB wakeup sequence is: 1) Execute reset sequence for sections of SoPEC in sleep mode. 2) CPU boot from ROM, if CPU-subsystem was in sleep mode. 3) Basic configuration of CPU peripherals and DIU, and DRAM initialisation, if required. 4) SoPEC identification by activity on USB end-points 2-4 indicates it is the ISIMaster (unless 30 the SoPEC CPU has explicitly disabled this function). 5) Download and authentication of program using results in Power-Safe Storage (PSS) (see Section 10.5.3). 6) Execution of program from DRAM. 7) Retrieve operating parameters from PRINTERQA and authenticate operating parameters. 35 8) Download and authenticate any further datasets (programs) using results in Power-Safe Storage (PSS) (see Section 10.5.3). 9) Following steps as per Powerup. 10.3.3 Print initialization This sequence is typically performed at the start of a print job following powerup or wakeup: 40 1) Check amount of ink remaining via QA chips which may be present on a ISISlave SoPEC.
WO 2004/050369 PCT/AU2003/001616 81 2) Download static data e.g. dither matrices, dead nozzle tables from host to DRAM. 3) Check printhead temperature, if required, and configure printhead with firing pulse profile etc. accordingly. Instruct ISISlaves to also perform this operation. 4) Initiate printhead pre-heat sequence, if required. Instruct ISISlaves to also perform this 5 operation 10.3.4 First page download Buffer management in a SoPEC system is normally performed by the host. 1) The host communicates to the SoPEC CPU over the USB to check that DRAM space remaining is sufficient to download the first band. 10 2) The host downloads the first band (with the page header) to DRAM. 3) When the complete page header has been downloaded the SoPEC CPU processes the page header, calculates PEP register commands and write directly to PEP registers or to DRAM. 4) If PEP register commands have been written to DRAM, execute PEP commands from DRAM via PCU. 15 Poll ISISlaves for DRAM status and download compressed data to ISISlaves. Remaining first page bands download and processing: 1) Check DRAM space remaining is sufficient to download the next band. 2) Download the next band with the band header to DRAM. 3) When the complete band header has been downloaded, process the band header according 20 to whichever band-related register updating mechanism is being used. Poll ISISlaves for DRAM status and download compressed data to ISISlaves. 10.3.5 Start printing 1) Wait until at least one band of the first page has been downloaded. 2) Start all the PEP Units by writing to their Go registers, via PCU commands executed from 25 DRAM or direct CPU writes, in the suggested order defined in Table . 3) Print ready interrupt occurs (from PHI). Poll ISISlaves until print ready interrupt. 4) Start motor control (which may be on an ISISlave SoPEC), if first page, otherwise feed the next page. This step could occur before the print ready interrupt. 5) Drive LEDS, monitor paper status (which may be on an ISISlave SoPEC). 30 6) Wait for page alignment via page sensor(s) GPIO interrupt (which may be on an ISISlave SoPEC). 7) If the LineSyncMaster is a SoPEC its CPU instructs PHI to start producing master line syncs. Otherwise wait for an external device to produce line syncs. 8) Continue to download bands and process page and band headers for next page. 35 10.3.6 Next page(s) download As for first page download, performed during printing of current page. 10.3.7 Between bands When the finished band flags are asserted band related registers in the CDU, LBD and TE need to be re-programmed. This can be via PCU commands from DRAM. Typically only 3-5 commands per 40 decompression unit need to be executed. These registers can also be reprogrammed directly by the WO 2004/050369 PCT/AU2003/001616 82 CPU or by updating from shadow registers. The finished band flag interrupts to the CPU, tell the CPU that the area of memory associated with the band is now free. 10.3.8 During page print Typically during page printing ink usage is communicated to the QA chips. 5 1) Calculate ink printed (from PHI). 2) Decrement ink remaining (via QA chips). 3) Check amount of ink remaining (via QA chips). This operation may be better performed while the page is being printed rather than at the end of the page. 10.3.9 Page finish 10 These operations are typically performed when the page is finished: 1) Page finished interrupt occurs from PHI. Poll ISISlaves for page finished interrupts. 2) Shutdown the PEP blocks by de-asserting their Go registers in the suggested order in Table . This will set the PEP Unit state-machines to their startup states. 3) Communicate ink usage to QA chips, if required. 15 10.3.10 Startofnextpage These operations are typically performed before printing the next page: 1) Re-program the PEP Units via PCU command processing from DRAM based on page header. 2) Go to Start printing. 20 10.3.11 End of document 1) Stop motor control. This may be on an ISiSlave SoPEC. 10.3.12 Sleep mode The CPU can put different sections of SoPEC into sleep mode by writing to registers in the CPR block [16]. This may be as a result of a command from the host or as a result of a timeout. 25 1) Inform host PC of which parts of SoPEC system are about to sleep. 2) Instruct ISISlaves to enter sleep mode. 3) Store reusable cryptographic results in Power-Safe Storage (PSS). 4) Put ISIMaster SoPEC into defined sleep mode. 10.4 NORMAL OPERATION IN A MuLT-SoPEC SYSTEM - ISISLAVE SoPEC 30 This section the outline typical operation of an ISISlave SoPEC in a multi-SoPEC system. The ISIMaster can be another SoPEC or an ISI-Bridge chip. The ISISlave communicates with the host either via the ISIMaster or using a direct connection such as USB. For this use case we consider only an ISISlave that does not have a direct host connection. Buffer management in a SoPEC system is normally performed by the host. 35 10.4.1 Powerup Powerup describes SoPEC initialisation following an external reset or the watchdog timer system reset. A typical powerup sequence is: 1) Execute reset sequence for complete SoPEC. 40 2) CPU boot from ROM.
WO 2004/050369 PCT/AU2003/001616 83 3) Basic configuration of CPU peripherals, SCB and DIU. DRAM initialisation. 4) Download and authentication of program (see Section 10.5.3). 5) Execution of program from DRAM. 6) Retrieve operating parameters from PRINTERQA and authenticate operating parameters. 5 7) SoPEC identification by sampling GPIO pins to determine ISlId. Communicate ISild to ISIMaster. 8) Download and authenticate any further datasets. 10.4.2 ISI wakeup The CPU can put different sections of SoPEC into sleep mode by writing to registers in the CPR 10 block [16]. Normally the CPU sub-system and the DRAM will be put in sleep mode but the SCB and power-safe storage (PSS) will still be enabled. Wakeup describes SoPEC recovery from sleep mode with the SCB and power-safe storage (PSS) still enabled. In an ISISlave SoPEC, wakeup can be initiated following an ISI reset from the SCB. A typical ISI wakeup sequence is: 15 1) Execute reset sequence for sections of SoPEC in sleep mode. 2) CPU boot from ROM, if CPU-subsystem was in sleep mode. 3) Basic configuration of CPU peripherals and DIU, and DRAM initialisation, if required. 4) Download and authentication of program using results in Power-Safe Storage (PSS) (see Section 10.5.3). 20 5) Execution of program from DRAM. 6) Retrieve operating parameters from PRINTERQA and authenticate operating parameters. 7) SoPEC identification by sampling GPIO pins to determine ISild. Communicate ISlId to ISIMaster. 8) Download and authenticate any further datasets. 25 10.4.3 Print initialization This sequence is typically performed at the start of a print job following powerup or wakeup: 1) Check amount of ink remaining via QA chips. 2) Download static data e.g. dither matrices, dead nozzle tables from ISI to DRAM. 3) Check printhead temperature, if required, and configure printhead with firing pulse profile etc. 30 accordingly. 4) Initiate printhead pre-heat sequence, if required. 10.4.4 First page download Buffer management in a SoPEC system is normally performed by the host via the ISI. 1) Check DRAM space remaining is sufficient to download the first band. 35 2) The host downloads the first band (with the page header) to DRAM via the ISI. 3) When the complete page header has been downloaded, process the page header, calculate PEP register commands and write directly to PEP registers or to DRAM. 4) If PEP register commands have been written to DRAM, execute PEP commands from DRAM via PCU. 40 Remaining first page bands download and processing: WO 2004/050369 PCT/AU2003/001616 84 1) Check DRAM space remaining is sufficient to download the next band. 2) The host downloads the first band (with the page header) to DRAM via the ISI. 3) When the complete band header has been downloaded, process the band header according to whichever band-related register updating mechanism is being used. 5 10.4.5 Start printing 1) Wait until at least one band of the first page has been downloaded. 2) Start all the PEP Units by writing to their Go registers, via PCU commands executed from DRAM or direct CPU writes, in the order defined in Table . 3) Print ready interrupt occurs (from PHI). Communicate to PrintMaster via ISI. 10 4) Start motor control, if attached to this ISISlave, when requested by PrintMaster, if first page, otherwise feed next page. This step could occur before the print ready interrupt 5) Drive LEDS, monitor paper status, if on this ISiSlave SoPEC, when requested by PrintMaster 6) Wait for page alignment via page sensor(s) GPIO interrupt, if on this ISISlave SoPEC, and send to PrintMaster. 15 7) Wait for line sync and commence printing. 8) Continue to download bands and process page and band headers for next page. 10.4.6 Next page(s) download As for first band download, performed during printing of current page. 10.4.7 Between bands 20 When the finished band flags are asserted band related registers in the CDU, LBD and TE need to be re-programmed. This can be via PCU commands from DRAM. Typically only 3-5 commands per decompression unit need to be executed. These registers can also be reprogrammed directly by the CPU or by updating from shadow registers. The finished band flag interrupts to the CPU tell the CPU that the area of memory associated with the band is now free. 25 10.4.8 During page print Typically during page printing ink usage is communicated to the QA chips. 1) Calculate ink printed (from PHI). 2) Decrement ink remaining (via QA chips). 3) Check amount of ink remaining (via QA chips). This operation may be better performed while 30 the page is being printed rather than at the end of the page. 10.4.9 Page finish These operations are typically performed when the page is finished: 1) Page finished interrupt occurs from PHI. Communicate page finished interrupt to PrintMaster. 2) Shutdown the PEP blocks by de-asserting their Go registers in the suggested order in Table 35 . This will set the PEP Unit state-machines to their startup states. 3) Communicate ink usage to QA chips, if required. 10.4.10 Start of next page These operations are typically performed before printing the next page: 1) Re-program the PEP Units via PCU command processing from DRAM based on page 40 header.
WO 2004/050369 PCT/AU2003/001616 85 2) Go to Start printing. 10.4.11 End of document Stop motor control, if attached to this ISISlave, when requested by PrintMaster. 10.4.12 Powerdown 5 In this mode SoPEC is no longer powered. 1) Powerdown ISISlave SoPEC when instructed by ISIMaster. 10.4.13 Sleep The CPU can put different sections of SoPEC into sleep mode by writing to registers in the CPR block [16]. This may be as a result of a command from the host or ISIMaster or as a result of a 10 timeout. 1) Store reusable cryptographic results in Power-Safe Storage (PSS). 2) Put SoPEC into defined sleep mode. 10.5 SECURITY USE CASES Please see the 'SoPEC Security Overview' [9] document for a more complete description of SoPEC 15 security issues. The SoPEC boot operation is described in the ROM chapter of the SoPEC hardware design specification, Section 17.2. 10.5.1 Communication with the QA chips Communication between SoPEC and the QA chips (i.e. INKQA and PRINTERQA) will take place on at least a per power cycle and per page basis. Communication with the QA chips has three 20 principal purposes: validating the presence of genuine QA chips (i.e the printer is using approved consumables), validation of the amount of ink remaining in the cartridge and authenticating the operating parameters for the printer. After each page has been printed, SoPEC is expected to communicate the number of dots fired per ink plane to the QA chipset. SoPEC may also initiate decoy communications with the QA chips from time to time. 25 Process: - When validating ink consumption SoPEC is expected to principally act as a conduit between the PRINTER_QA and INKQA chips and to take certain actions (basically enable or disable printing and report status to host PC) based on the result. The communication channels are insecure but all traffic is signed to guarantee authenticity. 30 Known Weaknesses - All communication to the QA chips is over the LSS interfaces using a serial communication protocol. This is open to observation and so the communication protocol could be reverse engineered. In this case both the PRINTERQA and INKQA chips could be replaced by impostor devices (e.g. a single FPGA) that successfully emulated the communication 35 protocol. As this would require physical modification of each printer this is considered to be an acceptably low risk. Any messages that are not signed by one of the symmetric keys (such as the SoPECid key) could be reverse engineered. The imposter device must also have access to the appropriate keys to crack the system. - If the secret keys in the QA chips are exposed or cracked then the system, or parts of it, is 40 compromised.
WO 2004/050369 PCT/AU2003/001616 86 Assumptions: [1] The QA chips are not involved in the authentication of downloaded SoPEC code [2] The QA chip in the ink cartridge (INK QA) does not directly affect the operation of the cartridge in any way i.e. it does not inhibit the flow of ink etc. 5 [3] The INKQA and PRINTERQA chips are identical in their virgin state. They only become a INKQA or PRINTERQA after their FlashROM has been programmed. 10.5.2 Authentication of downloaded code in a single SoPEC system Process: 1) SoPEC identification by activity on USB end-points 2-4 indicates it is the ISiMaster (unless 10 the SoPEC CPU has explicitly disabled this function). 2) The program is downloaded to the embedded DRAM. 3) The CPU calculates a SHA-1 hash digest of the downloaded program. 4) The ResetSrc register in the CPR block is read to determine whether or not a power-on reset occurred. 15 5) If a power-on reset occurred the signature of the downloaded code (which needs to be in a known location such as the first or last N bytes of the downloaded code) is decrypted using the Silverbrook public bootOkey stored in ROM. This decrypted signature is the expected SHA-1 hash of the accompanying program. The encryption algorithm is likely to be a public key algorithm such as RSA. If a power-on reset did not occur then the expected SHA-1 hash 20 is retrieved from the PSS and the compute intensive decryption is not required. 6) The calculated and expected hash values are compared and if they match then the programs authenticity has been verified. 7) If the hash values do not match then the host PC is notified of the failure and the SoPEC will await a new program download. 25 8) If the hash values match then the CPU starts executing the downloaded program. 9) If, as is very likely, the downloaded program wishes to download subsequent programs (such as OEM code) it is responsible for ensuring the authenticity of everything it downloads. The downloaded program may contain public keys that are used to authenticate subsequent downloads, thus forming a hierarchy of authentication. The SoPEC ROM does not control 30 these authentications - it is solely concerned with verifying that the first program downloaded has come from a trusted source. 10) At some subsequent point OEM code starts executing. The Silverbrook supervisor code acts as an OIS to the OEM user mode code. The OEM code must access most SoPEC functionality via system calls to the Silverbrook code. 35 11) The OEM code is expected to perform some simple 'turn on the lights' tasks after which the host PC is informed that the printer is ready to print and the Start Printing use case comes into play. Known Weaknesses: - If the Silverbrook private bootOkey is exposed or cracked then the system is seriously 40 compromised. A ROM mask change would be required to reprogram the bootOkey.
WO 2004/050369 PCT/AU2003/001616 87 10.5.3 Authentication of downloaded code in a multi-SoPEC system 10.5.3.1 ISIMaster SoPEC Process: 1) SoPEC identification by activity on USB end-points 2-4 indicates it is the ISIMaster. 2) The SCB is configured to broadcast the data received from the host PC. 5 3) The program is downloaded to the embedded DRAM and broadcasted to all ISISlave SoPECs over the ISI. 4) The CPU calculates a SHA-1 hash digest of the downloaded program. 5) The ResetSrc register in the CPR block is read to determine whether or not a power-on reset occurred. 10 6) If a power-on reset occurred the signature of the downloaded code (which needs to be in a known location such as the first or last N bytes of the downloaded code) is decrypted using the Silverbrook public bootOkey stored in ROM. This decrypted signature is the expected SHA-1 hash of the accompanying program. The encryption algorithm is likely to be a public key algorithm such as RSA. If a power-on reset did not occur then the expected SHA-1 hash 15 is retrieved from the PSS and the compute intensive decryption is not required. 7) The calculated and expected hash values are compared and if they match then the programs authenticity has been verified. 8) If the hash values do not match then the host PC is notified of the failure and the SoPEC will await a new program download. 20 9) If the hash values match then the CPU starts executing the downloaded program. 10) It is likely that the downloaded program will poll each ISISlave SoPEC for the result of its authentication process and to determine the number of slaves present and their ISlIds. 11) If any ISISlave SoPEC reports a failed authentication then the ISIMaster communicates this to the host PC and the SoPEC will await a new program download. 25 12) If all ISISlaves report successful authentication then the downloaded program is responsible for the downloading, authentication and distribution of subsequent programs within the multi SoPEC system. 13) At some subsequent point OEM code starts executing. The Silverbrook supervisor code acts as an O/S to the OEM user mode code. The OEM code must access most SoPEC 30 functionality via system calls to the Silverbrook code. 14) The OEM code is expected to perform some simple 'turn on the lights' tasks after which the master SoPEC determines that all SoPECs are ready to print. The host PC is informed that the printer is ready to print and the Start Printing use case comes into play. 35 10.5.3.2 ISISlave SoPEC Process: 1) When the CPU comes out of reset the SCB will be in slave mode, and the SCB is already configured to receive data from both the ISI and USB. 2) The program is downloaded (via ISI or USB) to embedded DRAM. 3) The CPU calculates a SHA-1 hash digest of the downloaded program.
WO 2004/050369 PCT/AU2003/001616 88 4) The ResetSrc register in the CPR block is read to determine whether or not a power-on reset occurred. 5) If a power-on reset occurred the signature of the downloaded code (which needs to be in a known location such as the first or last N bytes of the downloaded code) is decrypted using 5 the Silverbrook public bootOkey stored in ROM. This decrypted signature is the expected SHA-1 hash of the accompanying program. The encryption algorithm is likely to be a public key algorithm such as RSA. If a power-on reset did not occur then the expected SHA-1 hash is retrieved from the PSS and the compute intensive decryption is not required. 6) The calculated and expected hash values are compared and if they match then the programs 10 authenticity has been verified. 7) If the hash values do not match, then the ISISlave device will await a new program again 8) If the hash values match then the CPU starts executing the downloaded program. 9) It is likely that the downloaded program will communicate the result of its authentication process to the ISIMaster. The downloaded program is responsible for determining the 15 SoPECs ISlid, receiving and authenticating any subsequent programs. 10) At some subsequent point OEM code starts executing. The Silverbrook supervisor code acts as an O/S to the OEM user mode code. The OEM code must access most SoPEC functionality via system calls to the Silverbrook code. 11) The OEM code is expected to perform some simple 'turn on the lights' tasks after which the 20 master SoPEC is informed that this slave is ready to print. The Start Printing use case then comes into play. Known Weaknesses If the Silverbrook private bootOkey is exposed or cracked then the system is seriously compromised. 25 - ISI is an open interface i.e. messages sent over the ISI are in the clear. The communication channels are insecure but all traffic is signed to guarantee authenticity. As all communication over the ISI is controlled by Supervisor code on both the ISIMaster and ISISlave then this also provides some protection against software attacks. 10.5.4 Authentication and upgrade of operating parameters for a printer 30 The SoPEC IC will be used in a range of printers with different capabilities (e.g. A3/A4 printing, printing speed, resolution etc.). It is expected that some printers will also have a software upgrade capability which would allow a user to purchase a license that enables an upgrade in their printer's capabilities (such as print speed). To facilitate this it must be possible to securely store the operating parameters in the PRINTERQA chip, to securely communicate these parameters to the 35 SoPEC and to securely reprogram the parameters in the event of an upgrade. Note that each printing SoPEC (as opposed to a SoPEC that is only used for the storage of data) will have its own PRINTERQA chip (or at least access to a PRINTERQA that contains the SoPEC's SoPEC-id-key). Therefore both ISIMaster and ISISlave SoPECs will need to authenticate operating parameters. 40 Process: WO 2004/050369 PCT/AU2003/001616 89 1) Program code is downloaded and authenticated as described in sections 10.5.2 and 10.5.3 above. 2) The program code has a function to create the SoPECid_key from the unique SoPECid that was programmed when the SoPEC was manufactured. 5 3) The SoPEC retrieves the signed operating parameters from its PRINTERQA chip. The PRINTERQA chip uses the SoPEC id key (which is stored as part of the pairing process executed during printhead assembly manufacture & test) to sign the operating parameters which are appended with a random number to thwart replay attacks. 4) The SoPEC checks the signature of the operating parameters using its SoPECid key. If this 10 signature authentication process is successful then the operating parameters are considered valid and the overall boot process continues. If not the error is reported to the host PC. 5) Operating parameters may also be set or upgraded using a second key, the PrintEngineLicense key, which is stored on the PRINTERQA and used to authenticate the change in operating parameters. 15 Known Weaknesses: It may be possible to retrieve the unique SoPEC _id by placing the SoPEC in test mode and scanning it out. It is certainly possible to obtain it by reverse engineering the device. Either way the SoPEC id (and by extension the SoPEC idkey) so obtained is valid only for that specific SoPEC and so printers may only be compromised one at a time by parties with the 20 appropriate specialised equipment. Furthermore even if the SoPECid is compromised, the other keys in the system, which protect the authentication of consumables and of program code, are unaffected. 10.6 MISCELLANEOUS USE CASES There are many miscellaneous use cases such as the following examples. Software running on the 25 SoPEC CPU or host will decide on what actions to take in these scenarios. 10.6.1 Disconnect / Re-connect of QA chips. 1) Disconnect of a QA chip between documents or if ink runs out mid-document. 2) Re-connect of a QA chip once authenticated e.g. ink cartridge replacement should allow the system to resume and print the next document 30 10.6.2 Page arrives before print ready interrupt. 1) Engage clutch to stop paper until print ready interrupt occurs. 10.6.3 Dead-nozzle table upgrade This sequence is typically performed when dead nozzle information needs to be updated by performing a printhead dead nozzle test. 35 1) Run printhead nozzle test sequence 2) Either host or SoPEC CPU converts dead nozzle information into dead nozzle table. 3) Store dead nozzle table on host. 4) Write dead nozzle table to SoPEC DRAM. 10.7 FAILURE MODE USE CASES 40 10.7.1 System errors and security violations WO 2004/050369 PCT/AU2003/001616 90 System errors and security violations are reported to the SoPEC CPU and host. Software running on the SoPEC CPU or host will then decide what actions to take. Silverbrook code authentication failure. 1) Notify host PC of authentication failure. 5 2) Abort print run. OEM code authentication failure. 1) Notify host PC of authentication failure. 2) Abort print run. Invalid QA chip(s). 10 1) ReporttohostPC. 2) Abort print run. MMU security violation interrupt. 1) This is handled by exception handler. 2) Report to host PC 15 3) Abort print run. Invalid address interrupt from PCU. 1) This is handled by exception handler. 2) Report to host PC. 3) Abort print run. 20 Watchdog timer interrupt. 1) This is handled by exception handler. 2) Report to host PC. 3) Abort print run. Host PC does not acknowledge message that SoPEC is about to power down. 25 1) Power down anyway. 10.7.2 Printing errors Printing errors are reported to the SoPEC CPU and host. Software running on the host or SoPEC CPU will then decide what actions to take. Insufficient space available in SoPEC compressed band-store to download a band. 30 1) Report to the host PC. Insufficient ink to print. 1) Report to host PC. Page not downloaded in time while printing. 1) Buffer underrun interrupt will occur. 35 2) Report to host PC and abort print run. JPEG decoder error interrupt. 1) Report to host PC. CPU SUBSYSTEM 40 11 Central Processing Unit (CPU) WO 2004/050369 PCT/AU2003/001616 91 11.1 OVERVIEW The CPU block consists of the CPU core, MMU, cache and associated logic. The principal tasks for the program running on the CPU to fulfill in the system are: Communications: 5 - Control the flow of data from the USB interface to the DRAM and ISI - Communication with the host via USB or ISI - Running the USB device driver PEP Subsystem Control: - Page and band header processing (may possibly be performed on host PC) 10 - Configure printing options on a per band, per page, per job or per power cycle basis * Initiate page printing operation in the PEP subsystem - Retrieve dead nozzle information from the printhead interface (PHI) and forward to the host PC - Select the appropriate firing pulse profile from a set of predefined profiles based on the 15 printhead characteristics - Retrieve printhead temperature via the PHI Security: - Authenticate downloaded program code - Authenticate printer operating parameters 20 - Authenticate consumables via the PRINTERQA and INKQA chips - Monitor ink usage Isolation of OEM code from direct access to the system resources Other: o Drive the printer motors using the GPIO pins 25 - Monitoring the status of the printer (paper jam, tray empty etc.) * Driving front panel LEDs - Perform post-boot initialisation of the SoPEC device - Memory management (likely to be in conjunction with the host PC) * Miscellaneous housekeeping tasks 30 To control the Print Engine Pipeline the CPU is required to provide a level of performance at least equivalent to a 16-bit Hitachi H8-3664 microcontroller running at 16 MHz. An as yet undetermined amount of additional CPU performance is needed to perform the other tasks, as well as to provide the potential for such activity as Netpage page assembly and processing, RIPing etc. The extra 35 performance required is dominated by the signature verification task and the SCB (including the USB) management task. An operating system is not required at present. A number of CPU cores have been evaluated and the LEON P1754 is considered to be the most appropriate solution. A diagram of the CPU block is shown in Figure 15 below. 11.2 DEFINITIONS OF I/OS 40 Table 14. CPU Subsystem I/Os WO 2004/050369 PCT/AU2003/001616 92 Port name Pins 1/O Description Clocks and Resets prst-n 1 In Global reset. Synchronous to pclk, active low. Pclk 1 In Global clock CPU to DIU DRAM interface cpu adr[21:21 20 Out ddress bus for both DRAM and peripheral access cpu dataout[31:0] 32 Out Data out to both DRAM and peripheral devices. This should be driven at the same time as the cpu adr and request signals. dram cpu data[255:0] 256 In Read data from the DRAM cpu-diu-rreq 1 Out Read request to the DIU DRAM diu-cpurack 1 In Acknowledge from DIU that read request has been accepted. diu-cpu_rvalid 1 In Signal from DIU telling SoPEC Unit that valid read data is on the dramcpudata bus cpudiuwdatavalid 1 Out Signal from the CPU to the DIU indicating that the data currently on the cpudiu wdata bus is valid and should be committed to the DIU posted write buffer diu-cpu writerdy I In Signal from the DIU indicating that the posted write buffer is empty cpu diuwdadr[21:4] 18 Out rite address bus to the DIU cpudiuwdata[127:0] 128 Out rite data bus to the DIU cpu diu-wmask[1 5:0] 16 Out rite mask for the cpu_diu_wdata bus. Each bit corresponds to a byte of the 128-bit cpudiuwdata bus. CPU to peripheral blocks cpurwn 1 Out Common read/not-write signal from the CPU cpu acode[1:0] 2 Out CPU access code signals. cpuacode[0] - Program (0) / Data (1) access cpu-acode[1] - User (0) / Supervisor (1) access cpu-cpr_sel 1 Out CPR block select. cprcpu-rdy 1 In Ready signal to the CPU. When cpr cpurdy is high it indicates the last cycle of the access. For a write cycle this means cpu dataout has been registered by the CPR block and for a read cycle this means the data on cprLcpu data is valid. cpr._cpu_berr 1 In CPR bus error signal to the CPU.
WO 2004/050369 PCT/AU2003/001616 93 cprcpu_data[31:0] 32 In Read data bus from the CPR block cpugpio sel 1 Out GPIO block select. gpiocpu-rdy 1 In GPIO ready signal to the CPU. gpiocpuberr 1 In GPIO bus error signal to the CPU. gpio-cpu-data[31:0] 32 In Read data bus from the GPIO block cpu-icu sel 1 Out ICU block select. icu-cpu rdy I In ICU ready signal to the CPU. icu-cpu berr 1 in ICU bus error signal to the CPU. icu-cpu-data[31:0] 32 In Read data bus from the ICU block cpu-lsssel 1 Out LSS block select. Iss-cpu-rdy 1 In LSS ready signal to the CPU. Iss-cpu_berr 1 In LSS bus error signal to the CPU. Iss-cpu-data[31:0] 32 In Read data bus from the LSS block cpu-pcusel 1 Out PCU block select. pcu-cpurdy 1 In PCU ready signal to the CPU. pcu-cpuberr 1 In PCU bus error signal to the CPU. pcu-cpu-data[31:0] 32 In Read data bus from the PCU block cpu-scb_sel 1 Out SCB block select. sob cpu rdy 1 In SCB ready signal to the CPU. scb-cpu_berr 1 In SCB bus error signal to the CPU. scb-cpu-data[31:0] 32 In Read data bus from the SCB block oputimsel 1 Out Timers block select. tim.cpu-rdy 1 In Timers block ready signal to the CPU. tim-cpu_berr 1 In Timers bus error signal to the CPU. timcpu-data[31:0] 32 In Read data bus from the Timers block opurom_sel 1 Out ROM block select. romcpurdy 1 In ROM block ready signal to the CPU. rom-cpu_berr 1 In ROM bus error signal to the CPU. romcpudata[31:0] 32 In Read data bus from the ROM block cpupss_sel 1 Out PSS block select. pss-cpurdy 1 In PSS block ready signal to the CPU. pss-cpu_berr 1 In PSS bus error signal to the CPU. pss-cpudata[31:0] 32 In Read data bus from the PSS block cpudiu_sel 1 Out DIU register block select. diu-cpurdy 1 In DIU register block ready signal to the CPU. diu.cpu_berr 1 In DIU bus error signal to the CPU. diu-cpu-data[31:0] 32 In Read data bus from the DIU block Interrupt signals WO 2004/050369 PCT/AU2003/001616 94 icu cpu_ilevel[3:0] 3 In An interrupt is asserted by driving the appropriate priority level on icucpuilevel. These signals must remain asserted until the CPU executes an interrupt acknowledge cycle. 3 Out Indicates the level of the interrupt the CPU is acknowledging when cpu iack is high cpuiack 1 Out Interrupt acknowledge signal. The exact timing depends on the CPU core implementation Debug signals diu cpu debugvalid 1 In Signal indicating the data on the diu cpu data bus is valid debug data. tim cpu debugvalid 1 In Signal indicating the data on the tim cpu data bus is valid debug data. scb_cpudebugvalid 1 In Signal indicating the data on the scb_cpudata bus is valid debug data. pcu cpu debugvalid 1 In Signal indicating the data on the pcucpudata bus is valid debug data. Iss cpu debugvalid 1 In Signal indicating the data on the iss cpu data bus is valid debug data. icu cpudebugvalid 1 In Signal indicating the data on the icu cpudata bus is valid debug data. gpio-cpu debugvalid 1 In Signal indicating the data on the gpio cpu data bus is valid debug data. cprcpu debugvalid 1 In Signal indicating the data on the cpr.cpu data bus is valid debug data. debug_dataout 32 Out Output debug data to be muxed on to the GPIO & PHI pins debug_datavalid 1 Out Debug valid signal indicating the validity of the data on debugdata out. This signal is used in all debug configurations debug__cntrl 33 Out Control signal for each PHI bound debug data line indicating whether or not the debug data should be selected by the pin mux 11.3 REALTIME REQUIREMENTS The SoPEC realtime requirements have yet to be fully determined but they may be split into three categories: hard, firm and soft 11.3.1 Hard realtime requirements WO 2004/050369 PCT/AU2003/001616 95 Hard requirements are tasks that must be completed before a certain deadline or failure to do so will result in an error perceptible to the user (printing stops or functions incorrectly). There are three hard realtime tasks: Motor control: The motors which feed the paper through the printer at a constant speed 5 during printing are driven directly by the SoPEC device. Four periodic signals with different phase relationships need to be generated to ensure the paper travels smoothly through the printer. The generation of these signals is handled by the GPIO hardware (see section 13.2 for more details) but the CPU is responsible for enabling these signals (i.e. to start or stop the motors) and coordinating the movement of the paper with the printing operation of the 10 printhead. Buffer management: Data enters the SoPEC via the SCB at an uneven rate and is consumed by the PEP subsystem at a different rate. The CPU is responsible for managing the DRAM buffers to ensure that neither overrun nor underrun occur. This buffer management is likely to be performed under the direction of the host. 15 - Band processing: In certain cases PEP registers may need to be updated between bands. As the timing requirements are most likely too stringent to be met by direct CPU writes to the PCU a more likely scenario is that a set of shadow registers will programmed in the compressed page units before the current band is finished, copied to band related registers by the finished band signals and the processing of the next band will continue immediately. 20 An alternative solution is that the CPU will construct a DRAM based set of commands (see section 21.8.5 for more details) that can be executed by the PCU. The task for the CPU here is to parse the band headers stored in DRAM and generate a DRAM based set of commands for the next number of bands. The location of the DRAM based set of commands must then be written to the PCU before the current band has been processed by the PEP subsystem. It 25 is also conceivable (but currently considered unlikely) that the host PC could create the DRAM based commands. In this case the CPU will only be required to point the PCU to the correct location in DRAM to execute commands from. 11.3.2 Firm requirements Firm requirements are tasks that should be completed by a certain time or failure to do so will 30 result in a degradation of performance but not an error. The majority of the CPU tasks for SoPEC fall into this category including all interactions with the QA chips, program authentication, page feeding, configuring PEP registers for a page or job, determining the firing pulse profile, communication of printer status to the host over the USB and the monitoring of ink usage. The authentication of downloaded programs and messages will be the most compute intensive 35 operation the CPU will be required to perform. Initial investigations indicate that the LEON processor, running at 160 MHz, will easily perform three authentications in under a second. Table 15. Expected firm requirements Requirement Duration Power-on to start of printing first page [USB and slave SoPEC - 8 secs ?? WO 2004/050369 PCT/AU2003/001616 96 enumeration, 3 or more RSA signature verifications, code and compressed page data download and chip initialisation] Wake-up from sleep mode to start printing [3 or more SHA-1 / RSA - 2 secs operations, code and compressed page data download and chip re initialisation Authenticate ink usage in the printer ~ 0.5 secs Determining firing pulse profile - 0.1 secs Page feeding, gap between pages OEM dependent Communication of printer status to host PC - 10 ms Configuring PEP registers ?? 11.3.3 Soft requirements Soft requirements are tasks that need to be done but there are only light time constraints on when they need to be done. These tasks are performed by the CPU when there are no pending higher 5 priority tasks. As the SoPEC CPU is expected to be lightly loaded these tasks will mostly be executed soon after they are scheduled. 11.4 BUs PROTOCOLS As can be seen from Figure 15 above there are different buses in the CPU block and different protocols are used for each bus. There are three buses in operation: 10 11.4.1 AHB bus The LEON CPU core uses an AMBA2.0 AHB bus to communicate with memory and peripherals (usually via an APB bridge). See the AMBA specification [38], section 5 of the LEON users manual [37] and section 11.6.6.1 of this document for more details. 11.4.2 CPU to DIU bus 15 This bus conforms to the DIU bus protocol described in Section 20.14.8. Note that the address bus used for DIU reads (i.e. cpu adr(21:2)) is also that used for CPU subsystem with bus accesses while the write address bus (cpudiuwadr) and the read and write data buses (dram cpu_data and cpudiuwdata) are private buses between the CPU and the DIU. The effective bus width differs between a read (256 bits) and a write (128 bits). As certain CPU instructions may require byte write 20 access this will need to be supported by both the DRAM write buffer (in the AHB bridge) and the DIU. See section 11.6.6.1 for more details. 11.4.3 CPU Subsystem Bus For access to the on-chip peripherals a simple bus protocol is used. The MMU must first determine which particular block is being addressed (and that the access is a valid one) so that the 25 appropriate block select signal can be generated. During a write access CPU write data is driven out with the address and block select signals in the first cycle of an access. The addressed slave peripheral responds by asserting its ready signal indicating that it has registered the write data and the access can complete. The write data bus is common to all peripherals and is also used for CPU writes to the embedded DRAM. A read access is initiated by driving the address and select signals 30 during the first cycle of an access. The addressed slave responds by placing the read data on its WO 2004/050369 PCT/AU2003/001616 97 bus and asserting its ready signal to indicate to the CPU that the read data is valid. Each block has a separate point-to-point data bus for read accesses to avoid the need for a tri-stateable bus. All peripheral accesses are 32-bit (Programming note: char or short C types should not be used to access peripheral registers). The use of the ready signal allows the accesses to be of variable 5 length. In most cases accesses will complete in two cycles but three or four (or more) cycles accesses are likely for PEP blocks or IP blocks with a different native bus interface. All PEP blocks are accessed via the PCU which acts as a bridge. The PCU bus uses a similar protocol to the CPU subsystem bus but with the PCU as the bus master. The duration of accesses to the PEP blocks is influenced by whether or not the PCU is executing 10 commands from DRAM. As these commands are essentially register writes the CPU access will need to wait until the PCU bus becomes available when a register access has been completed. This could lead to the CPU being stalled for up to 4 cycles if it attempts to access PEP blocks while the PCU is executing a command. The size and probability of this penalty is sufficiently small to have any significant impact on performance. 15 In order to support user mode (i.e. OEM code) access to certain peripherals the CPU subsystem bus propagates the CPU function code signals (cpu acode[1:0]). These signals indicate the type of address space (i.e. User/Supervisor and Program/Data) being accessed by the CPU for each access. Each peripheral must determine whether or not the CPU is in the correct mode to be granted access to its registers and in some cases (e.g. Timers and GPIO blocks) different access 20 permissions can apply to different registers within the block. If the CPU is not in the correct mode then the violation is flagged by asserting the block's bus error signal (block cpu berr) with the same timing as its ready signal (block cpu rdy) which remains deasserted. When this occurs invalid read accesses should return 0 and write accesses should have no effect. Figure 16 shows two examples of the peripheral bus protocol in action. A write to the LSS block 25 from code running in supervisor mode is successfully completed. This is immediately followed by a read from a PEP block via the PCU from code running in user mode. As this type of access is not permitted the access is terminated with a bus error. The bus error exception processing then starts directly after this - no further accesses to the peripheral should be required as the exception handler should be located in the DRAM. 30 Each peripheral acts as a slave on the CPU subsystem bus and its behavior is described by the state machine in section 11.4.3.1 11.4.3.1 CPU subsystem bus slave state machine CPU subsystem bus slave operation is described by the state machine in Figure 17.This state machine will be implemented in each CPU subsystem bus slave. The only new signals mentioned 35 here are the validaccess and reg available signals. The valid_ access is determined by comparing the cpu_acode value with the block or register (in the case of a block that allow user access on a per register basis such as the GPIO block) access permissions and asserting valid access if the permissions agree with the CPU mode. The reg available signal is only required in the PCU or in blocks that are not capable of two-cycle access (e.g. blocks containing imported IP with different 40 bus protocols). In these blocks the reg available signal is an internal signal used to insert wait WO 2004/050369 PCT/AU2003/001616 98 states (by delaying the assertion of blockcpurdy) until the CPU bus slave interface can gain access to the register. When reading from a register that is less than 32 bits wide the CPU subsystems bus slave should return zeroes on the unused upper bits of the blockcpu data bus. 5 To support debug mode the contents of the register selected for debug observation, debug reg, are always output on the block cpu_data bus whenever a read access is not taking place. See section 11.8 for more details of debug operation. 11.5 LEON CPU The LEON processor is an open-source implementation of the IEEE-1754 standard (SPARC V8) 10 instruction set. LEON is available from and actively supported by Gaisler Research (www.gaisler.com). The following features of the LEON-2 processor will be utilised on SoPEC: * IEEE-1 754 (SPARC V8) compatible integer unit with 5-stage pipeline 15 * Separate instruction and data cache (Harvard architecture). 1 kbyte direct mapped caches will be used for both. * Full implementation of AMBA-2.0 AHB on-chip bus The standard release of LEON incorporates a number of peripherals and support blocks which will not be included on SoPEC. The LEON core as used on SoPEC will consist of: 1) the LEON integer 20 unit, 2) the instruction and data caches (currently 1 kB each), 3) the cache control logic, 4) the AHB interface and 5) possibly the AHB controller (although this functionality may be implemented in the LEON AHB bridge). The version of the LEON database that the SoPEC LEON components will be sourced from is LEON2-1.0.7 although later versions may be used if they offer worthwhile functionality or bug fixes 25 that affect the SoPEC design. The LEON core will be clocked using the system clock, pclk, and reset using the prstnsection[1] signal. The ICU will assert all the hardware interrupts using the protocol described in section 11.9. The LEON hardware multipliers and floating-point unit are not required. SoPEC will use the recommended 8 register window configuration. 30 Further details of the SPARC V8 instruction set and the LEON processor can be found in [36] and [37] respectively. 11.5.1 LEON Registers Only two of the registers described in the LEON manual are implemented on SoPEC - the LEON configuration register and the Cache Control Register (CCR). The addresses of these registers are 35 shown in Table 16. The configuration register bit fields are described below and the CCR is described in section 11.7.1.1. 11.5.1.1 LEON configuration register The LEON configuration register allows runtime software to determine the settings of LEONs various configuration options. This is a read-only register whose value for the SoPEC ASIC will be WO 2004/050369 PCT/AU2003/001616 99 0x1071_8C00. Further descriptions of many of the bitfields can be found in the LEON manual. The values used for SoPEC are highlighted in bold for clarity. Table 16. LEON Configuration Register Field Name bit(s) Description WriteProtection 1:0 Write protection type. 00 - none 01 - standard PCICore 3:2 PCI core type 00 - none 01 - InSilicon 10 - ESA II - Other FPUType 5:4 FPU type. 00 - none 01 - Meiko MemStatus 6 0 - No memory status and failing address register present 1 - Memory status and failing address register present Watchdog 7 0 -Watchdog timer not present (Note this refers to the LEON watchdog timer in the LEON timer block). 1 - Watchdog timer present UMUL/SMUL 8 0 - UMUL/SMUL instructions are not implemented 1 - UMUL/SMUL instructions are implemented UDIV/SDIV 9 0 - UMUL/SMUL instructions are not implemented 1 - UMUL/SMUL instructions are implemented DLSZ 11:10 Data cache line size in 32-bit words: 00 - 1 word 01 - 2 words 10 - 4 words 11 - 8 words DCSZ 14:12 Data cache size in kBbytes = 2u. SoPEC DCSZ = 0. ILSZ 16:15 Instruction cache line size in 32-bit words: 00 - 1 word 01 - 2 words 10 - 4 words 11 - 8 words ICSZ 19:17 Instruction cache size in kBbytes = 2' . SoPEC ICSZ = 0. RegWin 24:20 The implemented number of SPARC register windows - 1. SoPEC value = 7.
WO 2004/050369 PCT/AU2003/001616 100 UMAC/SMAC 25 0 - UMAC/SMAC instructions are not implemented 1 - UMAC/SMAC instructions are implemented Watchpoints 28:26 The implemented number of hardware watchpoints. SoPEC value =4. SDRAM 29 0 - SDRAM controller not present 1 - SDRAM controller present DSU 30 0 - Debug Support Unit not present 1 - Debug Support Unit present Reserved 31 Reserved. SoPEC value = 0. 11.6 MEMORY MANAGEMENT UNIT (MMU) Memory Management Units are typically used to protect certain regions of memory from invalid accesses, to perform address translation for a virtual memory system and to maintain memory page 5 status (swapped-in, swapped-out or unmapped) The SoPEC MMU is a much simpler affair whose function is to ensure that all regions of the SoPEC memory map are adequately protected. The MMU does not support virtual memory and physical addresses are used at all times. The SoPEC MMU supports a full 32-bit address space. The SoPEC memory map is depicted in Figure 18 below. 10 The MMU selects the relevant bus protocol and generates the appropriate control signals depending on the area of memory being accessed. The MMU is responsible for performing the address decode and generation of the appropriate block select signal as well as the selection of the correct block read bus during a read access. The MMU will need to support all of the bus transactions the CPU can produce including interrupt acknowledge cycles, aborted transactions etc. 15 When an MMU error occurs (such as an attempt to access a supervisor mode only region when in user mode) a bus error is generated. While the LEON can recognise different types of bus error (e.g. data store error, instruction access error) it handles them in the same manner as it handles all traps i.e it will transfer control to a trap handler. No extra state information is be stored because of the nature of the trap. The location of the trap handler is contained in the TBR (Trap Base Register). 20 This is the same mechanism as is used to handle interrupts. 11.6.1 CPU-bus peripherals address map The address mapping for the peripherals attached to the CPU-bus is shown in Table 17 below. The MMU performs the decode of the high order bits to generate the relevant cpu blockselect signal. Apart from the PCU, which decodes the address space for the PEP blocks, each block only needs 25 to decode as many bits of cpu adr[l 1:2] as required to address all the registers within the block. Table 17. CPU-bus peripherals address map Block-base Address ROM-base Ox0000 0000 MMU base Ox0001l0000 WO 2004/050369 PCT/AU2003/001616 101 TIMbase Ox00011000 LSSbase OxOO012000 GPIO base Ox00013000 SCB_base 0x00014000 ICU_base Ox0001_5000 CPRbase Ox00016000 DIUbase 0x00017000 PSSbase Ox00018000 Reserved Ox0001_9000 to 0x0001_FFFF PCUbase Ox0002 0000 11.6.2 DRAM Region Mapping The embedded DRAM is broken into 8 regions, with each region defined by a lower and upper bound address and with its own access permissions. The association of an area in the DRAM address space with a MMU region is completely under 5 software control. Table 18 below gives one possible region mapping. Regions should be defined according to their access requirements and position in memory. Regions that share the same access requirements and that are contiguous in memory may be combined into a single region. The example below is purely for indicative purposes - real mappings are likely to differ significantly from this. Note that the RegionBottom and RegionTop fields in this example include the DRAM base 10 address offset (0x4000 0000) which is not required when programming the RegionNTop and RegionNBottom registers. For more details, see 11.6.5.1 and 11.6.5.2. Table 18. Example region mapping Region RegionBottom RegionTop Description 0 0x4000_0000 0x4000_0FFF Silverbrook OS (supervisor) data 1 0x4000_1000 0x4000_BFFF Silverbrook OS (supervisor) code 2 0x4000_C000 0x4000_C3FF Silverbrook (supervisor/user) data 3 0x4000_C400 0x4000_CFFF Silverbrook (supervisor/user) code 4 0x4026_D000 0x4026_D3FF OEM (user) data 5 0x4026_D400 0x4026_DFFF OEM (user) code 6 0x4027_E000 0x4027_FFFF Shared Silverbrook/OEM space 7 0x4000_D000 0x4026_CFFF Compressed page store (supervisor data) 11.6.3 Non-DRAM regions 15 As shown in Figure 18 the DRAM occupies only 2.5 MBytes of the total 4 GB SoPEC address space. The non-DRAM regions of SoPEC are handled by the MMU as follows: ROM (0x000_0000 to 0x0000_FFFF): The ROM block will control the access types allowed. The cpuacode[1:0] signals will indicate the CPU mode and access type and the ROM block will assert romcpu_berr if an attempted access is forbidden. The protocol is described in more detail in WO 2004/050369 PCT/AU2003/001616 102 section 11.4.3. The ROM block access permissions are hard wired to allow all read accesses except to the FuseChip/D registers which may only be read in supervisor mode. MMU Internal Registers (OxOO01_0000 to OxOO01lOFFF): The MMU is responsible for controlling the accesses to its own internal registers and will only allow data reads and writes (no instruction 5 fetches) from supervisor data space. All other accesses will result in the mmu cpuberr signal being asserted in accordance with the CPU native bus protocol. CPU Subsystem Peripheral Registers (OxO01_1000 to 0x0001_FFFF): Each peripheral block will control the access types allowed. Every peripheral will allow supervisor data accesses (both read and write) and some blocks (e.g. Timers and GPIO) will also allow user data space accesses as 10 outlined in the relevant chapters of this specification. Neither supervisor nor user instruction fetch accesses are allowed to any block as it is not possible to execute code from peripheral registers. The bus protocol is described in section 11.4.3. PCU Mapped Registers (0x0002_0000 to 0x0002_BFFF): All of the PEP blocks registers which are accessed by the CPU via the PCU will inherit the access permissions of the PCU. These access 15 permissions are hard wired to allow supervisor data accesses only and the protocol used is the same as for the CPU peripherals. Unused address space (0x0002_CO to 0x3FFF_FFFF and 0x4028_0000 to OxFFFFFFFF): All accesses to the unused portion of the address space will result in the mmu_cpuberr signal being asserted in accordance with the CPU native bus protocol. These accesses will not propagate 20 outside of the MMU i.e. no external access will be initiated. 11.6.4 Reset exception vector and reference zero traps When a reset occurs the LEON processor starts executing code from address OxOOOO_0000. A common software bug is zero-referencing or null pointer de-referencing (where the program attempts to access the contents of address OxOOOO_0000). To assist software debug the MMU will 25 assert a bus error every time the locations 0x000_0000 to 0x0000_000F (i.e. the first 4 words of the reset trap) are accessed after the reset trap handler has legitimately been retrieved immediately after reset. 11.6.5 MMU Configuration Registers The MMU configuration registers include the RDU configuration registers and two LEON registers. 30 Note that all the MMU configuration registers may only be accessed when the CPU is running in supervisor mode. Table 19. MMU Configuration Registers Address Register #bits Reset Description offset from MMU base Ox00 RegionOBottom[21:517 OxO000 This register contains the physical address that 0 marks the bottom of region 0 0x04 RegionOTop[21:5] 17 OxFFFF This register contains the physical address that F marks the top of region 0. Region 0 covers the WO 2004/050369 PCT/AU2003/001616 103 entire address space after reset whereas all other regions are zero-sized initially. Ox08 Region1Bottom[21:517 OxF_FFF This register contains the physical address that ] F marks the bottom of region 1 OxOC Region1Top[21:5] 17 OxO_000 This register contains the physical address that 0 marks the top of region 1 Ox10 Region2Bottom[21:517 OxF_FFF This register contains the physical address that ] F marks the bottom of region 2 0x14 Region3Top[21:5] 17 0x0_000 This register contains the physical address that 0 marks the top of region 2 0x18 Region3Bottom[21:517 OxF_FFF This register contains the physical address that I F marks the bottom of region 3 Ox1 C Region3Top[21:5] 17 OxO_000 This register contains the physical address that 0 marks the top of region 3 0x20 Region4Bottom[21:517 OxF_FFF This register contains the physical address that F marks the bottom of region 4 0x24 Region4Top[21:51 17 OxO_000 This register contains the physical address that 0 marks the top of region 4 0x28 Region5Bottom[21:517 OxF_FFF This register contains the physical address that I F marks the bottom of region 5 Ox2C Region5Top[21:5] 17 OxO_000 This register contains the physical address that 0 marks the top of region 5 0x30 Region6Bottom[21:517 OxF_FFF This register contains the physical address that I F marks the bottom of region 6 0x34 Region6Top[21:5] 17 0x0_000 This register contains the physical address that 0 marks the top of region 6 0x38 Region7Bottom[21:517 OxF FFF This register contains the physical address that I F marks the bottom of region 7 Ox3C Region7Top[21:5] 17 OxO_000 This register contains the physical address that 0 marks the top of region 7 0x40 RegionOControl 6 0x07 Control register for region 0 0x44 Region1 Control 6 0x07 Control register for region 1 0x48 Region2Control 6 0x07 Control register for region 2 Ox4C Region3Control 6 0x07 Control register for region 3 Ox50 Region4Control 6 0x07 Control register for region 4 0x54 Region5Control 6 0x07 Control register for region 5 0x58 Region6Control 6 0x07 Control register for region 6 0x5C Region7Control 6 0x07 Control register for region 7 0x60 RegionLock 8 Ox00 Writing a 1 to a bit in the RegionLock register WO 2004/050369 PCT/AU2003/001616 104 locks the value of the corresponding Region Top, RegionBottom and RegionControl regis ters. The lock can only be cleared by a reset and any attempt to write to a locked register will result in a bus error. Ox64 BusTimeout 8 OxFF This register should be set to the number of pcik cycles to wait after an access has started before aborting the access with a bus error. Writing 0 to this register disables the bus time out feature. Ox68 ExceptionSource 6 Ox00 This register identifies the source of the last exception. See Section 11.6.5.3 for details. Ox6C DebugSelect 7 0x00 Contains address of the register selected for debug observation. It is expected that a number of pseudo-registers will be made available for debug observation and these will be outlined during the implementation phase. Ox80 to RDU Registers See Table for details. Ox108 Ox1 40 LEON Configuration 32 0x1 071 The LEON configuration register is used by Register 8 COO software to determine the configuration of this LEON implementation. See section 11.5.1.1 for details. This register is ReadOnly. Ox1 44 LEON Cache 32 Ox00O0_ The LEON Cache Control Register is used to Control Register 0 000 control the operation of the caches. See section 11.6 for details. 11.6.5.1 Region Top and RegionBottom registers The 20 Mbit of embedded DRAM on SoPEC is arranged as 81920 words of 256 bits each. All region boundaries need to align with a 256-bit word. Thus only 17 bits are required for the 5 RegionNTop and RegionNBottom registers. Note that the bottom 5 bits of the RegionNTop and RegionNBottom registers cannot be written to and read as '0' i.e. the RegionNTop and RegionNBottom registers represent byte-aligned DRAM addresses Both the RegionNTop and RegionNBottom registers are inclusive i.e. the addresses in the registers are included in the region. Thus the size of a region is (RegionNTop - RegionNBottom) +1 DRAM 10 words. If DRAM regions overlap (there is no reason for this to be the case but there is nothing to prohibit it either) then only accesses allowed by all overlapping regions are permitted. That is if a DRAM address appears in both Region1 and Region3 (for example) the cpuacode of an access is WO 2004/050369 PCT/AU2003/001616 105 checked against the access permissions of both regions. If both regions permit the access then it will proceed but if either or both regions do not permit the access then it will not be allowed. The MMU does not support negatively sized regions i.e. the value of the RegionNTop register should always be greater than or equal to the value of the RegionNBottom register. If RegionNTop 5 is lower in the address map than RegionNTop then the region is considered to be zero-sized and is ignored. When both the RegionNTop and RegionNBottom registers for a region contain the same value the region is then simply one 256-bit word in length and this corresponds to the smallest possible active region. 10 11.6.5.2 Region Control registers Each memory region has a control register associated with it. The RegionNControl register is used to set the access conditions for the memory region bounded by the RegionNTop and RegionNBottom registers. Table 20 describes the function of each bit field in the RegionNControl registers. All bits in a RegionNControl register are both readable and writable by design. However, 15 like all registers in the MMU, the RegionNControl registers can only be accessed by code running in supervisor mode. Table 20. Region Control Register Field Name bit(s) Description SupervisorAccess 2:0 Denotes the type of access allowed when the CPU is running in Supervisor mode. For each access type a 1 indicates the access is permitted and a 0 indicates the access is not permitted. bitO - Data read access permission bit1 - Data write access permission bit2 - Instruction fetch access permission UserAccess 5:3 Denotes the type of access allowed when the CPU is running in User mode. For each access type a 1 indicates the access is permitted and a 0 indicates the access is not permitted. bit3 - Data read access permission bit4 - Data write access permission bit5 - Instruction fetch access permission 11.6.5.3 ExceptionSource Register 20 The SPARC V8 architecture allows for a number of types of memory access error to be trapped. These trap types and trap handling in general are described in chapter 7 of the SPARC architecture manual [36]. However on the LEON processor only datastoreerror and dataaccessexception trap types will result from an external (to LEON) bus error. According to the SPARC architecture manual the processor will automatically move to the next register window (i.e. it decrements the 25 current window pointer) and copies the program counters (PC and nPC) to two local registers in the WO 2004/050369 PCT/AU2003/001616 106 new window. The supervisor bit in the PSR is also set and the PSR can be saved to another local register by the trap handler (this does not happen automatically in hardware). The ExceptionSource register aids the trap handler by identifying the source of an exception. Each bit in the ExceptionSource register is set when the relevant trap condition and should be cleared by the trap 5 handler by writing a '1' to that bit position. Table 21. ExceptionSource Register Field Name bit(s) Description DramAccessExcptn 0 The permissions of an access did not match those of the DRAM region it was attempting to access. This bit will also be set if an attempt is made to access an undefined DRAM region (i.e. a loca tion that is not within the bounds of any RegionTop/RegionBottom pair) PeriAccessExcptn 1 An access violation occurred when accessing a CPU subsystem block. This occurs when the access permissions disagree with those set by the block. UnusedAreaExcptn 2 An attempt was made to access an unused part of the memory map LockedWriteExcptn 3 An attempt was made to write to a regions registers (RegionTop/ Bottom/Control) after they had been locked. ResetHandlerExcptn 4 An attempt was made to access a ROM location between 0x0000_0000 and 0x0000_000F after the reset handler was exe cuted. The most likely cause of such an access is the use of an uninitialised pointer or structure. imeoutExcptn 5 A bus timeout condition occurred. 11.6.6 MMU Sub-block partition As can be seen from Figure 19 and Figure 20 the MMU consists of three principal sub-blocks. For 10 clarity the connections between these sub-blocks and other SoPEC blocks and between each of the sub-blocks are shown in two separate diagrams. 11.6.6.1 LEON AHB Bridge The LEON AHB bridge consists of an AHB bridge to DIU and an AHB to CPU subsystem bus bridge. The AHB bridge will convert between the AHB and the DIU and CPU subsystem bus 15 protocols but the address decoding and enabling of an access happens elsewhere in the MMU. The AHB bridge will always be a slave on the AHB. Note that the AMBA signals from the LEON core are contained within the ahbso and ahbsi records. The LEON records are described in more detail in section 11.7. Glue logic may be required to assist with enabling memory accesses, endianness coherency, interrupts and other miscellaneous signalling. 20 Table 22. LEON AHB bridge I/Os WO 2004/050369 PCT/AU2003/001616 107 Port name Pins 1/O Description Global SoPEC signals prstn 1 In Global reset. Synchronous to pclk, active low. pclk In Global clock LEON core to LEON AHB signals (ahbsi and ahbso records) ahbsi.haddr[31:0] 32 In AHB address bus ahbsi.hwdata[31:0] 32 In AHB write data bus ahbso.hrdata[31:0] 32 Out AHB read data bus ahbsi.hsel 1 In AHB slave select signal ahbsi.hwrite 1 In AHB write signal: 1 - Write access 0 - Read access ahbsi.htrans 2 In Indicates the type of the current transfer: 00 - IDLE 01 - BUSY 10- NONSEQ 11 -SEQ ahbsi.hsize 3 In Indicates the size of the current transfer: 000 - Byte transfer 001 - Halfword transfer 010 - Word transfer 011 - 64-bit transfer (unsupported?) 1xx - Unsupported larger wordsizes ahbsi.hburst 3 In Indicates if the current transfer forms part of a burst and the type of burst: 000 - SINGLE 001 - INCR 010 - WRAP4 011 - INCR4 100 -WRAP8 101 - INCR8 110 -WRAP16 111 - INCR16 ahbsi.hprot 4 In Protection control signals pertaining to the current access: hprot[0] - Opcode(0) / Data(1) access hprot[1] - User(0) / Supervisor access hprot[2] - Non-bufferable(0) / Bufferable(1) access (unsupported) WO 2004/050369 PCT/AU2003/001616 108 hprot[3] - Non-cacheable(0) / Cacheable access ahbsi.hmaster 4 In Indicates the identity of the current bus master. This will always be the LEON core. ahbsi.hmastlock 1 In Indicates that the current master is performing a locked sequence of transfers. ahbso.hready I Out Active high ready signal indicating the access has completed ahbso.hresp 2 Out Indicates the status of the transfer: 00 - OKAY 01 - ERROR 10 - RETRY 11 - SPLIT ahbso.hsplit[1 5:0] 16 Out This 16-bit split bus is used by a slave to indicate to the arbiter which bus masters should be allowed attempt a split transaction. This feature will be unsupported on the AHB bridge Toplevel/ Common LEON AHB bridge signals cpu dataout[31:0] 32 Out Data out bus to both DRAM and peripheral devices. cpurwn 1 Out Read/NotWrite signal. 1 = Current access is a read access, 0 = Current access is a write access icu_cpu-ilevel[3:0] 4 In An interrupt is asserted by driving the appropriate priority level on icu_cpuievel. These signals must remain asserted until the CPU executes an interrupt acknowledge cycle. cpuicuieve[3:0] 4 In Indicates the level of the interrupt the CPU is acknowledging when cpu iack is high cpu iack 1 Out Interrupt acknowledge signal. The exact timing depends on the CPU core implementation cpu startaccess 1 Out Start Access signal indicating the start of a data transfer and that the cpuadr, cpuidataout, cpurwn and cpuacode signals are all valid. This signal is only asserted during the first cycle of an access. cpuben[1:0] 2 Out Byte enable signals. dram cpu data[255:0] 256 In Read data from the DRAM. diucpurreq 1 Out Read request to the DIU.
WO 2004/050369 PCT/AU2003/001616 109 diucpu rack 1 In Acknowledge from DIU that read request has been accepted. diu-cpu-rvalid 1 In Signal from DIU indicating that valid read data is on the dram cpu data bus cpu-diu_wdatavalid 1 Out Signal from the CPU to the DIU indicating that the data currently on the cpu diuwdata bus is valid and should be committed to the DIU posted write buffer diucpu-write-rdy I In Signal from the DIU indicating that the posted write buffer is empty cpu diu-wdadr[21:41 18 Out Write address bus to the DIU cpu diu-wdata[127:0] 128 Out Write data bus to the DIU cpu-diuwmask[1 5:01 16 Out Write mask for the cpudiu_wdata bus. Each bit corresponds to a byte of the 128-bit cpudiudwdata bus. LEON AHB bridge to MMU Control Block signals cpu-mmuadr 32 Out CPU Address Bus. mmu-cpujdata 32 In Data bus from the MMU mmucpurdy 1 In Ready signal from the MMU cpummuacode 2 Out Access code signals to the MMU mmu-cpuberr 1 In Bus error signal from the MMU dram access en 1 In DRAM access enable signal. A DRAM access cannot be initiated unless it has been enabled by the MMU control unit. Description: The LEON AHB bridge must ensure that all CPU bus transactions are functionally correct and that the timing requirements are met. The AHB bridge also implements a 128-bit DRAM write buffer to improve the efficiency of DRAM writes, particularly for multiple successive writes to DRAM. The 5 AHB bridge is also responsible for ensuring endianness coherency i.e. guaranteeing that the correct data appears in the correct position on the data buses (hrdata, cpu_dataout and cpummu wdata) for every type of access. This is a requirement because the LEON uses big-endian addressing while the rest of SoPEC is little-endian. The LEON AHB bridge will assert request signals to the DIU if the MMU control block deems the 10 access to be a legal access. The validity (i.e. is the CPU running in the correct mode for the address space being accessed) of an access is determined by the contents of the relevant RegionNControl register. As the SPARC standard requires that all accesses are aligned to their word size (i.e. byte, half-word, word or double-word) and so it is not possible for an access to traverse a 256-bit boundary (as required by the DIU). Invalid DRAM accesses are not propagated to 15 the DIU and will result in an error response (ahbso.hresp ='01') on the AHB. The DIU bus protocol WO 2004/050369 PCT/AU2003/001616 110 is described in more detail in section 20.9. The DIU will return a 256-bit dataword on dramcpudata[255:0] for every read access. The CPU subsystem bus protocol is described in section 11.4.3. While the LEON AHB bridge performs the protocol translation between AHB and the CPU subsystem bus the select signals for 5 each block are generated by address decoding in the CPU subsystem bus interface. The CPU subsystem bus interface also selects the correct read data bus, ready and error signals for the block being addressed and passes these to the LEON AHB bridge which puts them on the AHB bus. It is expected that some signals (especially those external to the CPU block) will need to be registered here to meet the timing requirements. Careful thought will be required to ensure that 10 overall CPU access times are not excessively degraded by the use of too many register stages. 11.6.6.1.1 DRAM write buffer The DRAM write buffer improves the efficiency of DRAM writes by aggregating a number of CPU write accesses into a single DIU write access. This is achieved by checking to see if a CPU write is to an address already in the write buffer and if so the write is immediately acknowledged (i.e. the 15 ahbsi.hready signal is asserted without any wait states) and the DRAM write buffer updated accordingly. When the CPU write is to a DRAM address other than that in the write buffer then the current contents of the write buffer are sent to the DIU (where they are placed in the posted write buffer) and the DRAM write buffer is updated with the address and data of the CPU write. The DRAM write buffer consists of a 128-bit data buffer, an 18-bit write address tag and a 16-bit write 20 mask. Each bit of the write mask indicates the validity of the corresponding byte of the write buffer as shown in Figure 21 below. The operation of the DRAM write buffer is summarised by the following set of rules: 1) The DRAM write buffer only contains DRAM write data i.e. peripheral writes go directly to the 25 addressed peripheral. 2) CPU writes to locations within the DRAM write buffer or to an empty write buffer (i.e. the write mask bits are all 0) complete with zero wait states regardless of the size of the write (byte/half word/word/ double-word). 3) The contents of the DRAM write buffer are flushed to DRAM whenever a CPU write to a location 30 outside the write buffer occurs, whenever a CPU read from a location within the write buffer occurs or whenever a write to a peripheral register occurs. 4) A flush resulting from a peripheral write will not cause any extra wait states to be inserted in the peripheral write access. 5) Flushes resulting from a DRAM accesses will cause wait states to be inserted until the DIU 35 posted write buffer is empty. If the DIU posted write buffer is empty at the time the flush is required then no wait states will be inserted for a flush resulting from a CPU write or one wait state will be inserted for a flush resulting from a CPU read (this is to ensure that the DIU sees the write request ahead of the read request). Note that in this case further wait states will also be inserted as a result of the delay in servicing the read request by the DIU. 40 11.6.6.1.2 DIU interface waveforms WO 2004/050369 PCT/AU2003/001616 111 Figure 22 below depicts the operation of the AHB bridge over a sample sequence of DRAM transactions consisting of a read into the DCache, a double-word store to an address other than that currently in the DRAM write buffer followed by an ICache line refill. To avoid clutter a number of AHB control signals that are inputs to the MMU have been grouped together as ahbsi.CONTROL 5 and only the ahbso.HREADY is shown of the output AHB control signals. The first transaction is a single word load ('LD'). The MMU (specifically the MMU control block) uses the first cycle of every access (i.e. the address phase of an AHB transaction) to determine whether or not the access is a legal access. The read request to the DIU is then asserted in the following cycle (assuming the access is a valid one) and is acknowledged by the DIU a cycle later. Note that 10 the time from cpudiurreq being asserted and diucpu rack being asserted is variable as it depends on the DIU configuration and access patterns of DIU requestors. The AHB bridge will insert wait states until it sees the diucpu rvalid signal is high, indicating the data ('LD1') on the dram_ cpudata bus is valid. The AHB bridge terminates the read access in the same cycle by asserting the ahbso.HREADY signal (together with an 'OKAY' HRESP code). The AHB bridge also 15 selects the appropriate 32 bits ('RD1') from the 256-bit DRAM line data ('LD1') returned by the DIU corresponding to the word address given by Al. The second transaction is an AHB two-beat incrementing burst issued by the LEON acache block in response to the execution of a double-word store instruction. As LEON is a big endian processor the address issued ('A2') during the address phase of the first beat of this transaction is the address 20 of the most significant word of the double-word while the address for the second beat ('A3') is that of the least significant word i.e. A3 = A2 +4. The presence of the DRAM write buffer allows these writes to complete without the insertion of any wait states. This is true even when, as shown here, the DRAM write buffer needs to be flushed into the DIU posted write buffer, provided the DIU posted write buffer is empty. If the DIU posted write buffer is not empty (as would be signified by 25 diu cpuwriterdy being low) then wait states would be inserted until it became empty. The cpudiu_wdata buffer builds up the data to be written to the DIU over a number of transactions ('BDI' and 'BD2' here) while the cpu diuwmask records every byte that has been written to since the last flush - in this case the lowest word and then the second lowest word are written to as a result of the double-word store operation. 30 The final transaction shown here is a DRAM read caused by an ICache miss. Note that the pipelined nature of the AHB bus allows the address phase of this transaction to overlap with the final data phase of the previous transaction. All ICache misses appear as single word loads ('LD') on the AHB bus. In this case we can see that the DIU is slower to respond to this read request than to the first read request because it is processing the write access caused by the DRAM write buffer 35 flush. The ICache refill will complete just after the window shown in Figure 22. 11.6.6.2 CPU Subsystem Bus Interface The CPU Subsystem Interface block handles all valid accesses to the peripheral blocks that comprise the CPU Subsystem. Table 23. CPU Subsystem Bus Interface I/Os 40 WO 2004/050369 PCT/AU2003/001616 112 Port name Pins I/O Description Global SoPEC signals prstn I n 'Global reset. Synchronous to pck, active low. pclk 1 In Global clock Toplevel/Common CPU Subsystem Bus Interface signals cpu-cprsel 1 Out CPR block select. cpugpio-sel 1 Out GPIO block select. cpu icusel 1 Out ICU block select. cpulsssel 1 Out LSS block select. cpupcu-sel 1 Out PCU block select. cpu sob_sel I Out SCB block select. cpu-timsel I Out Timers block select. cpu-romsel 1 Out ROM block select. cpu_pss-sel 1 Out PSS block select. cpu-diusel 1 Out DIU block select., cprcpudata[31:0] 32 in Read data bus from the CPR block gpio-cpu-data[31:0] 32 in Read data bus from the GPIO block icu_cpu data[31:0] 32 In Read data bus from the ICU block Iss cpu data[31:01 32 In Read data bus from the LSS block pcu-cpu-data[31:0] 32 In Read data bus from the PCU block scbcpu data[31:0] 32 In Read data bus from the SCB block tim_cpu data[31:0] 32 In Read data bus from the Timers block romcpu data[31:0] 32 In Read data bus from the ROM block pss-cpu-data[31:0] 32 In Read data bus from the PSS block diucpu data[31:0] 32 In Read data bus from the DIU block cprcpurdy 1 In Ready signal to the CPU. When cprcpu rdy is high it indicates the last cycle of the access. For a write cycle this means cpudataout has been registered by the CPR block and for a read cycle this means the data on cprcpu data is valid. gpiocpurdy 1 In GPIO ready signal to the CPU. icu_cpu rdy 1 In ICU ready signal to the CPU. Isscpurdy 1 In LSS ready signal to the CPU. pcucpu-rdy 1 In PCU ready signal to the CPU. sob_cpu-rdy 1 In SCB ready signal to the CPU. timcpurdy 1 In Timers block ready signal to the CPU. romcpu-rdy 1 In ROM block ready signal to the CPU. pss-cpu-rdy 1 In. PSS block ready signal to the CPU.
WO 2004/050369 PCT/AU2003/001616 113 diucpu-rdy 1 In DIU register block ready signal to the CPU. cprcpuberr 1 In Bus Error signal from the CPR block gpio-cpuberr 1 In Bus Error signal from the GPIO block icucpuberr 1 In Bus Error signal from the ICU block Isscpuberr 1 In Bus Error signal from the LSS block pcucpuberr 1 In Bus Error signal from the PCU block scbcpu berr 1 In Bus Error signal from the SCB block timcpu-berr 1 In Bus Error signal from the Timers block rom_cpuberr 1 In Bus Error signal from the ROM block pss cpuberr 1 In Bus Error signal from the PSS block diucpu-berr I In Bus Error signal from the DIU block CPU Subsystem Bus Interface to MMU Control Block signals cpuadr[l 9:12] 8 In Toplevel CPU Address bus. Only bits 19-12 are required to decode the peripherals address space periaccessen 1 In Enable Access signal. A peripheral access cannot be initiated unless it has been enabled by the MMU Control Unit perimmu-data[31:0] 32 Out Data bus from the selected peripheral peri-mmu-rdy 1 Out Data Ready signal. Indicates the data on the perimmudata bus is valid for a read cycle or that the data was successfully written to the peripheral for a write cycle. peri-mmuberr 1 Out Bus Error signal. Indicates a bus error has occurred in accessing the selected peripheral CPU Subsystem Bus Interface to LEON AHB bridge signals cpu startaccess 1 In Start Access signal from the LEON AHB bridge indicating the start of a data transfer and that the cpuadr, cpu dataout, cpu rwn and cpuacode signals are all valid. This signal is only asserted during the first cycle of an access. Description: The CPU Subsystem Bus Interface block performs simple address decoding to select a peripheral and multiplexing of the returned signals from the various peripheral blocks. The base addresses used for the decode operation are defined in Table . Note that access to the MMU configuration 5 registers are handled by the MMU Control Block rather than the CPU Subsystem Bus Interface block. The CPU Subsystem Bus Interface block operation is described by the following pseudocode: maskedcpuadr = cpuadr [17:12] WO 2004/050369 PCT/AU2003/001616 114 case (masked-cpu_adr) when TIM base [17:12] cputimsel = peri_access_en // The periaccessen signal will have the 5 perimmu data = tim cpu data // timing required for block selects perimmurdy = tim-cpurdy perimmuberr = timcpu berr allotherselects = 0 // Shorthand to ensure other 10 cpu_block-sel signals // remain deasserted when LSS base [17:12] cpulsssel = peri_access_en peri _mmudata = lsscpu data 15 peri _mmurdy = iss_cpurdy peri-mmu-berr = lss_cpu berr all other-selects = 0 when GPIO base[17:12] cpugpio-sel = peri_access_en 20 peri _mmudata = gpiocpu data peri-mmu rdy = gpio-cpu rdy perimmu berr = gpio cpu berr all other selects = 0 when SCB base[17:12] 25 cpu_scb_sel = periaccess_en peri-mmu-data = scbcpu data peri-mmu-rdy = scb_cpu-rdy perimmuberr = scbcpuberr all other selects = 0 30 when ICU base[17:12] cpu-icu-sel = peri_accessen perimmudata = icu cpudata peri mmu-rdy = icu-cpurdy peri _mmuberr = icu cpuberr 35 all otherselects = 0 when CPR-base [17:12] cpucprsel = peri_access_en perimmudata = cpr cpudata peri-mmurdy = cpr_cpurdy 40 perimmuberr = cpr cpu-berr all other selects = 0 WO 2004/050369 PCT/AU2003/001616 115 when ROM base[17:12] cpuromsel = periaccess_en perimmudata = rom cpudata peri mmu-rdy = romcpurdy 5 perimmuberr = rom-cpu berr all other selects = 0 when PSS base[17:12] cpu-pss-sel = peri_access_en peri _mmudata = psscpu data 10 peri mmurdy = psscpurdy peri-mmu-berr = psscpuberr all other-selects = 0 when DIU base [17:12] cpu_diu_sel = peri accessen 15 peri_mmu_data = diu cpudata peri-mmu-rdy = diu cpu-rdy perimmu_berr = diucpuberr all other-selects = 0 when PCU base [17:12] 20 Cpupcu-sel = peri_accessen perimmu data = pcu cpudata peri-mmu-rdy = pcu-cpurdy perimmuberr = pcucpu-berr all other selects = 0 25 when others all block selects = 0 perimmudata = 0x00000000 peri-mmu-rdy = 0 peri _mmuberr = 1 30 end case 11.6.6.3 MMU Control Block The MMU Control Block determines whether every CPU access is a valid access. No more than one cycle is to be consumed in determining the validity of an access and all accesses must terminate with the assertion of either mmu cpujrdy or mmucpu berr. To safeguard against 35 stalling the CPU a simple bus timeout mechanism will be supported. Table 24. MMU Control Block I/Os Port name Pins i/O Description Global SoPEC signals prstn 1 In Global reset. Synchronous to pck, active low.
WO 2004/050369 PCT/AU2003/001616 116 pclk 1 In Global clock Toplevel/Common MMU Control Block signals cpu adr[21:2] 22 Out Address bus for both DRAM and peripheral access. cpu acode[1:0] 2 Out CPU access code signals (cpu._mmu acode) retimed to meet the CPU Subsystem Bus timing requirements dramaccessen 1 Out DRAM Access Enable signal. Indicates that the current CPU access is a valid DRAM access. MMU Control Block to LEON AHB bridge signals cpummu-adr[31:0] 32 In CPU core address bus. cpu dataout[31:0] 32 In Toplevel CPU data bus mmucpudata[31:0] 32 Out Data bus to the CPU core. Carries the data for all CPU read operations cpu_rwn 1 In Toplevel CPU Read/notWrite signal. cpummu-acode[1:0] 2 In CPU access code signals mmu cpurdy 1 Out Ready signal to the CPU core. Indicates the completion of all valid CPU accesses. mmucpuberr 1 Out Bus Error signal to the CPU core. This signal is asserted to terminate an invalid access. cpu startaccess 1 In Start Access signal from the LEON AHB bridge indicating the start of a data transfer and that the cpuadr, cpu_dataout, cpurwn and cpuacode signals are all valid. This signal is only asserted during the first cycle of an access. cpu_iack 1 In Interrupt Acknowledge signal from the CPU. This signal is only asserted during an interrupt acknowledge cycle. cpuben[1:0] 2 In Byte enable signals indicating which bytes of the 32 bit bus are being accessed. MMU Control Block to CPU Subsystem Bus Interface signals cpuadr[17:12] 8 Out Toplevel CPU Address bus. Only bits 17-12 are required to decode the peripherals address space peri-access-en 1 Out Enable Access signal. A peripheral access cannot be initiated unless it has been enabled by the MMU Control Unit perimmu-data[31:0] 32 In Data bus from the selected peripheral peri-mmu-rdy I In Data Ready signal. Indicates the data on the per!_mmudata bus is valid for a read cycle or that the data was successfully written to the peripheral for a write cycle.
WO 2004/050369 PCT/AU2003/001616 117 peri-mmuberr 1 In Bus Error signal. Indicates a bus error has occurred in accessing the selected peripheral Description: The MMU Control Block is responsible for the MMU's core functionality, namely determining whether or not an access to any part of the address map is valid. An access is considered valid if it is to a mapped area of the address space and if the CPU is running in the appropriate mode for that 5 address space. Furthermore the MMU control block must correctly handle the special cases that are: an interrupt acknowledge cycle, a reset exception vector fetch, an access that crosses a 256 bit DRAM word boundary and a bus timeout condition. The following pseudocode shows the logic required to implement the MMU Control Block functionality. It does not deal with the timing relationships of the various signals - it is the designer's responsibility to ensure that these 10 relationships are correct and comply with the different bus protocols. For simplicity the pseudocode is split up into numbered sections so that the functionality may be seen more easily. It is important to note that the style used for the pseudocode will differ from the actual coding style used in the RTL implementation. The pseudocode is only intended to capture the required functionality, to clearly show the criteria that need to be tested rather than to describe how the 15 implementation should be performed. In particular the different comparisons of the address used to determine which part of the memory map, which DRAM region (if applicable) and the permission checking should all be performed in parallel (with results ORed together where appropriate) rather than sequentially as the pseudocode implies. PSO Description: This first segment of code defines a number of constants and variables that are 20 used elsewhere in this description. Most signals have been defined in the 1/O descriptions of the MMU sub-blocks that precede this section of the document. The post reset state variable is used later (in section PS4) to determine if we should trap a null pointer access. PSO: 25 const UnusedBottom = OxOO2ACOOO const DRAMTop = Ox4O27FFFF const UserDataSpace = bOl const UserProgramSpace = bOO const SupervisorDataSpace = bil 30 const SupervisorProgramSpace = b1O const ResetExceptionCycles = 0x2 cpuadrperimasked[5:0] = cpu mmuadr[17:12] cpuadrdram_masked[16:0] cpummu_adr & OxOO3FFFEO 35 if (prst-n == 0) then // Initialise everything cpu-adr = cpummu_adr [21:2] periaccessen = 0 WO 2004/050369 PCT/AU2003/001616 118 dram access en = 0 mmucpu data = perimmu data mmu~cpurdy = 0 mmu_cpu-berr = 0 5 postresetstate = TRUE access initiated = FALSE cpu accesscnt = 0 // The following is used to determine if we are coming out 10 of reset for the purposes of // reset exception vector redirection. There may be a convenient signal in the CPU core // that we could use instead of this. if ((cpustart_access 1) AND (cpu accesscnt < 15 ResetExceptionCycles) AND (clock tick == TRUE)) then cpuaccesscnt = cpuaccesscnt +1 else postresetstate = FALSE 20 PS1 Description: This section is at the top of the hierarchy that determines the validity of an access. The address is tested to see which macro-region (i.e. Unused, CPU Subsystem or DRAM) it falls into or whether the reset exception vector is being accessed. 25 PS1: if (cpu-mmu adr >= UnusedBottom) then // The access is to an invalid area of the address space. See section PS2 30 elsif ((cpu mmuadr > DRAMTop) AND (cpu mmu adr < UnusedBottom)) then // We are in the CPU Subsystem/PEP Subsystem address space. See section PS3 35 // Only remaining possibility is an access to DRAM address space // First we need to intercept the special case for the reset exception vector 40 elsif (cpummu adr < ox0000ooo) then // The reset exception is being accessed. See section PS4 WO 2004/050369 PCT/AU2003/001616 119 elsif ((cpuadr dram masked >= RegionoBottom) AND (cpuadr-dram masked <= RegionOTop) ) then 5 // We are in RegionO. See section P5 elsif ((cpu adrdrammasked >= RegionNBottom) AND (cpuadr-drammasked <= RegionNTop) ) then // we are in RegionN 10 // Repeat the RegionO (i.e. section PS5) logic for each of Regioni to Region7 else // We could end up here if there were gaps in the DRAM regions 15 peri_accessen = 0 dram access-en = 0 mmucpu berr = 1 // we have an unknown access error, most likely due to hitting mmu_cpu rdy = 0 // a gap in the DRAM regions 20 // Only thing remaining is to implement a bus timeout function. This is done in PS6 end 25 PS2 Description: Accesses to the large unused area of the address space are trapped by this section. No bus transactions are initiated and the mmu cpuberr signal is asserted. PS2: elsif (cpummuadr >= UnusedBottom) then 30 periaccess_en = 0 // The access is to an invalid area of the address space dram access-en = 0 mmu_cpu-berr = 1 mmu_cpurdy = 0 35 PS3 Description: This section deals with accesses to CPU Subsystem peripherals, including the MMU itself. If the MMU registers are being accessed then no external bus transactions are required. Access to the MMU registers is only permitted if the CPU is making a data access from supervisor mode, otherwise a bus error is asserted and the access terminated. For non-MMU accesses then 40 transactions occur over the CPU Subsystem Bus and each peripheral is responsible for determining whether or not the CPU is in the correct mode (based on the cpu acode signals) to be permitted WO 2004/050369 PCT/AU2003/001616 120 access to its registers. Note that all of the PEP registers are accessed via the PCU which is on the CPU Subsystem Bus. PS3: 5 elsif ((cpu mmuadr > DRAMTop) AND (cpu-mmu adr < UnusedBottom)) then // We are in the CPU Subsystem/PEP Subsystem address space 10 cpuadr = cpu-mmuadr[21:2 if (cpuadrperi masked == MMUbase) then // access is to local registers peri accessen = 0 dramaccess en = 0 15 if (cpuacode == SupervisorDataSpace) then for (i=0; i<26; i++) { if ((i == cpummu_adr[6:2] ) then // selects the addressed register if (cpu rwn == 1) then 20 mmu-cpudata[16:0] = MMUReg[i] // MMUReg[i] is one of the mmu cpurdy = 1 // registers in Table mmucpuberr = 0 25 else // write cycle MMUReg[i] = cpu-dataout[16:0] mmucpu~rdy = 1 mmucpuberr = 0 else // there is no register mapped to this 30 address mmu-cpuberr =1 / do we really want a bus-error here as registers mmucpurdy = 0 // are just mirrored in other blocks 35 else // we have an access violation mmu_cpu_berr = 1 mmu_cpu_rdy = 0 40 else // access is to something else on the CPU Subsystem Bus WO 2004/050369 PCT/AU2003/001616 121 periaccess en = 1 dram access-en = 0 mmucpu data = perimmudata mmucpurdy = perimmu-rdy 5 mmu-cpuberr = perimmu_berr PS4 Description: The only correct accesses to the locations beneath 0x00000010 are fetches of the reset trap handling routine and these should be the first accesses after reset. Here we trap all other accesses to these locations regardless of the CPU mode. The most likely cause of such an access will be the use of a null 10 pointer in the program executing on the CPU. PS4: elsif (cpummu adr < OxO0000olo) then if (post reset state == TRUE)) then 15 cpuadr = Cpu_mmuadr21:2j peri_access_en = 1 dram access-en = 0 mmucpudata = perimmu data mmucpu rdy = perimmurdy 20 mmu-cpuberr = perimmuberr else // we have a problem (almost certainly a null pointer) periaccessen = 0 dram access-en = 0 25 mmu-cpuberr = 1 mmucpurdy = 0 PS5 Description: This large section of pseudocode simply checks whether the access is within the bounds of DRAM RegionO and if so whether or not the access is of a type permitted by the 30 RegionOControl register. If the access is permitted then a DRAM access is initiated. If the access is not of a type permitted by the RegionoControl register then the access is terminated with a bus error. PS5: 35 elsif ((cpuadr dram masked >= RegionOBottom) AND (cpuadr-drammasked <= RegionOTop) ) then // we are in Regiono cpuadr = cpummuadr[21:21 40 if (cpurwn == 1) then WO 2004/050369 PCT/AU2003/001616 122 if ((cpu_acode == SupervisorProgramSpace AND RegionOControl[2] == 1)) OR (cpu-acode == UserProgramSpace AND RegionOControl[5] == 1)) then 5 // this is a valid instruction fetch from Regiono // The dram-cpudata bus goes directly to the LEON // AHB bridge which also handles 10 the hready generation periaccess en = 0 dram access-en = 1 mmu-cpuberr = 0 15 elsif ( (cpu acode == SupervisorDataSpace AND RegionOControl[0] == 1) OR (cpu acode == UserDataSpace AND RegionOControl[3] == 1)) then // this is a valid 20 read access from Regiono peri access en = 0 dram access-en = 1 mmucpuberr = 0 25 else // we have an access violation periaccess en = 0 dram access-en = 0 mmucpuberr = 1 30 mmu-cpu-rdy = 0 else // it is a write access if ((cpuacode == SupervisorDataSpace AND RegionOControl[l] == 1) 35 OR (cpu-acode == UserDataSpace AND RegionOControl[4] == 1)) then // this is a valid write access to Regiono peri _accessen = 0 40 dram access en = 1 mmucpuberr = 0 WO 2004/050369 PCT/AU2003/001616 123 else // we have an access violation periaccessen = 0 dram access en = 0 5 mmu-cpuberr = 1 mmu cpurdy = 0 PS6 Description: This final section of pseudocode deals with the special case of a bus timeout. This occurs when an access has been initiated but has not completed before the BusTimeout number of 10 pc/k cycles. While access to both DRAM and CPU/PEP Subsystem registers will take a variable number of cycles (due to DRAM traffic, PCU command execution or the different timing required to access registers in imported IP) each access should complete before a timeout occurs. Therefore it should not be possible to stall the CPU by locking either the CPU Subsystem or DIU buses. However given the fatal effect such a stall would have it is considered prudent to implement bus 15 timeout detection. PS6: // Only thing remaining is to implement a bus timeout function. 20 if ((cpustartaccess == 1) then access-initiated = TRUE timeout countdown BusTimeout 25 if ((mmu-cpurdy == 1 ) OR (mmucpu berry ==1 )) then access initiated = FALSE peri_access_en = 0 dram access en = 0 30 if ((clock tick == TRUE) AND (accessinitiated == TRUE) AND (BusTimeout != 0)) if (timeout countdown > 0) then timeout countdownelse // timeout has occurred 35 peri_access_en = 0 // abort the access dram access en = 0 mmucpuberr = 1 mmucpurdy = 0 11.7 LEON CACHES 40 The version of LEON implemented on SoPEC features 1 kB of ICache and I kB of DCache. Both caches are direct mapped and feature 8 word lines so their data RAMs are arranged as 32 x 256-bit WO 2004/050369 PCT/AU2003/001616 124 and their tag RAMs as 32 x 30-bit (itag) or 32 x 32-bit (dtag). Like most of the rest of the LEON code used on SoPEC the cache controllers are taken from the leon2-1.0.7 release. The LEON cache controllers and cache RAMs have been modified to ensure that an entire 256-bit line is refilled at a time to make maximum use out of the memory bandwidth offered by the embedded DRAM 5 organization (DRAM lines are also 256-bit). The data cache controller has also been modified to ensure that user mode code cannot access the DCache contents unless it is authorised to do so. A block diagram of the LEON CPU core as implemented on SoPEC is shown in Figure 23 below. In this diagram dotted lines are used to indicate hierarchy and red items represent signals or wrappers added as part of the SoPEC modifications. LEON makes heavy use of VHDL records and 10 the records used in the CPU core are described in Table 25. Unless otherwise stated the records are defined in the iface.vhd file (part of the LEON release) and this should be consulted for a complete breakdown of the record elements. Table 25. Relevant LEON records Record Name Description rfi Register File Input record. Contains address, datain and control signals for the register file. rfo Register File Output record. Contains the data out of the dual read port register file. ici Instruction Cache In record. Contains program counters from different stages of the pipeline and various control signals ico Instruction Cache Out record. Contains the fetched instruction data and various control signals. This record is also sent to the DCache (i.e. icol) so that diagnostic accesses (e.g. Ida/sta) can be serviced. dci Data Cache In record. Contains address and data buses from different stages of the pipeline (execute & memory) and various control signals dco Data Cache Out record. Contains the data retrieved from either memory or the caches and various control signals. This record is also sent to the ICache (i.e. dcol) so that diagnostic accesses (e.g. Ida/sta) can be serviced. iui Integer Unit In record. This record contains the interrupt request level and a record for use with LEONs Debug Support Unit (DSU) iuo Integer Unit Out record. This record contains the acknowledged interrupt request level with control signals and a record for use with LEONs Debug Support Unit (DSU) mcii Memory to Cache Icache In record. Contains the address of an Icache miss and various control signals mcio Memory to Cache Icache Out record. Contains the returned data from memory and various control signals mcdi Memory to Cache Dcache In record. Contains the address and data of a WO 2004/050369 PCT/AU2003/001616 125 Dcache miss or write and various control signals mcdo Memory to Cache Dcache Out record. Contains the returned data from memory and various control signals ahbi AHB In record. This is the input record for an AHB master and contains the data bus and AHB control signals. The destination for the signals in this record is the AHB controller. This record is defined in the amba.vhd file ahbo AHB Out record. This is the output record for an AHB master and contains the address and data buses and AHB control signals. The AHB controller drives the signals in this record. This record is defined in the amba.vhd file ahbsi AHB Slave In record. This is the input record for an AHB slave and contains the address and data buses and AHB control signals. It is used by the DCache to facilitate cache snooping (this feature is not enabled in SoPEC). This record is defined in the amba.vhd file crami Cache RAM In record. This record is composed of records of records which contain the address, data and tag entries with associated control signals for both the ICache RAM and DCache RAM cramo Cache RAM Out record. This record is composed of records of records which contain the data and tag entries with associated control signals for both the ICache RAM and DCache RAM ilinerdy Control signal from the ICache controller to the instruction cache memory. This signal is active (high) when a full 256-bit line (on dram cpu data) is to be written to cache memory. dline-rdy Control signal from the DCache controller to the data cache memory. This signal is active (high) when a full 256-bit line (on dram cpu-data) is to be written to cache memory. dram cpu data 256-bit data bus from the embedded DRAM 11.7.1 Cache controllers The LEON cache module consists of three components: the ICache controller (icache.vhd), the DCache controller (dcache.vhd) and the AHB bridge (acache.vhd) which translates all cache misses into memory requests on the AHB bus. 5 In order to enable full line refill operation a few changes had to be made to the cache controllers. The ICache controller was modified to ensure that whenever a location in the cache was updated (i.e. the cache was enabled and was being refilled from DRAM) all locations on that cache line had their valid bits set to reflect the fact that the full line was updated. The iine_rdy signal is asserted by the ICache controller when this happens and this informs the cache wrappers to update all locations 10 in the data RAM for that line. A similar change was made to the DCache controller except that the entire line was only updated following a read miss and that existing write through operation was preserved. The DCache controller uses the dine_rdy signal to instruct the cache wrapper to update all locations in the ddata RAM for a line. An additional modification was also made to ensure that a double-word load WO 2004/050369 PCT/AU2003/001616 126 instruction from a non-cached location would only result in one read access to the DIU i.e. the second read would be serviced by the data cache. Note that if the DCache is turned off then a double-word load instruction will cause two DIU read accesses to occur even though they will both be to the same 256-bit DRAM line. 5 The DCache controller was further modified to ensure that user mode code cannot access cached data to which it does not have permission (as determined by the relevant RegionNControl register settings at the time the cache line was loaded). This required an extra 2 bits of tag information to record the user read and write permissions for each cache line. These user access permissions can be updated in the same manner as the other tag fields (i.e. address and valid bits) namely by line 10 refill, STA instruction or cache flush. The user access permission bits are checked every time user code attempts to access the data cache and if the permissions of the access do not agree with the permissions returned from the tag RAM then a cache miss occurs. As the MMU evaluates the access permissions for every cache miss it will generate the appropriate exception for the forced cache miss caused by the errant user code. In the case of a prohibited read access the trap will be 15 immediate while a prohibited write access will result in a deferred trap. The deferred trap results from the fact that the prohibited write is committed to a write buffer in the DCache controller and program execution continues until the prohibited write is detected by the MMU which may be several cycles later. Because the errant write was treated as a write miss by the DCache controller (as it did not match the stored user access permissions) the cache contents were not updated and 20 so remain coherent with the DRAM contents (which do not get updated because the MMU intercepted the prohibited write). Supervisor mode code is not subject to such checks and so has free access to the contents of the data cache. In addition to AHB bridging, the ACache component also performs arbitration between ICache and DCache misses when simultaneous misses occur (the DCache always wins) and implements the 25 Cache Control Register (CCR). The leon2-1.0.7 release is inconsistent in how it handles cacheability: For instruction fetches the cacheability (i.e. is the access to an area of memory that is cacheable) is determined by the ICache controller while the ACache determines whether or not a data access is cacheable. To further complicate matters the DCache controller does determine if an access resulting from a cache snoop by another AHB master is cacheable (Note that the SoPEC 30 ASIC does not implement cache snooping as it has no need to do so). This inconsistency has been cleaned up in more recent LEON releases but Is preserved here to minimise the number of changes to the LEON RTL. The cache controllers were modified to ensure that only DRAM accesses (as defined by the SoPEC memory map) are cached. The only functionality removed as a result of the modifications was support for burst fills of the 35 ICache. When enabled burst fills would refill an ICache line from the location where a miss occurred up to the end of the line. As the entire line is now refilled at once (when executing from DRAM) this functionality is no longer required. Furthermore more substantial modifications to the ICache controller would be needed if we wished to preserve this function without adversely affecting full line refills. The CCR was therefore modified to ensure that the instruction burst fetch bit (bitl 6) was tied 40 low and could not be written to.
WO 2004/050369 PCT/AU2003/001616 127 11.7.1.1 LEON Cache Control Register The CCR controls the operation of both the I and D caches. Note that the bitfields used on the SoPEC implementation of this register are based on the LEON v1.0.7 implementation and some bits have their values tied off. See section 4 of the LEON manual for a description of the LEON 5 cache controllers. Table 26. LEON Cache Control Register Field Name bit(s) Description ICS 1:0 Instruction cache state: 00 - disabled 01 -frozen 10 - disabled 11 - enabled Reserved 13:6 Reserved. Reads as 0. DCS 3:2 Data cache state: 00 - disabled 01 -frozen 10 - disabled 11 - enabled IF 4 ICache freeze on interrupt 0 - Do not freeze the ICache contents on taking an interrupt 1 - Freeze the ICache contents on taking an interrupt DF 5 DCache freeze on interrupt 0 - Do not freeze the DCache contents on taking an interrupt 1 - Freeze the DCache contents on taking an interrupt Reserved 13:6 Reserved. Reads as 0. DP 14 Data cache flush pending. 0 - No DCache flush in progress 1 - DCache flush in progress This bit is ReadOnly. IP 15 Instruction cache flush pending. 0 - No lCache flush in progress 1 - lCache flush in progress This bit is ReadOnly. IB 16 Instruction burst fetch enable. This bit is tied low on SoPEC because it would interfere with the operation of the cache wrappers. Burst refill functionality is automatically provided in SoPEC by the cache wrappers. Reserved 20:17 Reserved. Reads as 0.
WO 2004/050369 PCT/AU2003/001616 128 FI 21 Flush instruction cache. Writing a 1 this bit will flush the ICache. Reads as 0. FD 22 Flush data cache. Writing a 1 this bit will flush the DCache. Reads as 0. DS 23 Data cache snoop enable. This bit is tied low in SoPEC as there is no requirement to snoop the data cache. Reserved 31:24 Reserved. Reads as 0. 11.7.2 Cache wrappers The cache RAMs used in the leon2-1.0.7 release needed to be modified to support full line refills and the correct IBM macros also needed to be instantiated. Although they are described as RAMs throughout this document (for consistency), register arrays are actually used to implement the 5 cache RAMs. This is because IBM SRAMs were not available in suitable configurations (offered configurations were too big) to implement either the tag or data cache RAMs. Both instruction and data tag RAMs are implemented using dual port (1 Read & 1 Write) register arrays and the clocked write-through versions of the register arrays were used as they most closely approximate the single port SRAM LEON expects to see. 10 11.7.2.1 Cache Tag RAM wrappers The itag and dtag RAMs differ only in their width - the itag is a 32x30 array while the dtag is a 32x32 array with the extra 2 bits being used to record the user access permissions for each line. When read using a LDA instruction both tags return 32-bit words. The tag fields are described in Table 27 and Table 28 below. Using the IBM naming conventions the register arrays used for the tag RAMs 15 are called RA032X30D2P2W1 R1M3 for the itag and RA032X32D2P2W1 R1 M3 for the dtag. The ibm syncram wrapper used for the tag RAMs is a simple affair that just maps the wrapper ports on to the appropriate ports of the IBM register array and ensures the output data has the correct timing by registering it. The tag RAMs do not require any special modifications to handle full line refills. Table 27. LEON Instruction Cache Tag 20 Field Name bit(s) Description Valid 7:0 Each valid bit indicates whether or not the corresponding word of the cache line contains valid data Reserved 9:8 Reserved - these bits do not exist in the itag RAM. Reads as 0. Address 31:10 The tag address of the cache line Table 28. LEON Data Cache Tag Field Name bit(s) Description Valid 7:0 Each valid bit indicates whether or not the corresponding word of the cache line contains valid data WO 2004/050369 PCT/AU2003/001616 129 URP 8 User read permission. 0 - User mode reads will force a refill of this line 1 - User mode code can read from this cache line. UWP 9 User write permission. 0 - User mode writes will not be written to the cache 1 - User mode code can write to this cache line. Address 31:10 he tag address of the cache line 11.7.2.2 Cache Data RAM wrappers The cache data RAM contains the actual cached data and nothing else. Both the instruction and data cache data RAMs are implemented using 8 32x32-bit register arrays and some additional logic to support full line refills. Using the IBM naming conventions the register arrays used for the tag 5 RAMs are called RA032X32D2P2W1 R1 M3. The ibmcdram_wrap wrapper used for the tag RAMs is shown in Figure 24 below. To the cache controllers the cache data RAM wrapper looks like a 256x32 single port SRAM (which is what they expect to see) with an input to indicate when a full line refill is taking place (the linerdy signal). Internally the 8-bit address bus is split into a 5-bit lineaddress, which selects one of the 32 10 256-bit cache lines, and a 3-bit wordaddress which selects one of the 8 32-bit words on the cache line. Thus each of the 8 32x32 register arrays contains one 32-bit word of each cache line. When a full line is being refilled (indicated by both the linerdy and write signals being high) every register array is written to with the appropriate 32 bits from the linedatain bus which contains the 256-bit line returned by the DIU after a cache miss. When just one word of the cache line is to be written 15 (indicated by the write signal being high while the line rdy is low) then the wordaddress is used to enable the write signal to the selected register array only - all other write enable signals are kept low. The data cache controller handles byte and half-word write by means of a read-modify-write operation so writes to the cache data RAM are always 32-bit. The wordaddress is also used to select the correct 32-bit word from the cache line to return to the 20 LEON integer unit. 11.8 REALTIME DEBUG UNIT (RDU) The RDU facilitates the observation of the contents of most of the CPU addressable registers in the SoPEC device in addition to some pseudo-registers in realtime. The contents of pseudo-registers, i.e. registers that are collections of otherwise unobservable signals and that do not affect the 25 functionality of a circuit, are defined in each block as required. Many blocks do not have pseudo registers and some blocks (e.g. ROM, PSS) do not make debug information available to the RDU as it would be of little value in realtime debug. Each block that supports realtime debug observation features a DebugSelect register that controls a local mux to determine which register is output on the block's data bus (i.e. block cpudata). One 30 small drawback with reusing the blocks data bus is that the debug data cannot be present on the same bus during a CPU read from the block. An accompanying active high block cpu debug valid signal is used to indicate when the data bus contains valid debug data and when the bus is being WO 2004/050369 PCT/AU2003/001616 130 used by the CPU. There is no arbitration for the bus as the CPU will always have access when required. A block diagram of the RDU is shown in Figure 25. Table 29. RDU 1IOs Port name Pins 1/O Description diucpu data 32 In Read data bus from the DIU block cprcpu data 32 In Read data bus from the CPR block gpio-cpu data 32 In Read data bus from the GPIO block icucpu data 32 In Read data bus from the ICU block Iss cpu data 32 In Read data bus from the LSS block pcu cpu debug_data 32 In Read data bus from the PCU block scbcpu data 32 In Read data bus from the SCB block tim_cpudata 32 In Read data bus from the TIM block diucpu debugvalid 1 In Signal indicating the data on the diu cpu data bus is valid debug data. im cpu debugvalid 1 In Signal indicating the data on the tim cpu data bus is valid debug data. scbcpu debugvalid 1 In Signal indicating the data on the scb cpu data bus is valid debug data. pcu cpu debugvalid 1 In Signal indicating the data on the pcucpu data bus is valid debug data. Isscpu debugvalid 1 In Signal indicating the data on the Iss cpu data bus is valid debug data. icu_cpu debugvalid 1 In Signal indicating the data on the icu cpudata bus is valid debug data. gpio-cpu debug_valid 1 In Signal indicating the data on the gpio cpudata bus is valid debug data. cprcpu debugvalid 1 In Signal indicating the data on the cprcpudata bus is valid debug data. debugdata out 32 Out Output debug data to be muxed on to the PHI/GPIO/other pins debugdata valid I Out Debug valid signal indicating the validity of the data on debug data_out. This signal is used in all debug configurations debugcntrl 33 Out Control signal for each debug data line indicating whether or not the debug data should be selected by the pin mux 5 WO 2004/050369 PCT/AU2003/001616 131 As there are no spare pins that can be used to output the debug data to an external capture device some of the existing i/Os will have a debug multiplexer placed in front of them to allow them be used as debug pins. Furthermore not every pin that has a debug mux will always be available to carry the debug data as they may be engaged in their primary purpose e.g. as a GPIO pin. The 5 RDU therefore outputs a debug cntrl signal with each debug data bit to indicate whether the mux associated with each debug pin should select the debug data or the normal data for the pin. The DebugPinSel and DebugPinSe/2 registers are used to determine which of the 33 potential debug pins are enabled for debug at any particular time. As it may not always be possible to output a full 32-bit debug word every cycle the RDU supports 10 the outputting of an n-bit sub-word every cycle to the enabled debug pins. Each debug test would then need to be re-run a number of times with a different portion of the debug word being output on the n-bit sub-word each time. The data from each run should then be correlated to create a full 32 bit (or whatever size is needed) debug word for every cycle. The debugdatavalid and pclk-out signals will accompany every sub-word to allow the data to be sampled correctly. The pc/k_out 15 signal is sourced close to its output pad rather than in the RDU to minimise the skew between the rising edge of the debug data signals (which should be registered close to their output pads) and the rising edge of pc/k out. As multiple debug runs will be needed to obtain a complete set of debug data the n-bit sub-word will need to contain a different bit pattern for each run. For maximum flexibility each debug pin has an 20 associated DebugDataSrc register that allows any of the 32 bits of the debug data word to be output on that particular debug data pin. The debug data pin must be enabled for debug operation by having its corresponding bit in the DebugPinSef registers set for the selected debug data bit to appear on the pin. The size of the sub-word is determined by the number of enabled debug pins which is controlled by 25 the DebugPinSel registers. Note that the debug data valid signal is always output. Furthermore debug cntrl[O] (which is configured by DebugPinSeil) controls the mux for both the debugdatavalid and pc/kout signals as both of these must be enabled for any debug operation. The mapping of debug data out[n] signals onto individual pins will take place outside the RDU. This mapping is described in Table 30 below. 30 Table 30. DebugPinSel mapping bit# Pin DebugPinSell phifrclk. The debug data-valid signal will appear on this pin when enabled. Enabling this pin also automatically enables the phi readl pin which will output the pc/kout signal DebugPinSel2(0-31) gpio[O...31] Table 31. RDU Configuration Registers Address offset from Register bits Reset Description WO 2004/050369 PCT/AU2003/001616 132 MMU base Ox80 DebugSrc 4 OxOO Denotes which block is supplying the debug data. The encoding of this block is given below. 0 - MMU 1 -TIM 2 - LSS 3- GPIO 4 - SCB 5 - ICU 6-CPR 7 - DIU 8-PCU Ox84 DebugPinSel 1 Ox0 Determines whether the phi frclk and 1 phi readl pins are used for debug output. 1 - Pin outputs debug data 0 - Normal pin function Ox88 DebugPinSel 32 OxOO Determines whether a pin is used for debug 2 0_000 data output. 0 1 - Pin outputs debug data 0 - Normal pin function Ox8C to 0x1 08 DebugDataSr 32 x 5 OxOO Selects which bit of the 32-bit debug data c[31:0] word will be output on debugdata-out[N] 11.9 INTERRUPT OPERATION The interrupt controller unit (see chapter 14) generates an interrupt request by driving interrupt request lines with the appropriate interrupt level. LEON supports 15 levels of interrupt with level 15 as the highest level (the SPARC architecture manual [36] states that level 15 is non-maskable but 5 we have the freedom to mask this if desired). The CPU will begin processing an interrupt exception when execution of the current instruction has completed and it will only do so if the interrupt level is higher than the current processor priority. If a second interrupt request arrives with the same level as an executing interrupt service routine then the exception will not be processed until the executing routine has completed. 10 When an interrupt trap occurs the LEON hardware will place the program counters (PC and nPC) into two local registers. The interrupt handler routine is expected, as a minimum, to place the PSR register in another local register to ensure that the LEON can correctly return to its pre-interrupt state. The 4-bit interrupt level (ir) is also written to the trap type (tt) field of the TBR (Trap Base Register) by hardware. The TBR then contains the vector of the trap handler routine the processor 15 will then jump. The TBA (Trap Base Address) field of the TBR must have a valid value before any interrupt processing can occur so it should be configured at an early stage.
WO 2004/050369 PCT/AU2003/001616 133 Interrupt pre-emption is supported while ET (Enable Traps) bit of the PSR is set. This bit is cleared during the initial trap processing. In initial simulations the ET bit was observed to be cleared for up to 30 cycles. This causes significant additional interrupt latency in the worst case where a higher priority interrupt arrives just as a lower priority one is taken. 5 The interrupt acknowledge cycles shown in Figure 26 below are derived from simulations of the LEON processor. The SoPEC toplevel interrupt signals used in this diagram map directly to the LEON interrupt signals in the iui and iuo records. An interrupt is asserted by driving its (encoded) level on the icucpuileve[3:0] signals (which map to iui.irl[3:0]). The LEON core responds to this, with variable timing, by reflecting the level of the taken interrupt on the cpu_icu level[3:0] signals 10 (mapped to uo.ir/[3:0]) and asserting the acknowledge signal cpulack (iuo.intack).The interrupt controller then removes the interrupt level one cycle after it has seen the level been acknowledged by the core. If there is another pending interrupt (of lower priority) then this should be driven on icucpuL~leve/[3:0] and the CPU will take that interrupt (the level 9 interrupt in the example below) once it has finished processing the higher priority interrupt. The cpu (cuilevell3:0] signals always 15 reflect the level of the last taken interrupt, even when the CPU has finished processing all interrupts. 11.10 BOOT OPERATION See section 17.2 for a description of the SoPEC boot operation. 11.11 SOFTWARE DEBUG Software debug mechanisms are discussed in the "SoPEC Software Debug" document [15]. 20 12 Serial Communications Block (SCB) 12.1 OVERVIEW The Serial Communications Block (SCB) handles the movement of all data between the SoPEC and the host device (e.g. PC) and between master and slave SoPEC devices. The main components of the SCB are a Full-Speed (FS) USB Device Core, a FS USB Host Core, a Inter 25 SoPEC Interface (ISI), a DMA manager, the SCB Map and associated control logic. The need for these components and the various types of communication they provide is evident in a multi-SoPEC printer configuration. 12.1.1 Multi-SoPEC systems While single SoPEC systems are expected to form the majority of SoPEC systems the SoPEC 30 device must also support its use in multi-SoPEC systems such as that shown in Figure 27. A SoPEC may be assigned any one of a number of identities in a multi-SoPEC system. A SoPEC may be one or more of a PrintMaster, a LineSyncMaster, an ISiMaster, a StorageSoPEC or an ISISlave SoPEC. 12.1.1.1 ISIMaster device 35 The ISIMaster is the only device that controls the common ISI lines (see Figure 30) and typically interfaces directly with the host. In most systems the ISIMaster will simply be the SoPEC connected to the USB bus. Future systems, however, may employ an ISI-Bridge chip to interface between the host and the ISI bus and in such systems the ISI-Bridge chip will be the ISIMaster. There can only be one ISIMaster on an ISI bus.
WO 2004/050369 PCT/AU2003/001616 134 Systems with multiple SoPECs may have more than one host connection, for example there could be two SoPECs communicating with the external host over their FS USB links (this would of course require two USB cables to be connected), but still only one ISIMaster. While it is not expected to be required, it is possible for a device to hand over its role as the 5 ISIMaster to another device on the ISI i.e. the ISIMaster is not necessarily fixed. 12.1.1.2 PrintMaster device The PrintMaster device is responsible for co-ordinating all aspects of the print operation. This includes starting the print operation in all printing SoPECs and communicating status back to the external host. When the ISIMaster is a SoPEC device it is also likely to be the PrintMaster as well. 10 There may only be one PrintMaster in a system and it is most likely to be a SoPEC device. 12.1.1.3 LineSyncMaster device The LineSyncMaster device generates the Isync pulse that all SoPECs in the system must synchronize their line outputs with. Any SoPEC in the system could act as a LineSyncMaster although the PrintMaster is probably the most likely candidate. It is possible that the 15 LineSyncMaster may not be a SoPEC device at all - it could, for example, come from some OEM motor control circuitry. There may only be one LineSyncMaster in a system. 12.1.1.4 Storage device For certain printer types it may be realistic to use one SoPEC as a storage device without using its print engine capability - that is to effectively use it as an ISI-attached DRAM. A storage SoPEC 20 would receive data from the ISIMaster (most likely to be an ISI-Bridge chip) and then distribute it to the other SoPECs as required. No other type of data flow (e.g. ISISlave -> storage SoPEC -> ISISlave) would need to be supported in such a scenario. The SCB supports this functionality at no additional cost because the CPU handles the task of transferring outbound data from the embedded DRAM to the ISI transmit buffer. The CPU in a storage SoPEC will have almost nothing else to do. 25 12.1.1.5 ISISlave device Multi-SoPEC systems will contain one or more ISISlave SoPECs. An ISISlave SoPEC is primarily used to generate dot data for the printhead IC it is driving. An ISISlave will not transmit messages on the ISI without first receiving permission to do so, via a ping packet (see section 12.4.4.6), from the ISIMaster 30 12.1.1.6 ISI-Bridge device SoPEC is targeted at the low-cost small office / home office (SoHo) market. It may also be used in future systems that target different market segments which are likely to have a high speed interface capability. A future device, known as an ISI-Bridge chip, is envisaged which will feature both a high speed interface (such as High-Speed (HS) USB, Ethernet or IEEE1 394) and one or more ISI 35 interfaces. The use of multiple ISI buses would allow the construction of independent print systems within the one printer. The ISI-Bridge would be the ISIMaster for each of the ISI buses it interfaces to. 12.1.1.7 External host The external host is most likely (but is not required) to be, a PC. Any system that can act as a USB 40 host or that can interface to an ISI-Bridge chip could be the external host. In particular, with the WO 2004/050369 PCT/AU2003/001616 135 development of USB On-The-Go (USB OTG), it is possible that a number of USB OTG enabled products such as PDAs or digital cameras will be able to directly interface with a SoPEC printer. 12.1.1.8 External USB device The external USB device is most likely (but is not required) to be, a digital camera. Any system that 5 can act as a USB device could be connected as an external USB device. This is to facilitate printing in the absence of a PC. 12.1.2 Types of communication 12.1.2.1 Communications with external host The external host communicates directly with the ISIMaster in order to print pages. When the 10 ISIMaster is a SoPEC, the communications channel is FS USB. 12.1.2.1.1 External host to ISIMaster communication The external host will need to communicate the following information to the ISIMaster device: * Communications channel configuration and maintenance information * Most data destined for PrintMaster, ISISlave or storage SoPEC devices. This data is simply 15 relayed by the ISIMaster * Mapping of virtual communications channels, such as USB endpoints, to ISI destination 12.1.2.1.2 ISIMaster to external host communication The ISIMaster will need to communicate the following information to the external host: * Communications channel configuration and maintenance information 20 * All data originating from the PrintMaster, ISISlave or storage SoPEC devices and destined for the external host. This data is simply relayed by the ISIMaster 12.1.2.1.3 External host to PrintMaster communication The external host will need to communicate the following information to the PrintMaster device: * Program code for the PrintMaster 25 * Compressed page data for the PrintMaster * Control messages to the PrintMaster - Tables and static data required for printing e.g. dead nozzle tables, dither matrices etc. * Authenticatable messages to upgrade the printer's capabilities 12.1.2.1.4 PrintMaster to external host communication 30 The PrintMaster will need to communicate the following information to the external host: e Printer status information (i.e. authentication results, paper empty/jammed etc.) * Dead nozzle information * Memory buffer status information * Power management status 35 * Encrypted SoPECid for use in the generation of PRINTERQA keys during factory programming 12.1.2.1.5 External host to ISISlave communication All communication between the external host and ISISlave SoPEC devices must be direct (via a dedicated connection between the external host and the ISISlave) or must take place via the WO 2004/050369 PCT/AU2003/001616 136 ISIMaster. In the case of a SoPEC ISIMaster it is possible to configure each individual USB endpoint to act as a control channel to an ISISlave SoPEC if desired, although the endpoints will be more usually used to transport data. The external host will need to communicate the following information to ISISlave devices over the comms/ISI: 5 * Program code for ISISlave SoPEC devices * Compressed page data for ISISlave SoPEC devices * Control messages to the ISISlave SoPEC (where a control channel is supported) * Tables and static data required for printing e.g. dead nozzle tables, dither matrices etc. * Authenticatable messages to upgrade the printer's capabilities 10 12.1.2.1.6 ISISlave to external host communication All communication between the ISISlave SoPEC devices and the external host must take place via the ISIMaster. The ISISlave will need to communicate the following information to the external host over the comms/ISI: e Responses to the external host's control messages (where a control channel is supported) 15 * Dead nozzle information from the ISISlave SoPEC. * Encrypted SoPECid for use in the generation of PRINTERQA keys during factory programming 12.1.2.2 Communication with external USB device 12.1.2.2.1 ISIMaster to External USB device communication 20 * Communications channel configuration and maintenance information. 12.1.2.2.2 External USB device to ISIMaster communication * Print data from a function on the external USB device. 12.1.2.3 Communication over ISI 12.1.2.3.1 ISIMaster to PrintMaster communication 25 The ISIMaster and PrintMaster will often be the same physical device. When they are different devices then the following information needs to be exchanged over the ISI: 0 All data from the external host destined for the PrintMaster (see section 12.1.2.1.4). This data is simply relayed by the ISIMaster 12.1.2.3.2 PrintMaster to ISIMaster communication 30 The ISIMaster and PrintMaster will often be the same physical device. When they are different devices then the following information needs to be exchanged over the IS: * All data from the PrintMaster destined for the external host (see section 12.1.2.1.4). This data is simply relayed by the ISIMaster 12.1.2.3.3 ISIMaster to ISISlave communication 35 The ISIMaster may wish to communicate the following information to the ISISlaves: * All data (including program code such as ISild enumeration) originating from the external host and destined for the ISISlave (see section 12.1.2.1.5). This data is simply relayed by the ISIMaster * wake up from sleep mode WO 2004/050369 PCT/AU2003/001616 137 12.1.2.3.4 ISISlave to ISIMaster communication The ISISlave may wish to communicate the following information to the ISIMaster: * All data originating from the ISISlave and destined for the external host (see section 12.1.2.1.6). This data is simply relayed by the ISIMaster 5 12.1.2.3.5 PrintMaster to ISISlave communication When the PrintMaster is not the ISIMaster all ISI communication is done in response to IS[ ping packets (see 12.4.4.6). When the PrintMaster is the ISIMaster then it will of course communicate directly with the ISISlaves. The PrintMaster SoPEC may wish to communicate the following information to the ISISlaves: 10 * Ink status e.g. requests for dotCount data i.e. the number of dots in each color fired by the printheads connected to the ISISlaves * configuration of GPIO ports e.g. for clutch control and lid open detect * power down command telling the ISISlave to enter sleep mode e ink cartridge fail information 15 This list is not complete and the time constraints associated with these requirements have yet to be determined. In general the PrintMaster may need to be able to: * send messages to an ISISlave which will cause the ISISlave to return the contents of ISISlave registers to the PrintMaster or 20 e to program ISISlave registers with values sent by the PrintMaster This should be under the control of software running on the CPU which writes messages to the ISI/SCB interface. 12.1.2.3.6 ISISlave to PrintMaster communication ISISlaves may need to communicate the following information to the PrintMaster: 25 * ink status e.g. dotCount data i.e. the number of dots in each color fired by the printheads connected to the ISISlaves * band related information e.g. finished band interrupts * page related information i.e. buffer underrun, page finished interrupts * MMU security violation interrupts 30 * GPIO interrupts and status e.g. clutch control and lid open detect * printhead temperature * printhead dead nozzle information from SoPEC printhead nozzle tests e power management status This list is not complete and the time constraints associated with these requirements have yet to be 35 determined. As the ISI is an insecure interface commands issued over the ISI should be of limited capability e.g. only limited register writes allowed. The software protocol needs to be constructed with this in mind. In general ISISlaves may need to return register or status messages to the PrintMaster or ISIMaster. They may also need to indicate to the PrintMaster or ISIMaster that a particular interrupt WO 2004/050369 PCT/AU2003/001616 138 has occurred on the ISISlave. This should be under the control of software running on the CPU which writes messages to the ISI block. 12.1.2.3.7 ISISlave to ISISlave communication The amount of information that will need to be communicated between ISISlaves will vary 5 considerably depending on the printer configuration. In some systems ISISlave devices will only need to exchange small amounts of control information with each other while in other systems (such as those employing a storage SoPEC or extra USB connection) large amounts of compressed page data may be moved between ISISlaves. Scenarios where ISISlave to ISISlave communication is required include: (a) when the PrintMaster is not the ISIMaster, (b) QA Chip ink usage protocols, (c) 10 data transmission from data storage SoPECs, (d) when there are multiple external host connections supplying data to the printer. 12.1.3 SCB Block Diagram The SCB consists of four main sub-blocks, as shown in the basic block diagram of Figure 28. 12.1.4 Definitions of I/Os 15 The toplevel I/Os of the SCB are listed in Table 32. A more detailed description of their functionality will be given in the relevant sub-block sections. Table 32. SCB 1/O Port name s 1/O Description Clocks and Resets prstn I In System reset signal. Active low. Pclk 1 In System clock. usbclk 1 In 48MHz clock for the USB device and host cores. The cores also require a 12MHz clock, which will be generated locally by dividing the 48MHz clock by 4. isicprreset-n 1 Out Signal from the ISI indicating that ISI activity has been detected while in sleep mode and so the chip should be reset. Active low. usbdcprreset_n 1 Out Signal from the USB device that a USB reset has occurred. Active low. USB device 10 transceiver signals usbdts 1 Out USB device 10 transceiver (BUSB2 -PM) driver three-state control. Active high enable. usbda 1 Out USB device 10 transceiver (BUSB2_PM) driver data input. usbdseO 1 Out USB device 10 transceiver (BUSB2 PM) single-ended zero input. Active high.
WO 2004/050369 PCT/AU2003/001616 139 usbd-zp 1 In USB device 10 transceiver (BUSB2_PM) D+ receiver output. usbd_zm 1 In USB device 10 transceiver (BUSB2_PM) D receiver output. usbdz 1 In USB device 10 transceiver (BUSB2_PM) differential receiver output. usbdpullupen 1 Out USB device pull-up resistor enable. Switches power to the external pull-up resistor, connected to the D+ line that is required for device identification to the USB. Active high. usbd_vbussense I In USB device VBUS power sense. Used to detect power on VBUS. NOTE: The IBM Cull PADS are 3.3V, VBUS is 5V. An external volt age conversion will be necessary, e.g. resistor divider network. Active high. USB host 10 transceiver signals usbhts 1 Out USB host 10 transceiver (BUSB2 PM) driver three-state control. Active high enable usbha I Out USB host 10 transceiver (BUSB2_PM) driver data input. usbhseO 1 Out USB host 10 transceiver (BUSB2 PM) single ended zero input. Active high. usbhzp 1 In USB host 10 transceiver (BUSB2_PM) D+ receiver output. usbhzm 1 In USB host 10 transceiver (BUSB2_PM) D receiver output. usbhz I In USB host 10 transceiver (BUSB2_PM) differential receiver output. usbh over current 1 In USB host port power over current indicator. Active high. usbhpower en 1 Out USB host VBUS power enable. Used for port power switching. Active high. CPU Interface cpu-adr[n:2] n-i In CPU address bus. cpu dataout[31:0] 32 In Shared write data bus from the CPU scbcpudata[31:0] 32 Out Read data bus to the CPU cpu_rwn 1 In Common read/not-write signal from the CPU cpu acode[1:0] 2 In CPU Access Code signals. These decode as WO 2004/050369 PCT/AU2003/001616 140 follows: 00 - User program access 01 - User data access 10 - Supervisor program access 11 - Supervisor data access cpu_sob sel 1 In Block select from the CPU. When cpuscb-sel is high both cpu adr and cpu dataout are valid scb-cpu rdy 1 Out Ready signal to the CPU. When scb cpu rdy is high it indicates the last cycle of the access. For a write cycle this means cpudataout has been registered by the SCB and for a read cycle this means the data on scb_cpu data is valid. scbcpuberr 1 Out Bus error signal to the CPU indicating an invalid access. scb cpujdebugvalid 1 Out Signal indicating that the data currently on sob cpu data is valid debug data Interrupt signals dma icu irq 1 Out DMA interrupt signal to the interrupt controller block. isi_icu-irq I Out IS[ interrupt signal to the interrupt controller block. usb-icu irq[1:0] 2 Out USB host and device interrupt signals to the ICU. Bit 0 - USB Host interrupt Bit 1 - USB Device interrupt DIU interface scb diu wadr[21:51 17 Out Write address bus to the DIU scb diu data[63:0] 64 Out Data bus to the DIU. scb diu-wreq 1 Out Write request to the DIU diu scb-wack 1 In Acknowledge from the DIU that the write request was accepted. scb_diu_wvalid 1 Out Signal from the SCB to the DIU indicating that the data currently on the scbdiudata[63:OJ bus is valid sob_diuwmask[7:0] 7 Out Byte aligned write mask. A "1" in a bit field of "scb_diuwmask[7:0]' means that the corresponding byte will be written to DRAM.
WO 2004/050369 PCT/AU2003/001616 141 sob diu rreq 1 Out Read request to the DIU. scb-diu radr[21:5] 17 Out Read address bus to the DIU diuscb rack 1 In Acknowledge from the DIU that the read request was accepted. diuscb rvalid 1 In Signal from the DIU to the SCB indicating that the data currently on the diu.data[63:0] bus is valid diu-data[63:0] 64 In Common DIU data bus. GPIO interface isi_gpio dout[3:0] 4 Out ISI output data to GPIO pins isi_gpio_e[3:0] 4 Out ISI output enable to GPIO pins gpio isi-din[3:0] 4 In Input data from GPIO pins to ISI 12.1.5 SCB Data Flow A logical view of the SCB is shown in Figure 29, depicting the transfer of data within the SCB. 12.2 USBD (USB DEVICE SUB-BLOCK) 12.2.1 Overview 5 The FS USB device controller core and associated SCB logic are referred to as the USB Device (USBD). A SoPEC printer has FS USB device capability to facilitate communication between an external USB host and a SoPEC printer. The USBD is self-powered. It connects to an external USB host via a dedicated USB interface on the SoPEC printer, comprising a USB connector, the necessary 10 discretes for USB signalling and the associated SoPEC ASIC I/Os. The FS USB device core will be third party IP from Synopsys: TymeWarej m USB1.1 Device Controller (UDCVCI). Refer to the UDCVCI User Manual [20] for a description of the core. The device core does not support LS USB operation. Control and bulk transfers are supported by the device. Interrupt transfers are not considered necessary because the required interrupt-type 15 functionality can be achieved by sending query messages over the control channel on a scheduled basis. There is no requirement to support isochronous transfers. The device core is configured to support 6 USB endpoints (EPs): the default control EP (EPO), 4 bulk OUT EPs (EPI, EP2, EP3, EP4) and 1 bulk IN EP (EP5). It should be noted that the direction of each EP is with respect to the USB host, i.e. IN refers to data transferred to the external host and 20 OUT refers to data transferred from the external host. The 4 bulk OUT EPs will be used for the transfer of data from the external host to SoPEC, e.g. compressed page data, program data or control messages. Each bulk OUT EP can be mapped on to any target destination in a multi-SoPEC system, via the SCB Map configuration registers. The bulk IN EP is used for the transfer of data from SoPEC to the external host, e.g. a print image downloaded from a digital camera that requires 25 processing on the external host system. Any feedback data will be returned to the external host on EPO, e.g. status information. The device core does not provide internal buffering for any of its EPs (with the exception of the 8 byte setup data payload for control transfers). All EP buffers are provided in the SCB. Buffers will be WO 2004/050369 PCT/AU2003/001616 142 grouped according to EP direction and associated packet destination. The SCB Map configuration registers contain a DestiSld and DestISISub/d for each OUT EP, defining their EP mapping and therefore their packet destination. Refer to section Section 12.4 ISI (Inter SoPEC Interface Sub block) for further details on ISld and ISISub/d. Refer to section Section 12.5 CTRL (Control Sub 5 block) for further details on the mapping of OUT EPs. 12.2.2 USBID effective bandwidth The effective bandwidth between an external USB host and the printer will be influenced by: * Amount of activity from other devices that share the USB with the printer. * Throughput of the device controller core. 10 e EP buffering implementation. * Responsiveness of the external host system CPU in handling USB interrupts. To maximize bandwidth to the printer it is recommended that no other devices are active on the USB between the printer and the external host. If the printer is connected to a HS USB external host or hub it may limit the bandwidth available to other devices connected to the same hub but it 15 would not significantly affect the bandwidth available to other devices upstream of the hub. The EP buffering should not limit the USB device core throughput, under normal operating conditions. Used in the recommended configuration, under ideal operating conditions, it is expected that an effective bandwidth of 8-9 Mbit/s will be achieved with bulk transfers between the external host and the printer. 20 12.2.3 IN EP packet buffer The IN EP packet buffer stores packets originating from the LEON CPU that are destined for transmission over the USB to the external USB host. CPU writes to the buffer are 32 bits wide. USB device core reads from the buffer 32 bits wide. 128 bytes of local memory are required in total for EPO-IN and EP5-IN buffering. The IN EP buffer is 25 a single, 2-port local memory instance, with a dedicated read port and a dedicated write port. Both ports are 32 bits wide. Each IN EP has a dedicated 64 byte packet location available in the memory array to buffer a single USB packet (maximum USB packet size is 64 bytes). Each individual 64 byte packet location is structured as 16 x 32 bit words and is read/written in a FIFO manner. When the device core reads a packet entry from the IN EP packet buffer, the buffer must retain the 30 packet until the device core performs a status write, informing the SCB that the packet has been accepted by the external USB host and can be flushed. The CPU can therefore only write a single packet at a time to each IN EP. Any subsequent CPU write request to a buffer location containing a valid packet will be refused, until that packet has been successfully transmitted. 12.2.4 OUT EP packet buffer 35 The OUT EP packet buffer stores packets originating from the external USB host that are destined for transmission over DMAChanne0, DMAChannell or the ISI. The SCB control logic is responsible for routing the OUT EP packets from the OUT EP packet buffer to DMA or to the ISITx Buffer, based on the SCB Map configuration register settings. USB core writes to the buffer are 32 bits wide. DMA and ISI associated reads from the buffer are both 64 bits wide.
WO 2004/050369 PCT/AU2003/001616 143 512 bytes of local memory are required in total for EPO-OUT, EP1 -OUT, EP2-OUT, EP3-OUT and EP4-OUT buffering. The OUT EP packet buffer is a single, 2-port local memory instance, with a dedicated read port and a dedicated write port. Both ports are 64 bits wide. Byte enables are used for the 32 bit wide USB device core writes to the buffer. Each OUT EP can be mapped to 5 DMAChannelO, DMAChannell or the ISI. The OUT EP packet buffer is partitioned accordingly, resulting in three distinct packet FIFOs: * USBDDMAOFIFO, for USB packets destined for DMAChannelO on the local SoPEC. * USBDDMAI FIFO, for USB packets destined for DMAChannell on the local SoPEC. * USBDISIFIFO, for USB packets destined for transmission over the ISI. 10 12.2.4.1 USBDDMAnFIFO This description applies to USBDDMAOFIFO and USBDDMA1 FIFO, where 'n' represents the respective DMA channel, i.e. n=0 for USBDDMAOFIFO, n=1 for USBDDMA1 FIFO. USBDDMAnFIFO services any EPs mapped to DMAChanneln on the local SoPEC device. This implies that a packet originating from an EP with an associated ISld that matches the local SoPEC 15 IS/Id and an IS/Subld=n will be written to USBDDMAnFIFO, if there is space available for that packet. USBDDMAnFIFO has a capacity of 2 x 64 byte packet entries, and can therefore buffer up to 2 USB packets. It can be considered as a 2 packet entry FIFO. Packets will be read from it in the same order in which they were written, i.e. the first packet written will be the first packet read and the 20 second packet written will be the second packet read. Each individual 64 byte packet location is structured as 8 x 64 bit words and is read/written in a FIFO manner. The USBDDMAnFIFO has a write granularity of 64 bytes, to allow for the maximum USB packet size. The USBDDMAnFIFO will have a read granularity of 32 bytes to allow for the DMA write access bursts of 4 x 64 bit words, i.e. the DMA Manager will read 32 byte chunks at a time from the 25 USBDDMAnFIFO 64byte packet entries, for transfer to the DIU. It is conceivable that a packet which is not a multiple 32 bytes in size may be written to the USBDDMAnFIFO. When this event occurs, the DMA Manager will read the contents of the remaining address locations associated with the 32 byte chunk in the USBDDMAnFIFO, transferring the packet plus whatever data is present in those locations, resulting in a 32 byte packet (a burst of 30 4 x 64 bit words) transfer to the DIU. The DMA channels should achieve an effective bandwidth of 160 Mbits/sec (1 bit/cycle) and should never become blocked, under normal operating conditions. As the USB bandwidth is considerably less, a 2 entry packet FIFO for each DMA channel should be sufficient. 12.2.4.2 USBDISIFIFO 35 USBDISIFIFO services any EPs mapped to ISI. This implies that a packet originating from an EP with an associated IS/Id that does not match the local SoPEC /S//d will be written to USBDISIFIFO if there is space available for that packet. USBDISIFIFO has a capacity of 4 x 64 byte packet entries, and can therefore buffer up to 4 USB packets. It can be considered as a 4 packet entry FIFO. Packets will be read from it in the same 40 order in which they were written, i.e. the first packet written will be the first packet read and the WO 2004/050369 PCT/AU2003/001616 144 second packet written will be the second packet read, etc. Each individual 64 byte packet location is structured as 8 x 64 bit words and is read/written in a FIFO manner. The ISI long packet format will be used to transfer data across the ISI. Each ISI long packet data payload is 32 bytes. The USBDISIFIFO has a write granularity of 64 bytes, to allow for the 5 maximum USB packet size. The USBDISIFIFO will have a read granularity of 32 bytes to allow for the ISI packet size, i.e. the SCB will read 32 byte chunks at a time from the USBDISIFIFO 64byte packet entries, for transfer to the ISI. It is conceivable that a packet which is not a multiple 32 bytes in size may be written to the USBDISIFIFO, either intentionally or due to a software error. A maskable interrupt per EP is 10 provided to flag this event. There will be 2 options for dealing with this scenario on a per EP basis: * Discard the packet. * Read the contents of the remaining address locations associated with the 32 byte chunk in the USBDISIFIFO, transferring the irregular size packet plus whatever data is present in those locations, resulting in a 32 byte packet transfer to the ISITxBuffer. 15 The ISI should achieve an effective bandwidth of 100 Mbits/sec (4 wire configuration). It is possible to encounter a number of retries when transmitting an ISI packet and the LEON CPU will require access to the ISI transmit buffer. However, considering the relatively low bandwidth of the USB, a 4 packet entry FIFO should be sufficient. 12.2.5 Wake-up from sleep mode 20 The SoPEC will be placed in sleep mode after a suspend command is received by the USB device core. The USB device core will continue to be powered and clocked in sleep mode. A USB reset, as opposed to a device resume, will be required to bring SoPEC out of its sleep state as the sleep state is hoped to be logically equivalent to the power down state. The USB reset signal originating from the USB controller will be propagated to the CPR (as 25 usbcpr reset n) if the USBWakeupEnable bit of the WakeupEnable register (see Table ) has been set. The USBWakeupEnable bit should therefore be set just prior to entering sleep mode. There is a scenario that would require SoPEC to initiate a USB remote wake-up (i.e. where SoPEC signals resume to the external USB host after being suspended by the external USB host). A digital camera (or other supported external USB device) could be connected to SoPEC via the internal 30 SoPEC USB host controller core interface. There may be a need to transfer data from this external USB device, via SoPEC, to the external USB host system for processing. If the USB connecting the external host system and SoPEC was suspended, then SoPEC would need to initiate a USB remote wake-up. 12.2.6 Implementation 35 12.2.6.1 USBD Sub-block Partition * Block diagram * Definition of I/Os 12.2.6.2 USB Device IP Core 12.2.6.3 PVC! Target 40 12.2.6.4 IN EP Buffer WO 2004/050369 PCT/AU2003/001616 145 12.2.6.5 OUTEP Buffer 12.3 USBH (USB HOST SUB-BLOCK) 12.3.1 Overview The SoPEC USB Host Controller (HC) core, associated SCB logic and associated SoPEC ASIC 5 I/Os are referred to as the USB Host (USBH). A SoPEC printer has FS USB host capability, to facilitate communication between an external USB device and a SoPEC printer. The USBH connects to an external USB device via a dedicated USB interface on the SoPEC printer, comprising a USB connector, the necessary discretes for USB signalling and the associated SoPEC ASIC I/Os. 10 The FS USB HC core are third party IP from Synopsys: DesignWareR USB1.1 OHCI Host Controller with PVCI (UHOSTCPVCI). Refer to the UHOSTCPVCI User Manual [18] for details of the core. Refer to the Open Host Controller Interface (OHCI) Specification Release [19] for details of OHCI operation. The HC core supports Low-Speed (LS) USB devices, although compatible external USB devices 15 are most likely to be FS devices. It is expected that communication between an external USB device and a SoPEC printer will be achieved with control and bulk transfers. However, isochronous and interrupt transfers are also supported by the HC core. There will be 2 communication channels between the Host Controller Driver (HCD) software running on the LEON CPU and the HC core: 20 * OHCI operational registers in the HC core. These registers are control, status, list pointers and a pointer to the Host Controller Communications Area (HCCA) in shared memory. A target Peripheral Virtual Component Interface (PCVI) on the HC core will provide LEON with direct read/write access to the operational registers. Refer to the OHCI Specification for details of these registers. 25 * HCCA in SoPEC eDRAM. An initiator Peripheral Virtual Component Interface (PCVI) on the HC core will provide the HC with DMA read/write access to an address space in eDRAM. The HCD running on LEON will have read/write access to the same address space. Refer to the OHCI Specification for details of the HCCA. The target PVCI interface is a 32 bit word aligned interface, with byte enables for write access. All 30 read/ write access to the target PVCI interface by the LEON CPU will be 32 bit word aligned. The byte enables will not be used, as all registers will be read and written as 32 bit words. The initiator PVCI interface is a 32 bit word aligned interface with byte enables for write access. All DMA read/write accesses are 256 bit word aligned, in bursts of 4 x 64 bit words. As there is no guarantee that the read/write requests from the HC core will start at a 256 bit boundary or be 256 35 bits long, it is necessary to provide 8 byte enables for each of the 64 bit words in a write burst form the HC core to DMA. The signal scb diuwmask serves this purpose. Configuration of the HC core will be performed by the HCD. 12.3.2 Read/Write Buffering The HC core maximum burst size for a read/write access is 4 x 32 bit words. This implies that the 40 minimum buffering requirements for the HC core will be a 1 entry deep address register and a 4 WO 2004/050369 PCT/AU2003/001616 146 entry deep data register. It will be necessary to provide data and address mapping functionality to convert the 4 x 32 bit word HC core read/write bursts into 4 x 64 bit word DMA read/write bursts. This will meet the minimum buffering requirements. 12.3.3 USBH effective bandwidth 5 The effective bandwidth between an external USB device and a SoPEC printer will be influenced by: * Amount of activity from other devices that share the USB with the external USB device. * Throughput of the HC core. 1 HC read/write buffering implementation. 10 e Responsiveness of the LEON CPU in handling USB interrupts. Effective bandwidth between an external USB device and a SoPEC printer is not an issue. The primary application of this connectivity is the download of a print image from a digital camera. Printing speed is not important for this type of print operation. However, to maximize bandwidth to the printer it is recommended that no other devices are active on the USB between the printer and 15 the external USB device. The HC read/write buffering in the SCB should not limit the USB HC core throughput, under normal operating conditions. Used in the recommended configuration, under ideal operating conditions, it is expected that an effective bandwidth of 8-9 Mbit/s will be achieved with bulk transfers between the external USB device and the SoPEC printer. 20 12.3.4 Implementation 12.3.5 USBH Sub-block Partition * USBH Block Diagram * Definition of I/Os. 12.3.5.1 USB Host IP Core 25 12.3.5.2 PVC! Target 12.3.5.3 PVC! Initiator 12.3.5.4 Read/Write Buffer 12.4 ISI (INTER SoPEC INTERFACE SUB-BLOCK) 12.4.1 Overview 30 The ISI is utilised in all system configurations requiring more than one SoPEC. An example of such a system which requires four SoPECs for duplex A3 printing and an additional SoPEC used as a storage device is shown in Figure 27. The ISI performs much the same function between an ISISlave SoPEC and the ISIMaster as the USB connection performs between the ISIMaster and the external host. This includes the transfer of 35 all program data, compressed page data and message (i.e. commands or status information) passing between the ISiMaster and the ISISlave SoPECs. The ISIMaster initiates all communication with the ISiSlaves. 12.4.2 ISi Effective Bandwidth The ISI will need to run at a speed that will allow error free transmission on the PCB while 40 minimising the buffering and hardware requirements on SoPEC. While an ISI speed of 10 Mbit/s is WO 2004/050369 PCT/AU2003/001616 147 adequate to match the effective FS USB bandwidth it would limit the system performance when a high-speed connection (e.g. USB2.0, IEEE1 394) is used to attach the printer to the PC. Although they would require the use of an extra ISI-Bridge chip such systems are envisaged for more expensive printers (compared to the low-cost basic SoPEC powered printers that are initially being 5 targeted) in the future. An ISI line speed (i.e. the speed of each individual ISI wire) of 32 Mbit/s is therefore proposed as it will allow ISI data to be over-sampled 5 times (at a pc/k frequency of 160MHz). The total bandwidth of the ISI will depend on the number of pins used to implement the interface. The ISI protocol will work equally well if 2 or 4 pins are used for transmission/reception. The ISiNumPins register is used 10 to select between a 2 or 4 wire ISI, giving peak raw bandwidths of 64 Mbit/s and 128 Mbit/s respectively. Using either a 2 or 4 wire ISI solution would allow the movement of data in to and out of a storage SoPEC (as described in 12.1.1.4 above), which is the most bandwidth hungry ISI use, in a timely fashion. The ISINumPins register is used to select between a 2 or 4 wire ISI. A 2 wire ISI is the default 15 setting for ISINumPins and this may be changed to a 4 wire ISI after initial communication has been established between the ISIMaster and all ISISlaves. Software needs to ensure that the switch from 2 to 4 wires is handled in a controlled and coordinated fashion so that nothing is transmitted on the ISI during the switch over period. The maximum effective bandwidth of a two wire ISI, after allowing for protocol overheads and bus 20 turnaround times, is expected to be approx. 50 Mbit/s. 12.4.3 ISI Device Identification and Enumeration The /S/MasterSe/ bit of the ISICntr register (see section Table ) determines whether a SoPEC is an IS\Master (ISIMasterSe/ = 1), or an ISISlave (IS/MasterSel = 0). SoPEC defaults to being an ISISlave (ISIMasterSe/ = 0) after a power-on reset - i.e. it will not 25 transmit data on the ISI without first receiving a ping. If a SoPEC's IS/MasterSel bit is changed to 1, then that SoPEC will become the ISIMaster, transmitting data without requiring a ping, and generating pings as appropriately programmed. IS/MasterSe/ can be set to 1 explicitly by the CPU writing directly to the ISICntrl register. iSiMasterSel can also be automatically set to 1 when activity occurs on any of USB endpoints 2-4 30 and the AutoMasterEnable bit of the ISICntri register is also I (the default reset condition). Note that if AutoMasterEnable is 0, then activity on USB endpoints 2-4 will not result in IS/MasterSe/ being set to 1. USB endpoints 2-4 are chosen for the automatic detection since the power-on-reset condition has USB endpoints 0 and 1 pointing to ISIld 0 (which matches the local SoPEC's ISlid after power on reset). Thus any transmission on USB endpoints 2-4 indicate a desire to transmit on the ISI 35 which would usually indicate ISIMaster status. The automatic setting of /S/MasterSe/ can be disabled by clearing AutoMasterEnable, thereby allowing the SoPEC to remain an ISISlave while still making use of the USB endpoints 2-4 as external destinations. Thus the setting of a SoPEC being ISIMaster or ISISlave can be completely under software control, or can be completely automatic.
WO 2004/050369 PCT/AU2003/001616 148 The ISild is established by software downloaded over the ISI (in broadcast mode) which looks at the input levels on a number of GPIO pins to determine the ISild. For any given printer that uses a multi-SoPEC configuration it is expected that there will always be enough free GPIO pins on the ISISlaves to support this enumeration mechanism. 5 12.4.4 181 protocol The ISI is a serial interface utilizing a 2/4 wire half-duplex configuration such as the 2-wire system shown in Figure 30 below. An ISIMaster must always be present and a variable number of ISISlaves may also be on the ISI bus. The ISI protocol supports up to 14 addressable slaves, however to simplify electrical issues the IS[ drivers need only allow for 5-6 ISI devices on a 10 particular ISI bus. The ISI bus enables broadcasting of data, ISIMaster to ISISlave communication, ISISlave to ISIMaster communication and ISISlave to ISISlave communication. Flow control, error detection and retransmission of errored packets is also supported. ISI transmission is asynchronous and a Start field is present in every transmitted packet to ensure synchronization for the duration of the packet. 15 To maximize the effective ISI bandwidth while minimising pin requirements a half-duplex interleaved transmission scheme is used. Figure 31 below shows how a 16-bit word is transmitted from an ISIMaster to an ISISlave over a 2-wire ISI bus. Since data will be interleaved over the wires and a 4 wire ISI is also supported, all ISI packets should be a multiple of 4 bits. All ISi transactions are initiated by the ISIMaster and every non-broadcast data packet needs to be 20 acknowledged by the addressed recipient. An ISISlave may only transmit when it receives a ping packet (see section 12.4.4.6) addressed to it. To avoid bus contention all ISI devices must wait ISITurnAround bit-times (5 polk cycles per bit) after detecting the end of a packet before transmitting a packet (assuming they are required to transmit). All non-transmitting ISI devices must tristate their Tx drivers to avoid line contention. The ISI protocol is defined to avoid devices driving out of order 25 (e.g. when an ISISlave is no longer being addressed). As the ISI uses standard 1/O pads there is no physical collision detection mechanism. There are three types of IS[ packet: a long packet (used for data transmission), a ping packet (used by the ISIMaster to prompt ISISlaves for packets) and a short packet (used to acknowledge receipt of a packet). All ISI packets are delineated by a Start and Stop fields and transmission is atomic i.e. 30 an ISI packet may not be split or halted once transmission has started. 12.4.4.1 ISI transactions The different types of ISI transactions are outlined in Figure 32 below. As described later all NAKs are inferred and ACKs are not addressed to any particular ISI device. 12.4.4.2 Start Field Description 35 The Start field serves two purposes: To allow the start of a packet be unambiguously identified and to allow the receiving device synchronise to the data stream. The symbol, or data value, used to identify a Start field must not legitimately occur in the ensuing packet. Bit stuffing is used to guarantee that the Start symbol will be unique in any valid (i.e. error free) packet. The ISI needs to see a valid Start symbol before packet reception can commence i.e. the receive logic constantly 40 looks for a Start symbol in the incoming data and will reject all data until it sees a Start symbol.
WO 2004/050369 PCT/AU2003/001616 149 Furthermore if a Start symbol occurs (incorrectly) during a data packet it will be treated as the start of a new packet. In this case the partially received packet will be discarded. The data value of the Start symbol should guarantee that an adequate number of transitions occur on the physical ISI lines to allow the receiving IS] device to determine the best sampling window for 5 the transmitted data. The Start symbol should also be sufficiently long to ensure that the bit stuffing overhead is low but should still be short enough to reduce its own contribution to the packet overhead. A Start symbol of b01010101 is therefore used as it is an effective compromise between these constraints. Each SoPEC in a multi-SoPEC system will derive its system clock from a unique (i.e. one per 10 SoPEC) crystal. The system clocks of each device will drift relative to each other over any period of time. The system clocks are used for generation and sampling of the ISI data. Therefore the sampling window can drift and could result in incorrect data values being sampled at a later point in time. To overcome this problem the ISI receive circuitry tracks the sampling window against the incoming data to ensure that the data is sampled in the centre of the bit period. 15 12.4.4.3 Stop Field Description A 1 bit-time Stop field of b1 per ISI line ensures that all ISI lines return to the high state before the next packet is transmitted. The stop field is driven on to each ISI line simultaneously, i.e. b 11 for a 2-wire ISI and b 1111 for a 4-wire ISI would be interleaved over the respective ISI lines. Each ISI line is driven high for I bit-time. This is necessary because the first bit of the Start field is bO. 20 12.4.4.4 Bit Stuffing This involves the insertion of bits into the bitstream at the transmitting SoPEC to avoid certain data patterns. The receiving SoPEC will strip these inserted bits from the bitstream. Bit-stuffing will be performed when the Start symbol appears at a location other than the start field of any packet, i.e. when the bit pattern bOl 01010 occurs at the transmitter, a 0 will be inserted to 25 escape the Start symbol, resulting in the bit pattern bOl010100. Conversely, when the bit pattern bOl01010 occurs at the receiver, if the next bit is a'0' it will be stripped, if it is a '1'then a Start symbol is detected. If the frequency variations in the quartz crystal were large enough, it is conceivable that the resultant frequency drift over a large number of consecutive 1s or Os could cause the receiving 30 SoPEC to loose synchronisation.6 The quartz crystal that will be used in SoPEC systems is rated for 32MHz @ 100ppm. In a multi-SoPEC system with a 32MHz+100ppm crystal and a 32MHz-100ppm crystal, it would take approximately 5000 pclk cycles to cause a drift of 1 pelk cycle. This means that we would only need to bit-stuff somewhere before 1000 ISI bits of consecutive ls or consecutive Os, to ensure adequate synchronization. As the maximum number of bits transmitted per ISI line in a packet is 145, it should not be 6 Current max packet size -= 290 bits = 145 bits per ISI line (on a 2 wire ISI) = 725 160MHz cycles. Thus the pclks in the two communicating ISI devices should not drift by more than one cycle in 725 i.e. 1379 ppm. Careful analysis of the crystal, PLL and oscillator specs and the sync detection circuit is needed here to ensure our solution is robust.
WO 2004/050369 PCT/AU2003/001616 150 necessary to perform bit-stuffing for consecutive Is or Os. We may wish to constrain the spec of xtalin and also xtalin for the ISI-Bridge chip to ensure the ISI cannot drift out of sync during packet reception. Note that any violation of bit stuffing will result in the RxFrameErrorSticky status bit being set and the incoming packet will be treated as an errored packet. 5 12.4.4.5 ISI Long Packet The format of a long ISI packet is shown in Figure 33 below. Data may only be transferred between ISI devices using a long packet as both the short and ping packets have no payload field. Except in the case of a broadcast packet, the receiving ISI device will always reply to a long packet with an explicit ACK (if no error is detected in the received packet) or will not reply at all (e.g. an error is 10 detected in the received packet), leaving the transmitter to infer a NAK. As with all ISI packets the bitstream of a long packet is transmitted with its Isb (the leftmost bit in Figure 33) first. Note that the total length (in bits) of an ISI long packet differs slightly between a 2 and 4-wire ISI system due to the different number of bits required for the Start and Stop fields. All long packets begin with the Start field as described earlier. The PktDesc field is described in 15 Table 33. Table 33. PktDesc field description BIt Descripation 0:1 00 - Long packet 01 - Reserved 10 - Ping packet 11 - Reserved 2 Sequence bit value. Only valid for long packets. See section 12.4.4.9 for a description of sequence bit operation Any ISI device in the system may transmit a long packet but only the ISIMaster may initiate an ISI transaction using a long packet. An ISISlave may only send a long packet in reply to a ping message from the ISIMaster. A long packet from an ISISlave may be addressed to any ISI device in 20 the system. The Address field is straightforward and complies with the ISI naming convention described in section 12.5. The payload field is exactly what is in the transmit buffer of the transmitting ISI device and gets copied into the receive buffer of the addressed ISI device(s). When present the payload field is 25 always 256 bits. To ensure strong error detection a 16-bit CRC is appended. 12.4.4.6 /S/ Ping Packet The ISI ping packet is used to allow ISISlaves to transmit on the ISI bus. As can be seen from Figure 34 below the ping packet can be viewed as a special case of the long packet. In other words 30 it is a long packet without any payload. Therefore the PktDesc field is the same as a long packet PktDesc, with the exception of the sequence bit, which is not valid for a ping packet. Both the ISiSub/d and the sequence bit are fixed at 1 for all ping packets. These values were chosen to maximize the hamming distance from an ACK symbol and to minimize the likelihood of bit stuffing.
WO 2004/050369 PCT/AU2003/001616 151 The IS/Subid is unused in ping packets because the ISIMaster is addressing the ISI device rather than one of the DMA channels in the device. The ISiSlave may address any ISld./SISub/d in response if it wishes. The ISISlave will respond to a ping packet with either an explicit ACK (if it has nothing to send), an inferred NAK (if it detected an error in the ping packet) or a long packet 5 (containing the data it wishes to send). Note that inferred NAKs do not result in the retransmission of a ping packet. This is because the ping packet will be retransmitted on a predetermined schedule (see 12.4.4.11 for more details). An ISISlave should never respond to a ping message to the broadcast ISIld as this must have been sent in error. An ISI ping packet will never be sent in response to any packet and may only originate 10 from an ISIMaster. 12.4.4.7 IS! Short Packet The ISI short packet is only 17 bits long, including the Start and Stop fields. A value of b1 1101011 is proposed for the ACK symbol. As a 16-bit CRC is inappropriate for such a short packet it is not used. In fact there is only one valid value for a short ACK packet as the Start, ACK and Stop 15 symbols all have fixed values. Short packets are only used for acknowledgements (i.e. explicit ACKs). The format of a short ISI packet is shown in Figure 35 below. The ACK value is chosen to ensure that no bit stuffing is required in the packet and to minimize its hamming distance from ping and long ISI packets. 20 12.4.4.8 Error Detection and Retransmission The 16-bit CRC will provide a high degree of error detection and the probability of transmission errors occurring is very low as the transmission channel (i.e. PCB traces) will have a low inherent bit error rate. The number of undetected errors should therefore be minute. The HDLC standard CRC-16 (i.e. G(x) = X6+ X12+ x 5 +1) is to be used for this calculation, which is 25 to be performed serially. It is calculated over the entire packet (excluding the Start and Stop fields). A simple retransmission mechanism frees the CPU from getting involved in error recovery for most errors because the probability of a transmission error occurring more than once in succession is very, very low in normal circumstances. After each non-short ISI packet is transmitted the transmitting device will open a reply window. The 30 size of the reply window will be ISlShortReplyWin bit times when a short packet is expected in reply, i.e. the size of a short packet, allowing for worst case bit stuffing, bus turnarounds and timing differences. The size of the reply window will be /S/LongReplyWin bit times when a long packet is expected in reply, i.e. this will be the max size of a long packet, allowing for worst case bit stuffing, bus turnarounds and timing differences. In both cases if an ACK is received the window will close 35 and another packet can be transmitted but if an ACK is not received then the full length of the window must be waited out. As no reply should be sent to a broadcast packet, no reply window should be required however all other long packets open a reply window in anticipation of an ACK. While the desire is to minimize the time between broadcast transmissions the simplest solution should be employed. This would 40 imply the same size reply window as other long packets.
WO 2004/050369 PCT/AU2003/001616 152 When a packet has been received without any errors the receiving ISI device must transmit its acknowledge packet (which may be either a long or short packet) before the reply window closes. When detected errors do occur the receiving ISI device will not send any response. The transmitting ISI device interprets this lack of response as a NAK indicating that errors were detected in the 5 transmitted packet or that the receiving device was unable to receive the packet for some reason (e.g. its buffers are full). If a long packet was transmitted the transmitting ISI device will keep the transmitted packet in its transmit buffer for retransmission. If the transmitting device is the ISIMaster it will retransmit the packet immediately while if the transmitting device is an ISISlave it will retransmit the packet in response to the next ping it receives from the ISIMaster. 10 The transmitting ISI device will continue retransmitting the packet when it receives a NAK until it either receives an ACK or the number of retransmission attempts equals the value of the NumRetries register. If the transmission was unsuccessful then the transmitting device sets the TxErrorSticky bit in its IS//ntStatus register. The receiving device also sets the RxErrorSticky bit in its ISlintStatus register whenever it detects a CRC error in an incoming packet and is not required 15 to take any further action, as it is up to the transmitting device to detect and rectify the problem. The NumRetries registers in all ISI devices should be set to the same value for consistent operation. Note that successful transmission or reception of ping packets do not affect retransmission operation. Note that a transmit error will cause the ISI to stop transmitting. CPU intervention will be required to 20 resolve the source of the problem and to restart the ISI transmit operation. Receive errors however do not affect receive operation and they are collected to facilitate problem debug and to monitor the quality of the ISI physical channel. Transmit or receive errors should be extremely rare and their occurrence will most likely indicate a serious problem. Note that broadcast packets are never acknowledged to avoid contention on the common ISI lines. 25 If an ISISlave detects an error in a broadcast packet it should use the message passing mechanism described earlier to alert the ISIMaster to the error if it so wishes. 12.4.4.9 Sequence Bit Operation To ensure that communication between transmitting and receiving ISI devices is correctly ordered a sequence bit is included in every long packet to keep both devices in step with each other. The 30 sequence bit field is a constant for short or ping packets as they are not used for data transmission. In addition to the transmitted sequence bit all ISI devices keep two local sequence bits, one for each ISiSub/d. Furthermore each ISI device maintains a transmit sequence bit for each ISld and /S/Sub/d it is in communication with. For packets sourced from the external host (via USB) the transmit sequence bit is contained in the relevant USBEPnDest register while for packets sourced 35 from the CPU the transmit sequence bit is contained in the CPUIS/TxBuffCntr/ register. The sequence bits for received packets are stored in IS/Sub/dOSeq and ISISub/dlSeq registers. All ISI devices will initialize their sequence bits to 0 after reset. It is the responsibility of software to ensure that the sequence bits of the transmitting and receiving ISI devices are correctly initialized each time a new source is selected for any ISld./SISubId channel.
WO 2004/050369 PCT/AU2003/001616 153 Sequence bits are ignored by the receiving ISI device for broadcast packets. However the broadcasting ISI device is free to toggle the sequence in the broadcast packets since they will not affect operation. The SCB will do this for all USB source data so that there is no special treatment for the sequence bit of a broadcast packet in the transmitting device. CPU sourced broadcasts will 5 have sequence bits toggled at the discretion of the program code. Each SoPEC may also ignore the sequence bit on either of its ISISubid channels by setting the appropriate bit in the /S/SubldSeqMask register. The sequence bit should be ignored for ISISubid channels that will carry data that can originate from more than one source and is self ordering e.g. control messages. 10 A receiving ISI device will toggle its sequence bit addressed by the ISiSubid only when the receiver is able to accept data and receives an error-free data packet addressed to it. The transmitting ISI device will toggle its sequence bit for that ISlid.lSISubld channel only when it receives a valid ACK handshake from the addressed IS[ device. Figure 36 shows the transmission of two long packets with the sequence bit in both the transmitting 15 and receiving devices toggling from 0 to 1 and back to 0 again. The toggling operation will continue in this manner in every subsequent transmission until an error condition is encountered. When the receiving 11 device detects an error in the transmitted long packet or is unable to accept the packet (because of full buffers for example) it will not return any packet and it will not toggle its 20 local sequence bit. An example of this is depicted in Figure 37. The absence of any response prompts the transmitting device to retransmit the original (seq=0) packet. This time the packet is received without any errors (or buffer space may have been freed) so the receiving ISI device toggles its local sequence bit and responds with an ACK. The transmitting device then toggles its local sequence bit to a 1 upon correct receipt of the ACK. 25 However it is also possible for the ACK packet from the receiving ISI device to be corrupted and this scenario is shown in Figure 38. In this case the receiving device toggles its local sequence bit to 1 when the long packet is received without error and replies with an ACK to the transmitting device. The transmitting device does not receive the ACK correctly and so does not change its local 30 sequence bit. It then retransmits the seq=0 long packet. When the receiving device finds that there is a mismatch between the transmitted sequence bit and the expected (local) sequence bit is discards the long packet and replies with an ACK. When the transmitting ISI device correctly receives the ACK it updates its local sequence bit to a 1, thus restoring synchronization. Note that when the /S/SubldSeqMask bit for the addressed ISISubld is set then the retransmitted packet is 35 not discarded and so a duplicate packet will be received. The data contained in the packet should be self-ordering and so the software handling these packets (most likely control messages) is expected to deal with this eventuality. 12.4.4.10 Flow Control The ISI also supports flow control by treating it in exactly the same manner as an error in the 40 received packet. Because the SCB enjoys greater guaranteed bandwidth to DRAM than both the ISI WO 2004/050369 PCT/AU2003/001616 154 and USB can supply flow control should not be required during normal operation. Any blockage on a DMA channel will soon result in the NumRetries value being exceeded and transmission from that SoPEC being halted. If a SoPEC NAKs a packet because its RxBuffer is full it will flag an overflow condition. This condition can potentially cause a CPU interrupt, if the corresponding interrupt is 5 enabled. The RxOverflowSticky bit of its ISlntStatus register reflects this condition. Because flow control is treated in the same manner as an error the transmitting ISI device will not be able to differentiate a flow control condition from an error in the transmitted packet. 12.4.4.11 Auto-ping Operation While the CPU of the ISIMaster could send a ping packet by writing the appropriate header to the 10 CPU/S/TxBuffCntrl register it is expected that all ping packets will be generated in the ISI itself. The use of automatically generated ping packets ensures that ISISlaves will be given access to the IS[ bus with a programmable minimum guaranteed frequency in addition to whenever it would otherwise be idle. Five registers facilitate the automatic generation of ping messages within the ISI: PingSchedule0, PingSchedule1, PingSchedule2, IS/TotalPeriod and ISILocalPeriod. Auto-pinging 15 will be enabled if any bit of any of the PingScheduleN registers is set and disabled if all PingScheduleN registers are xO00. Each bit of the 15-bit PingScheduleN register corresponds to an ISlid that is used in the Address field of the ping packet and a 1 in the bit position indicates that a ping packet is to be generated for that ISild. A 0 in any bit position will ensure that no ping packet is generated for that ISlId. As 20 ISISlaves may differ in their bandwidth requirement (particularly if a storage SoPEC is present) three different PingSchedule registers are used to allow an ISISlave receive up to three times the number of pings as another active ISISlave. When the ISIMaster is not sending long packets (sourced from either the CPU or USB in the case of a SoPEC ISIMaster) ISI ping packets will be transmitted according to the pattern given by the three PingScheduleN registers. The IS[ will start 25 with the Isb of PingScheduleO register and work its way from Isb through msb of each of the PingScheduleN registers. When the msb of PingSchedule2 is reached the ISI returns to the lsb of PingScheduleO and continues to cycle through each bit position of each PingScheduleN register. The ISI has more than enough time to work out the destination of the next ping packet while a ping or long packet is being transmitted. 30 With the addition of auto-ping operation we now have three potential sources of packets in an ISIMaster SoPEC: USB, CPU and auto-ping. Arbitration between the CPU and USB for access to the ISI is handled outside the ISI. To ensure that local packets get priority whenever possible and that ping packets can have some guaranteed access to the ISI we use two 4-bit counters whose reload value is contained in the IS/Tota/Period and ISiLocalPeriod registers. As we saw in section 35 12.4.4.1 every IS[ transaction is initiated by the ISIMaster transmitting either a long packet or a ping packet. The IS/TotalPeriod counter is decremented for every ISI transaction (i.e. either long or ping) when its value is non-zero. The /S/LocalPeriod counter is decremented for every local packet that is transmitted. Neither counter is decremented by a retransmitted packet. If the ISITotalPeriod counter is zero then ping packets will not change its value from zero. Both the IS/Tota/Period and WO 2004/050369 PCT/AU2003/001616 155 IS/Loca/Period counters are reloaded by the next local packet transmit request after the IS/TotalPeriod counter has reached zero and this local packet has priority over pings. The amount of guaranteed ISI bandwidth allocated to both local and ping packets is determined by the values of the ISiTotalPerlod and ISILoca/Period registers. Local packets will always be given 5 priority when the ISILocalPeriod counter is non-zero. Ping packets will be given priority when the ISILocalPeriod counter is zero and the ISITotalPeriod counter is still non-zero. Note that ping packets are very likely to get more than their guaranteed bandwidth as they will be transmitted whenever the ISI bus would otherwise be idle (i.e. no pending local packets). In particular when the ISITota/Period counter is zero it will not be reloaded until another local packet is 10 pending and so ping packets transmitted when the IS/TotalPeriod counter is zero will be in addition to the guaranteed bandwidth. Local packets on the other hand will never get more than their guaranteed bandwidth because each local packet transmitted decrements both counters and will cause the counters to be reloaded when the IS/TotalPeriod counter is zero. The difference between the values of the /S/Tota/Period and IS/LocalPeriod registers determines the number of 15 automatically generated ping packets that are guaranteed to be transmitted every IS/TotalPeriod number of ISI transactions. If the IS/Tota/Period and IS/LocalPeriod values are the same then the local packets will always get priority and could totally exclude ping packets if the CPU always has packets to send. For example if IS/TotalPeriod = OxC; ISILocalPeriod = 0x8; PingScheduleO = OxOE; PingSchedule I 20 = OxOC and PingSchedule2 = Ox08 then four ping messages are guaranteed to be sent in every 12 ISI transactions. Furthermore ISild3 will receive 3 times the number of ping packets as ISId1 and ISIld2 will receive twice as many as ISId1. Thus over a period of 36 contended ISI transactions (allowing for two full rotations through the three PingScheduleN registers) when local packets are always pending 24 local packets will be sent, ISId1 will receive 2 ping packets, ISId2 will receive 4 25 pings and ISId3 will receive 6 ping packets. If local traffic is less frequent then the ping frequency will automatically adjust upwards to consume all remaining ISI bandwidth. 12.4.5 Wake-up from Sleep Mode Either the PrintMaster SoPEC or the external host may place any of the ISISlave SoPECs in sleep mode prior to going into sleep mode itself. The ISISlave device should then ensure that its 30 ISiWakeupEnable bit of the WakeupEnable register (see Table 34) is set prior to entering sleep mode. In an ISISlave device the ISI block will continue to receive power and clock during'sleep mode so that it may monitor the gpio isi din lines for activity. When ISI activity is detected during sleep mode and the ISIWakeupEnable bit is set the ISI asserts the isi cprreset n signal. This will bring the rest of the chip out of sleep mode by means of a wakeup reset. See chapter 16 for more 35 details of reset propagation. 12.4.6 Implementation Although the ISI consists of either 2 or 4 ISI data lines over which a serial data stream is demultiplexed, each ISI line is treated as a separate serial link at the physical layer. This permits a certain amount of skew between the ISI lines that could not be tolerated if the lines were treated as WO 2004/050369 PCT/AU2003/001616 156 a parallel bus. A lower Bit Error Rate (BER) can be achieved if the serial data recovery is performed separately on each serial link. Figure 39 illustrates the ISI sub block partitioning. 12.4.6.1 ISI Sub-block Partition * Definition of I/Os. 5 Table 34. ISI 1/0 Port name Pins 1/O Description Clock and Reset isipclk 1 In ISI primary clock. isireset n 1 In ISI reset. Active low. Asserting isiresetn will reset all ISI logic. Synchronous to isi-pclk. Configuration isi_go 1 In ISI GO. Active high. When GO is de-asserted, all ISI statemachines are reset to their idle states, all IS[ output signals are de asserted, but all 131 counters retain their values. When GO is asserted, all ISI counters are reset and all ISI statemachines and output signals will return to their normal mode of operation. isi master select 1 In ISI master select. Determines Whether the SoPEC is an ISIMaster or not 1 = ISIMaster 0 = ISISlave isiid[3:0] 4 In ISI ID for this device. isiretries[3:0] 4 In ISI number of retries. Number of times a transmitting ISI device will attempt retransmission of a NAK'd packet before aborting the transmission and flagging an error. The value of this configuration signal should not be changed while there are valid packets in the Tx buffer. isipingscheduleO[1 15 In ISI auto ping schedule #0. 4 :0] Denotes which ISlids will be receive ping packets. Note that bitO refers to ISIldO, bit1 to ISIlId...bit14 to ISIld14. Setting a bit in this schedule will enable auto ping generation for the corresponding ISI ID. The ISI will start from the bit 0 of isi pingscheduleO and cycle through to bit 14, generating pings for each bit that is set. This operation will be performed in sequence from WO 2004/050369 PCT/AU2003/001616 157 isi ping scheduleO through isi ping schedule2. isi_pingschedulel[1 15 In As per isi ping scheduleO. 4 :0] isipingschedule2[1 15 In As per isi ping schedu/eO. 4 :0] isitotalperiod[3:0] 4 In Reload value of the IS Total Period Counter. isilocalperiod[3:0] 4 In Reload value of the ISI Local Period Counter. isinumberpins 1 In Number of active ISI data pins. Used to select how many serial data pins will be used to transmit and receive data. Should reflect the number of ISI device data pins that are in use. 1 = isidata[3:0] active 0 = isidata[1:0] active isiturnaround[3:0] 4 In ISI bus turn around time in ISI clock cycles (32MHz). isishort replywin[4: 5 In ISI long packet reply window in ISI clock cycles 0] (32MHz). isi longreplywin[8: 9 In ISI long packet reply window in ISI clock cycles 0] (32MHz). isitxenable I In ISI transmit enable. Active high. Enables ISI transmission of long or ping packets. ACKs may still be transmitted when this bit is 0. The value of this configuration signal should not be changed while there are valid packets in the Tx buffer. isi_rxenable 1 In IS[ receive enable. Active high. Enables ISI packet reception. Any activity on the ISI bus will be ignored when this signal is de-asserted. This signal should only be de-asserted if the ISI block is not required for use in the design. isibitstuffrate[3:0] I In ISI bit stuffing limit. Allows the bit stuffing counter value to be programmed. Is loaded into the 4 upper bits of the 7bit wide bit stuffing counter. The lower bits are always loaded with b11, to prevent bit stuffing for less than 7 consecutive ones or zeroes. E.g. bOO : stuff-count = bOO00 11: bit stuff after 7 consecutive 0/1 b11 : stuff-count = b111111 :bit stuff afterl27 consecutive 0/1 Serial Link Signals WO 2004/050369 PCT/AU2003/001616 158 isiserdatain[3:0] 4 In ISI Serial data inputs. Each bit corresponds to a separate serial link. isi ser data_out[3:0] 4 Out ISl Serial data outputs. Each bit corresponds to a separate serial link. isiserdataen[3:0] 4 Out ISI Serial data driver enables. Active high. Each bit corresponds to a separate serial link. Tx Packet Buffer isitxwren 1 In ISI Tx FIFO write enable. Active high. Asserting isitx_ wren will write the 64 bit data on isitx wrdata to the FIFO, providing that space is available in the FIFO. If isi tx wr en remains asserted after the last entry in the current packet is written, the rite operation will wrap around to the start of the next packet, providing that space is available for a second packet in the FIFO. isi tx-wr-data[63:0] 64 In ISI Tx FIFO write data. isi_txping 1 In ISI Tx FIFO ping packet select. Active high. Asserting Isi tx ping will queue a ping packet for transmission, as opposed to a long packet. Although there is no data payload for a ping packet, a packet location in the FIFO is used as a 'place holder' for the ping packet. Any data written to the associated packet location in the FIFO will be discarded when the ping packet is transmitted. isi-tx-id[3:0] 5 In ISI Tx FIFO packet ID. ISI ID for each packet written to the FIFO. Registered when the last entry of the packet is written. isi txsubid 1 In ISI Tx FIFO packet sub ID. ISI sub ID for each packet written to the FIFO. Registered when the last entry of the packet is written. isi_txpktcount[1:0] 2 Out ISI Tx FIFO packet count. Indicates the number of packets contained in the FIFO. The FIFO has a capacity of 2 x 256 bit packets. Range is b00->b10. isi txwordcount[2:0 3 Out ISI Tx FIFO current packet word count. Indicates the number of words contained in the current Tx packet location of the Tx FIFO. Each packet location has a capacity of 4 x 64 bit words. Range is bOO >b100.
WO 2004/050369 PCT/AU2003/001616 159 isitx-empty 1 Out IS[ Tx FIFO empty. Active high. Indicates that no packets are present in the FIFO. isitx-full 1 Out ISI Tx FIFO full. Active high. Indicates that 2 packets are present in the FIFO, therefore no more packets can be transmitted. isi tx over flow 1 Out ISI Tx FIFO over flow. Active high. Indicates that a write operation was performed on a full FIFO. The write operation will have no effect on the contents of the FIFO or the write pointer. isi tx error I Out ISI Tx FIFO error. Active high. Indicates that an error occurred while transmitting the packet currently at the head of the FIFO. This will happen if the number of transmission attempts exceeds is! tx retries. isi-tx-desc[2:0] 3 Out ISI Tx packet descriptor field. ISI packet descriptor field for the packet currently at the head of the FIFO. See Table for details. Only valid when isitx empty=O, i.e. when there is a valid packet in the FIFO. isi-tx-addr[4:0] 5 Out IS1 Tx packet address field. ISI address field for the packet currently at the head of the FIFO. See Table for details. Only valid when isitx empty=0, i.e. when there is a valid packet in the FIFO. Rx Packet FIFO isi rx-rd en 1 In ISI Rx FIFO read enable. Active high. Asserting is!_rxrd_en will drive is!_rxrddata with valid data, from the Rx packet at the head of the FIFO, providing that data is available in the FIFO. If isi rxrden remains asserted after the last entry is ead from the current packet, the read operation will wrap around to the start of the next packet, providing that a second packet is available in the FIFO. isirx-rd-data[63:0] 64 Out ISI Rx FIFO read data. isi rx-sub id 1 Out IS[ Rx packet sub ID. Indicates the ISI sub ID associated with the packet at the head of the Rx FIFO. isirx pkt-count[1:0] 2 Out ISI Rx FIFO packet count. Indicates the number of packets contained in the FIFO.
WO 2004/050369 PCT/AU2003/001616 160 The FIFO has a capacity of 2 x 256 bit packets. Range is b00->b10. isirxwordcount[2:0 3 Out ISI Rx FIFO current packet word count. Indicates the number of words contained in the Rx packet location at the head of the FIFO. Each packet location has a capacity of 4 x 64 bit words. Range is b000->b100. isi_rx empty 1 Out ISI Rx FIFO empty. Active high. Indicates that no packets are present in the FIFO. isirxfull 1 Out ISI Rx FIFO full. Active high. Indicates that 2 packets are present in the FIFO, therefore no more packets can be received. isirxoverflow I Out IS[ Rx FIFO over flow. Active high. Indicates that a packet was addressed to the local iSi device, but the Rx FIFO was full, resulting in a NAK. isi rx under run 1 Out iS1 Rx FIFO under run. Active high. Indicates that a read operation was performed on an empty FIFO. The invalid read will return the contents of -he memory location currently addressed by the FIFO read pointer and will have no effect on the read pointer. isirxframeerror 1 Out ISI Rx framing error. Active high. Asserted by the ISI when a framing error is detected in the received packet, which can be caused by an incorrect Start or Stop field or by bit stuffing errors. The associated packet will be dropped. isirxcrcerror 1 Out ISI Rx CRC error. Active high. Asserted by the ISI when a CRC error is detected in an incoming packet. Other than dropping the errored packet ISI reception is unaffected by a CRC Error. 12.4.6.2 ISI Serial Interface Engine (isisie) There are 4 instantiations of the is!_sie sub block in the ISI, 1 per ISI serial link. The isisie is responsible for Rx serial data sampling, Tx serial data output and bit stuffing. Data is sampled based on a phase detection mechanism. The incoming ISI serial data stream is 5 ov6r sampled 5 times per ISI bit period. The phase of the incoming data is determined by detecting transitions in the ISI serial data stream, which indicates the ISI bit boundaries. An ISI bit boundary is defined as the sample phase at which a transition was detected. The basic functional components of the isi_sie are detailed in Figure 40. These components are simply a grouping of logical functionality and do not necessarily represent hierarchy in the design. 10 12.4.6.2.1 SIE Edge Detection and Data I/O The basic structure of the data I/O and edge detection mechanism is detailed in Figure 41.
WO 2004/050369 PCT/AU2003/001616 161 NOTE: Serial data from the receiver in the pad MUST be synchronized to the isi pc/k domain with a 2 stage shift register external to the ISI, to reduce the risk of metastability. ser data-out and ser_data_en should be registered externally to the 181. The Rx/Tx statemachine drives serdataen, stuffIen and stuff_0_en. The signals stuffIen 5 and stuff_0_en cause a one or a zero to be driven on serdataout when they are asserted, otherwise fifo rd data is selected. 12.4.6.2.2 SIE Rx/Tx Statemachine The Rx/Tx statemachine is responsible for the transmission of ISI Tx data and the sampling of ISI Rx data. Each ISI bit period is 5 isi pclk cycles in duration. 10 The Tx cycle of the Rx/Tx statemachine is illustrated in Figure 42. It generates each ISI bit that is transmitted. States txO->tx4 represent each of the 5 isi pck phases that constitute a Tx ISI bit period. serdataen controls the tristate enable for the ISI line driver in the bidirectional pad, as shown in Figure 41. rxtxcycle is asserted during both Rx and Tx states to indicate an active Rx or Tx cycle. It is primarily used to enable bit stuffing. 15 NOTE: All statemachine signals are assumed to be '0' unless otherwise stated. The Tx cycle for Tx bit stuffing when the Rx/Tx statemachine inserts a '0' into the bitstream can be seen in Figure 43. NOTE: All statemachine signals are assumed to be '0' unless otherwise stated The Tx cycle for Tx bit stuffing when the RxTx statemachine inserts a '1' into the bitstream can be 20 seen in Figure 44. NOTE: All statemachine signals are assumed to be '0' unless otherwise stated The tx* and stuff* states are detailed separately for clarity. They could be easily combined when coding the statemachine, however it would be better for verification and debugging if they were kept separate. 25 The Rx cycle of the ISI Rx/Tx statemachine is detailed in Figure 45. The Rx cycle of the Rx/Tx Statemachine, samples each ISI bit that is received. States rx0->rx4 represent each of the 5 isi pclk phases that constitute a Rx ISI bit period. The optimum sample position for an ideal ISI bit period is 2 isi pclk cycles after the ISI bit boundary sample, which should result in a data sample close to the centre of the ISI bit period. 30 rxsample is asserted during the rx2 state to indicate a valid ISI data sample on rx bit, unless the bit should be stripped when flagged by the bit stuffing statemachine, in which case rxsample is not asserted during rx2 and the bit is not written to the FIFO. When edge is asserted, it resets the Rx cycle to the rx0 state, from any rx state. This is how the isi_sie tracks the phase of the incoming data. The Rx cycle will cycle through states rxO->rx4 until edge is asserted to reset the sample 35 phase, or a tx req is asserted indicating that the ISI needs to transmit. Due to the 5 times oversampling a maximum phase error of 0.4 of an ISI bit period (2 isi pck cycles out of 5) can be tolerated. NOTE: All statemachine signals are assumed to be 'O' unless otherwise stated. An example of the Tx data generation mechanism is detailed in Figure 46. tx req and fifowr_tx are 40 driven by the framer block.
WO 2004/050369 PCT/AU2003/001616 162 An example of the Rx data sampling functional timing is detailed in Figure 47. The dashed lines on the serdatainff signal indicate where the Rx/Tx statemachine perceived the bit boundary to be, based on the phase of the last ISI bit boundary. It can be seen that data is sampled during the same phase as the previous bit was, in the absence of a transition. 5 12.4.6.2.3 SIE Rx/Tx FIFO The Rx/Tx FIFO is a 7 x 1 bit synchronous look-ahead FIFO that is shared for Tx and Rx operations. It is required to absorb any Rx/Tx latency caused by bit stripping/stuffing on a per ISI line basis, i.e. some ISI lines may require bit stripping/stuffing during an ISI bit period while the others may not, which would lead to a loss of synchronization between the data of the different IS[ 10 lines, if a FIFO were not present in each isi_sie. The basic functional components of the FIFO are detailed in Figure 48. tx_ready is driven by the Rx/Tx statemachine and selects which signals control the read and write operations. txready=1 during ISI transmission and selects the fifo_*tx control and data signals. tx ready=0 during ISI reception and selects the fifo_*rx control and data signals. fiforeset is driven by the Rx/Tx 15 statemachine. It is active high and resets the FIFO and associated logic before/after transmitting a packet to discard any residual data. The size of the FIFO is based on the maximum bit stuffing frequency and the size of the shift register used to segment/re-assemble the multiple serial streams in the ISI framing logic. The maximum bit stuffing frequency is every 7 consecutive ones or zeroes. The shift register used is 32 20 bits wide. This implies that the maximum number of stuffed bits encountered in the time it takes to fill/empty the shift register if 4. This would suggest that 4 x 1 bit would be the minimum ideal size of the FIFO. However it is necessary to allow for different skew and phase error between the IS] lines, hence a 7 x I bit FIFO. The FIFO is controlled by the isi_sie during packet reception and is controlled by the isi frame block 25 during packet transmission. This is illustrated in Figure 49. The signal tx ready selects which mode the FIFO control signals operate in. When tx ready=0, i.e. Rx mode, the isi sie control signals rx_sample, fifo rd rx and serdatainff are selected. When txready=1, i.e. Tx mode, the sie_frame control signals fifo wrtx, fifo_rd_x and fifowrdatatx are selected. 12.4.6.3 Bit Stuffing 30 Programmable bit stuffing is implemented in the isisie. This is to allow the system to determine the amount of bit stuffing necessary for a specific ISI system devices. It is unlikely that bit stuffing would be required in a system using a 100ppm rated crystal. However, a programmable bit stuffing implementation is much more versatile and robust. The bit stuffing logic consists of a counter and a statemachine that track the number of consecutive 35 ones or zeroes that are transmitted or received and flags the Rx/Tx statemachine when the bit stuffing limit has been reached. The counter, stuffcount, is a 7 bit counter, which decrements when rx_sample is asserted on a Rx cycle or when fifordtx is asserted on a Tx cycle. The upper 4 bits of stuff count are loaded with isibit stuffrate. The lower 3 bits of stuffcount are always loaded with b11, i.e. for isi bit stuffrate = bOOO, the counter would be loaded with bOO001 11. This is to WO 2004/050369 PCT/AU2003/001616 163 prevent bit stuffing for less than 7 consecutive ones or zeroes. This allows the bit stuffing limit to be set in the range 7->127 consecutive ones or zeroes. NOTE: It is extremely important that a change in the bit stuffing rate, isibitstuff rate, is carefully co-ordinated between ISI devices in a system. It is obvious that ISI devices will not be able to 5 communicate reliably with each other with different bit stuffing settings. It is recommended that all ISI devices in a system default to the safest bit stuffing rate (isi bitstuffrate = bOO) at reset. The system can then co-ordinate the change to an optimum bit stuffing rate. The ISI bit stuffing statemachine Tx cycle is shown in Figure 50. The counter is loaded when stuffcountload is asserted. 10 NOTE: All statemachine signals are assumed to be '0' unless otherwise stated. The ISI bit stuffing statemachine Rx cycle is shown in Figure 51. It should be noted that the statemachine enters the strip state when stuffcount=0x2. This is because the statemachine can only transition to rxO or rx1 when rx sample is asserted as it needs to be synchronized to changes in sampling phase introduced by the Rx/Tx statemachine. Therefore a one or a zero has already 15 been sampled by the time it enters rxO or rx1. This is not the case for the Tx cycle, as it will always have a stable 5 isi_pclk cycles per bit period and relies purely on the data value when entering tx or tx1. The Tx cycle therefore enters stuff or stuff when stuff count=0x1. NOTE: All statemachine signals are assumed to be '0' unless otherwise stated. 12.4.6.4 ISI Framing and CRC sub-block (isi frame) 20 12.4.6.4.1 CRC Generation/Checking A Cyclic Redundancy Checksum (CRC) is calculated over all fields except the start and stop fields for each long or ping packet transmitted. The receiving ISI device will perform the same calculation on the received packet to verify the integrity of the packet. The procedure used in the CRC generation/checking is the same as the Frame Checking Sequence (FCS) procedure used in 25 HDLC, detailed in ITU-T Recommendation T30[39]. For generation/checking of the CRC field, the shift register illustrated in Figure 52 is used to perform the modulo 2 division on the packet contents by the polynomial G(x) = x1 6 + x 1 2 + x 5 +1. To generate the CRC for a transmitted packet, where T(x) = [Packet Descriptor field, Address field, Data Payload field] (a ping packet will not contain a data payload field). 30 9 Set the shift register to OxFFFF. * Shift T(x) through the shift register, LSB first. This can occur in parallel with the packet transmission. e Once the each bit of T(x) has been shifted through the register, it will contain the remainder of the modulo 2 division T(x)/G(x). 35 - Perform a ones complement of the register contents, giving the CRC field which is transmitted MSB first, immediately following the last bit of M(x To check the CRC for a received packet, where R(x) = [Packet Descriptor field, Address field, Data Payload field, CRC field] (a ping packet will not contain a data payload field). * Set the shift register to OxFFFF.
WO 2004/050369 PCT/AU2003/001616 164 * Shift R(x) through the shift register, LSB first. This can occur in parallel with the packet reception. * Once each bit of the packet has been shifted through the register, it will contain the remainder of the modulo 2 division R(x)IG(x). 5 9 The remainder should equal b0001 110100001111, for a packet without errors. 12.5 CTRL (CONTROL SUB-BLOCK) 12.5.1 Overview The CTRL is responsible for high level control of the SCB sub-blocks and coordinating access between them. All control and status registers for the SCB are contained within the CTRL and are 10 accessed via the CPU interface. The other major components of the CTRL are the SCB Map logic and the DMA Manager logic. 12.5.2 SCB Mapping In order to support maximum flexibility when moving data through a multi-SoPEC system it is possible to map any USB endpoint onto either DMAChannel within any SoPEC in the system. 15 The SCB map, and indeed the SCB itself is based around the concept of an ISlid and an ISISubld. Each SoPEC in the system has a unique ISIld and two ISISubids, namely ISISubIdO and ISISubId1. We use the convention that ISISubIdO corresponds to DMAChanne0 in each SoPEC and ISISubid1 corresponds to DMAChannell. The naming convention for the ISIld is shown in Table 35 below and this would correspond to a multi-SoPEC system such as that shown in Figure 27. We use the 20 term ISild instead of SoPECId to avoid confusion with the unique ChiplD used to create the SoPECid and SoPEC idkey (see chapter 17 and [9] for more details). Table 35. ISlld naming convention ISild SoPEC to which it refers 0 - 14 Standard device ISilds (0 is the power-on reset value) 15 Broadcast ISild 25 The combined ISIld and ISISubId therefore allows the ISI to address DMAChannelO or DMAChannell on any SoPEC device in the system. The ISI, DMA manager and SCB map hardware use the ISIld and ISISubId to handle the different data streams that are active in a multi SoPEC system as does the software running on the CPU of each SoPEC. In this document we will identify DMAChannels as IS/x.y where x is the ISlid and y is the ISISubid. Thus IS12.1 refers to 30 DMAChannell of ISISlave2. Any data sent to a broadcast channel, i.e. IS115.0 or IS115.1, are received by every ISI device in the system including the ISIMaster (which may be an ISI-Bridge). The USB device controller and software stacks however have no understanding of the ISlld and ISISubId but the Silverbrook printer driver software running on the external host does make use of the ISIld and ISISubid. USB is simply used as a data transport - the mapping of USB device 35 endpoints onto ISlld and Subid is communicated from the external host Silverbrook code to the SoPEC Silverbrook code through USB control (or possibly bulk data) messages i.e. the mapping WO 2004/050369 PCT/AU2003/001616 165 information is simply data payload as far as USB is concerned. The code running on SoPEC is responsible for parsing these messages and configuring the SCB accordingly. The use of just two DMAChannels places some limitations on what can be achieved without software intervention. For every SoPEC in the system there are more potential sources of data than 5 there are sinks. For example an ISISlave could receive both control and data messages from the ISIMaster SoPEC in addition to control and data from the external host, either specifically addressed to that particular ISISlave or over the broadcast ISI channel. However all ISISlaves only have two possible data sinks, i.e. DMAChannelO and DMAChannell. Another example is the ISIMaster in a multi-SoPEC system which may receive control messages from each SoPEC in 10 addition to control and data information from the external host (e.g. over USB). In this case all of the control messages are in contention for access to DMAChannelO. We resolve these potential conflicts by adopting the following conventions: 1) Control messages may be interleaved in a memory buffer: The memory buffer that the DMAChannelO points to should be regarded as a central pool of control messages. Every control 15 message must contain fields that identify the size of the message, the source and the destination of the control message. Control messages may therefore be multiplexed over a DMAChannel which allows several control message sources to address the same DMAChannel. Furthermore, if SoPEC-type control messages contain source and destination fields it is possible for the external host to send control messages to individual SoPECs over the IS115.0 broadcast channel. 20 2) Data messages should not be interleaved in a memory buffer: As data messages are typically part of a much larger block of data that is being transferred it is ndt possible to control their contents in the same manner as is possible with the control messages. Furthermore we do not want the CPU to have to perform reassembly of data blocks. Data messages from different sources cannot be interleaved over the same DMAChannel - the SCB map must be reconfigured each time a different 25 data source is given access to the DMAChannel. 3) Every reconfiguration of the SCB map requires the exchange of control messages: SoPEC's SCB map reset state is shown in Table and any subsequent modifications to this map require the exchange of control messages between the SoPEC and the external host. As the external host is expected to control the movement of data in any SoPEC system it is anticipated that all changes to 30 the SCB map will be performed in response to a request from the external host. While the SoPEC could autonomously reconfigure the SCB map (this is entirely up to the software running on the SoPEC) it should not do so without informing the external host in order to avoid data being mis routed. An example of the above conventions in operation is worked through in section 12.5.2.3. 35 12.5.2.1 SCB map rules The operation of the SCB map is described by these 2 rules: Rule 1: A packet is routed to the DMA manager if it originates from the USB device core and has an ISild that matches the local SoPEC ISlid. Rule 2: A packet is routed to the ISI if it originates from the CPU or has an ISild that does not match 40 the local SoPEC ISild.
WO 2004/050369 PCT/AU2003/001616 166 If the CPU erroneously addresses a packet to the ISild contained in the ISIld register (i.e. the ISlIld of the local SoPEC) then that packet will be transmitted on the ISI rather than be sent to the DMA manager. While this will usually cause an error on the ISI there is one situation where it could be beneficial, namely for initial dialog in a 2 SoPEC system as both devices come out of reset with an 5 ISild of 0. 12.5.2.2 External host to ISIMaster SoPEC communication Although the SCB map configuration is independent of ISIMaster status, the following discussion on SCB map configurations assumes the ISIMaster is a SoPEC device rather than an ISI bridge chip, and that only a single USB connection to the external host is present. The information should apply 10 broadly to an ISI-Bridge but we focus here on an ISIMaster SoPEC for clarity. As the ISIMaster SoPEC represents the printer device on the PC USB bus it is required by the USB specification to have a dedicated control endpoint, EPO. At boot time the ISIMaster SoPEC will also require a bulk data endpoint to facilitate the transfer of program code from the external host. The simplest SCB map configuration, i.e. for a single stand-alone SoPEC, is sufficient for external host 15 to ISIMaster SoPEC communication and is shown in Table 36. Table 36. Single SoPEC SCB map configuration Source Sink EPO ISl0.0 EP1 IS10.1 E P2 no EP3 nc EP4 nc In this configuration all USB control information exchanged between the external host and SoPEC over EPO (which is the only bidirectional USB endpoint). SoPEC specific control information (printer 20 status, DNC info etc.) is also exchanged over EPO. All packets sent to the external host from SoPEC over EPO must be written into the DMA mapped EP buffer by the CPU (LEON-PC dataflow in Figure 29). All packets sent from the external host to SoPEC are placed in DRAM by the DMA Manager, where they can be read by the CPU (PC-DIU dataflow in Figure 29). This asymmetry is because in a multi-SoPEC environment the CPU will need 25 to examine all incoming control messages (i.e. messages that have arrived over DMAChannelo) to ascertain their source and destination (i.e. they could be from an ISISlave and destined for the external host) and so the additional overhead in having the CPU move the short control messages to the EPO FIFO is relatively small. Furthermore we wish to avoid making the SCB more complicated than necessary, particularly when there is no significant performance gain to be had as 30 the control traffic will be relatively low bandwidth. The above mechanisms are appropriate for the types of communication outlined in sections 12.1.2.1.1 through 12.1.2.1.4 12.5.2.3 Broadcast communication WO 2004/050369 PCT/AU2003/001616 167 The SCB configuration for broadcast communication is also the default, post power-on reset, configuration for SoPEC and is shown in Table 37. 5 Table 37. Default SoPEC SCB map configuration Source Sink EPO ISIO.O EP1 ISIO.1 EP2 IS115.0 EP3 1S115.1 EP4 1811.1 USB endpoints EP2 and EP3 are mapped onto ISISubIDO and ISISubId1 of ISIld1 5 (the broadcast ISlId channel). EPO is used for control messages as before and EPi is a bulk data endpoint for the 10 ISIMaster SoPEC. Depending on what is convenient for the boot loader software, EP1 may or may not be used during the initial program download, but EP1 is highly likely to be used for compressed page or other program downloads later. For this reason it is part of the default configuration. In this setup the USB device configuration will take place, as it always must, by exchanging messages over the control channel (EPO). 15 One possible boot mechanism is where the external host sends the bootloader1 program code to all SoPECs by broadcasting it over EP3. Each SoPEC in the system then authenticates and executes the bootloader1 program. The ISIMaster SoPEC then polls each ISISlave (over the lSIx.0 channel). Each ISISlave ascertains its ISild by sampling the particular GPIO pins required by the bootloader1 and reporting its presence and status back to the ISIMaster. The ISIMaster then passes this 20 information back to the external host over EPO. Thus both the external host and the ISIMaster have knowledge of the number of SoPECs, and their ISIlds, in the system. The external host may then reconfigure the SCB map to better optimise the SCB resources for the particular multi-SoPEC system. This could involve simplifying the default configuration to a single SoPEC system or remapping the broadcast channels onto DMAChannels in individual ISISlaves. 25 The following steps are required to reconfigure the SCB map from the configuration depicted in Table to one where EP3 is mapped onto ISI1.0: 1) The external host sends a control message(s) to the ISIMaster SoPEC requesting that USB EP3 be remapped to 1811.0 2) The ISIMaster SoPEC sends a control message to the external host informing it that EP3 has 30 now been mapped to IS11.0 (and therefore the external host knows that the previous mapping of IS115.1 is no longer available through EP3). 3) The external host may now send control messages directly to ISISlavel without requiring any CPU intervention on the ISIMaster SoPEC 12.5.2.4 Extemal host to ISISlave SoPEC communication WO 2004/050369 PCT/AU2003/001616 168 If the ISIMaster is configured correctly (e.g. when the ISIMaster is a SoPEC, and that SoPEC's SCB map is configured correctly) then data sent from the external host destined for an ISISlave will be transmitted on the ISI with the correct address. The ISI automatically forwards any data addressed to it (including broadcast data) to the DMA channel with the appropriate ISISubid. If the ISISlave 5 has data to send to the external host it must do so by sending a control message to the ISIMaster identifying the external host as the intended recipient. It is then the ISIMaster's responsibility to forward this message to the external host. With this configuration the external host can communicate with the ISISlave via broadcast messages only and this is the mechanism by which the bootloader1 program is downloaded. The 10 ISISlave is unable to communicate with the external host (or the ISIMaster) until the bootlloader1 program has successfully executed and the ISISlave has determined what its ISild is. After the bootloader1 program (and possibly other programs) has executed the SCB map of the ISIMaster may be reconfigured to reflect the most appropriate topology for the particular multi-SoPEC system it is part of. 15 All communication from an ISISlave to external host is either achieved directly (if there is a direct USB connection present for example) or by sending messages via the ISIMaster. The ISISlave can never initiate communication to the external host. If an ISISlave wishes to send a message to the external host via the ISIMaster it must wait until it is pinged by the ISiMaster and then send a the message in a long packet addressed to the ISIMaster. When the ISIMaster receives the message 20 from the ISISlave it first examines it to determine the intended destination and will then copy it into the EPO FIFO for transmission to the external host. The software running on the ISIMaster is responsible for any arbitration between messages from different sources (including itself) that are all destined for the external host. The above mechanisms are appropriate for the types of communication outlined in sections 25 12.1.2.1.5 and 12.1.2.1.6. 12.5.2.5 ISIMaster to ISISlave communication All ISIMaster to ISISlave communication takes place over the ISI. Immediately after reset this can only be by means of broadcast messages. Once the bootloader1 program has successfully executed on all SoPECs in a multi-SoPEC system the ISIMaster can communicate with each 30 SoPEC on an individual basis. If an ISISlave wishes to send a message to the ISIMaster it may do so in response to a ping packet from the ISIMaster. When the ISIMaster receives the message from the ISISlave it must interpret the message to determine if the message contains information required to be sent to the external host. In the case of the ISIMaster being a SoPEC, software will transfer the appropriate information 35 into the EPO FIFO for transmission to the external host. The above mechanisms are appropriate for the types of communication outlined in sections 12.1.2.3.3 and 12.1.2.3.4. 12.5.2.6 IS/Slave to ISISlave communication ISISlave to ISISlave communication is expected to be limited to two special cases: (a) when the 40 PrintMaster is not the ISIMaster and (b) when a storage SoPEC is used. When the PrintMaster is WO 2004/050369 PCT/AU2003/001616 169 not the ISIMaster then it will need to send control messages (and receive responses to these messages) to other ISISlaves. When a storage SoPEC is present it may need to send data to each SoPEC in the system. All ISISlave to ISISlave communication will take place in response to ping messages from the ISIMaster. 5 12.5.2.7 Use of the SCB map in an ISISlave with a external host connection After reset any SoPEC (regardless of ISIMaster/Slave status) with an active USB connection will route packets from EPO,1 to DMA channels 0,1 because the default SCB map is to map EPO to 1Sld0.0 and EP1 to ISlId0.1 and the default ISlid is 0. At some later time the SoPEC learns its true ISlId for the system it is in and re-configures its ISIld and SCB map registers accordingly. Thus if 10 the true ISild is 3 the external host could reconfigure the SCB map so that EPO and EPI (or any other endpoints for that matter) map to ISlId3.0 and 3.1 respectively. The co-ordination of the updating of the ISild registers and the SCB map is a matter for software to take care of. While the AutoMasterEnable bit of the /S/Cntr/ register is set the external host must not send packets down EP2-4 of the USB connection to the device intended to be an ISISlave. When AutoMasterEnable 15 has been cleared the external host may send data down any endpoint of the USB connection to the ISISlave. The SCB map of an ISISlave can be configured to route packets from any EP to any ISIld.ISISubld (just as an ISIMaster can). As with an ISIMaster these packets will end up in the SCBTxBuffer but while an ISIMaster would just transmit them when it got a local access slot (from ping arbitration) 20 the ISiSlave can only transmit them in response to a ping. All this would happen without CPU intervention on the ISISlave (or ISIMaster) and as long as the ping frequency is sufficiently high it would enable maximum use of the bandwidth on both USB buses. 12.5.3 DMA Manager The DMA manager manages the flow of data between the SCB and the embedded DRAM. Whilst 25 the CPU could be used for the movement of data in SoPEC, a DMA manager is a more efficient solution as it will handle data in a more predictable fashion with less latency and requiring less buffering. Furthermore a DMA manager is required to support the ISI transfer speed and to ensure that the SoPEC could be used with a high speed ISI-Bridge chip in the future. The DMA manager utilizes 2 write channels (DMAChannelO, DMAChannell) and 1 read/write 30 channel (DMAChannel2) to provide 2 independent modes of access to DRAM via the DIU interface: * USBD/ISI type access. * USBH type access. DIU read and write access is in bursts of 4x64 bit words. Byte aligned write enables are provided for write access. Data for DIU write accesses will be read directly from the buffers contained in the 35 respective SCB sub-blocks. There is no internal SCB DMA buffer. The DMA manager handles all issues relating to bytel word/longword address alignment, data endianness and transaction scheduling. If a DMA channel is disabled during a DMA access, the access will be completed. Arbitration will be performed between the following DIU access requests: * USBD write request. 40 * ISI write request.
WO 2004/050369 PCT/AU2003/001616 170 e USBH write request. * USBH read request. DMAChannel0 will have absolute priority over any DMA requestors. In the absence of DMAChannelO DMA requests, arbitration will be performed in a round robin manner, on a per cycle 5 basis over the other channels. 12.5.3.1 DMA Effective Bandwidth The DIU bandwidth available to the DMA manager must be set to ensure adequate bandwidth for all data sources, to avoid back pressure on the USB and the ISI. This is achieved by setting the output (i.e. DIU) bandwidth to be greater than the combined input bandwidths (i.e. USBD + USBH + ISI). 10 The required bandwidth is expected to be 160 Mbits/s (1 bit/cycle @ 160MHz). The guaranteed DIU bandwidth for the SCB is programmable and may need further analysis once there is better knowledge of the data throughput from the USB IP cores. 12.5.3.2 USBD/ISI DMA access The DMA manager uses the two independent unidirectional write channels for this type of DMA 15 access, one for each ISISubId, to control the movement of data. Both DMAChannelO and DMAChannell only support write operation and can transfer data from any USB device DMA mapped EP buffer and from the ISI receive buffer to separate circular buffers in DRAM, corresponding to each DMA channel. While the DMA manager performs the work of moving data the CPU controls the destination and 20 relative timing of data flows to and from the DRAM. The management of the DRAM data buffers requires the CPU to have accurate and timely visibility of both the DMA and PEP memory usage. In other words when the PEP has completed processing of a page band the CPU needs to be aware of the fact that an area of memory has been freed up to receive incoming data. The management of these buffers may also be performed by the external host. 25 12.5.3.2.1 Circular buffer operation The DMA manager supports the use of circular buffers for both DMAChannels. Each circular buffer is controlled by 5 registers: DMAnBottomAdr, DMAnTopAdr, DMAnMaxAdr, DMAnCurrWPtr and DMAnlntAdr. The operation of the circular buffers is shown in Figure 53 below. Here we see two snapshots of the status of a circular buffer with (b) occurring sometime after (a) 30 and some CPU writes to the registers occurring in between (a) and (b). These CPU writes are most likely to be as a result of a finished band interrupt (which frees up buffer space) but could also have occurred in a DMA interrupt service routine resulting from DMAn/ntAdr being hit. The DMA manager will continue filling the free buffer space depicted in (a), advancing the DMAnCurrWPtr after each write to the DIU. Note that the DMACurrWPtr register always points to the next address the DMA 35 manager will write to. When the DMA manager reaches the address in DMAn/ntAdr (i.e. DMACurrWPtr = DMAnIntAdr) it will generate an interrupt if the DMAnlntAdrMask bit in the DMAMask register is set. The purpose of the DMAnIntAdr register is to alert the CPU that data (such as a control message or a page or band header) has arrived that it needs to process. The interrupt routine servicing the DMA interrupt will change the DMAn/ntAdr value to the next location 40 that data of interest to the CPU will have arrived by.
WO 2004/050369 PCT/AU2003/001616 171 In the scenario shown in Figure 53 the CPU has determined (most likely as a result of a finished band interrupt) that the filled buffer space in (a) has been freed up and is therefore available to receive more data. The CPU therefore moves the DMAnMaxAdr to the end of the section that has been freed up and moves the DMAn/ntAdr address to an appropriate offset from the DMAnMaxAdr 5 address. The DMA manager continues to fill the free buffer space and when it reaches the address in DMAnTopAdr it wraps around to the address in DMAnBottomAdr and continues from there. DMA transfers will continue indefinitely in this fashion until the DMA manager reaches the address in the DMAnMaxAdr register. The circular buffer is initialized by writing the top and bottom addresses to the DMAnTopAdr and 10 DMAnBottomAdr registers, writing the start address (which does not have to be the same as the DMAnBottomAdr even though it usually will be) to the DMAnCurrWPtr register and appropriate addresses to the DMAnIntAdr and DMAnMaxAdr registers. The DMA operation will not commence until a I has been written to the relevant bit of the DMA ChanEn register. While it is possible to modify the DMAnTopAdr and DMAnBottomAdr registers after the DMA has 15 started it should be done with caution. The DMAnCurrWPtr register should not be written to while the DMAChannel is in operation. DMA operation may be stalled at any time by clearing the appropriate bit of the DMA ChanEn register or by disabling an SCB mapping or ISI receive operation. 12.5.3.2.2 Non-standard buffer operation 20 The DMA manager was designed primarily for use with a circular buffer. However because the DMA pointers are tested for equality (i.e. interrupts generated when DMAnCurrWPtr = DMA/ntAdr or DMAnCurrWPtr = DMAMaxAdr) and no bounds checking is performed on their values (i.e. neither DMAn~ntAdr nor DMAnMaxAdr are checked to see if they lie between DMAnBottomAdr and DMAnTopAdr) a number of non-standard buffer arrangements are possible. These include: 25 e Dustbin buffer: If DMAnBottomAdr, DMAnTopAdr and DMAnCurrWPtr all point to the same location and both DMAn/ntAdr and DMAnMaxAdr point to anywhere else then all data for that DMA channel will be dumped into the same location without ever generating an interrupt. This is the equivalent to writing to /dev/null on Unix systems. * Linear buffer: If DMAnMaxAdr and DMAnTopAdr have the same value then the DMA 30 manager will simply fill from DMAnBottomAdr to DMAnTopAdr and then stop. DMAnintAdr should be outside this buffer or have its interrupt disabled. 12.5.3.3 USBH DMA access The USBH requires DMA access to DRAM in to provide a communication channel between the USB HC and the USB HCD via a shared memory resource. The DMA manager uses two 35 independent channels for this type of DMA access, one for reads and one for writes. The DRAM addresses provided to the DIU interface are generated based on addresses defined in the USB HC core operational registers, in USBH section 12.3. 12.5.3.4 Cache coherency As the CPU will be processing some of the data transferred (particularly control messages and 40 pagelband headers) into DRAM by the DMA manager, care needs to be taken to ensure that the WO 2004/050369 PCT/AU2003/001616 172 data it uses is the most recently transferred data. Because the DMA manager will be updating the circular buffers in DRAM without the knowledge of the cache controller logic in the LEON CPU core the contents of the cache can become outdated. This situation can be easily handled by software, for example by flushing the relevant cache lines, and so there is no hardware support to enforce 5 cache coherency. 12.5.4 ISI transmit buffer arbitration The SCB control logic will arbitrate access to the ISI transmit buffer (ISITxBuffer) interface on the ISI block. There are two sources of ISI Tx packets: 1 CPUISITxBuffer, contained in the SCB control block. 10 . ISI mapped USB EP OUT buffers, contained in the USB device block. This arbitration is controlled by the /S/TxBuffArb register which contains a high priority bit for both the CPU and the USB. If only one of these bits is set then the corresponding source always has priority. Note that if the CPU is given absolute priority over the USB, then the software filling the ISI transmit buffer needs to ensure that sufficient USB traffic is allowed through. If both bits of the 15 IS/TxBufferArb have the same value then arbitration will take place on a round robin basis. The control logic will use the USBEPnDest registers, as it will use the CPU/S/TxBuffCntr/ register, to determine the destination of the packets in these buffers. When the ISITxBuffer has space for a packet, the SCB control logic will immediately seek to refill it. Data will be transferred directly from the CPUISITxBuffer and the ISI mapped USB EP OUT buffers to the ISITxBuffer without any 20 intermediate buffering. As the speed at which the lSlTxBuffer can be emptied is at least 5 times greater than it can be filled by USB traffic, the ISI mapped USB EP OUT buffers should not overflow using the above scheme in normal operation. There are a number of scenarios which could lead to the USB EPs being temporarily blocked such as the CPU having priority, retransmissions on the ISI bus, channels 25 being enabled (Channe/En bit of the USBEPnDest register) with data already in their associated endpoint buffers or short packets being sent on the USB. Care should be taken to ensure that the USB bandwidth is efficiently utilised at all times. 12.5.5 Implementation 12.5.5.1 CTRL Sub-block Partition 30 * Block Diagram * Definition of I/Os 12.5.5.2 SCB Configuration Registers The SCB register map is listed in Table 38. Registers are grouped according to which SCB sub block their functionality is associated. All configuration registers reside in the CTRL sub-block. The 35 Reset values in the table indicates the 32 bit hex value that will be returned when the CPU reads the associated address location after reset. All Registers pre-fixed with Hc refer to Host Controller Operational Registers, as defined in the OHCI Spec[19]. The SCB will only allow supervisor mode accesses to data space (i.e. cpuacode[1:0] = b 1). All other accesses will result in scb cpu berr being asserted.
WO 2004/050369 PCT/AU2003/001616 173 TDB: Is read access necessary for IS] Rx/Tx buffers? Could implement the ISI interface as simple FIFOs as opposed to a memory interface. Table 38. SCB control block configuration registers Addre ss OffsetRegister Bits Reset Description CTRL Ox000 SCBResetN 4 OxOOOOOOOF SCB software reset. Allows individual sub-blocks to be reset separately or together. Once a reset for a block has been initiated, by writing a 0 to the relevant register field, it can not be suppressed. Each field will be set after reset. Writing x0 to the SCBReset register will have the same effect as CPR generated hardware reset. Ox004 SCBGo 2 x00000000 SCB Go. Allows the ISI and CTRL sub-blocks to be selected separately or together. When go is de-asserted for a particular sub-block, its statemachines are reset to their idle states and its interface signals are de-asserted. The sub-block counters and configuration registers retain their values. When go is asserted for a particular sub-block, its counters are reset. The sub-block configuration registers retain their values, i.e. they don't get reset. The sub-block statemachines and interface signals will return to their normal mode of operation. The CTRL field should be de-asserted before disabling the clock from any part of the SCB to avoid erroneous SCB DMA requests when the clock is enabled again. NOTE: This functionality has not been provided for the USBH and USBD sub- WO 2004/050369 PCT/AU2003/001616 174 blocks because of the USB IP cores that they contain. We do not have direct control over the IP core statemachines and counters, and it would cause unpredictable behaviour if the cores were disabled in this way during operation. Ox008 SCBWakeupEn 2 OxOOOOOOOO USB/ISI WakeUpEnable register Ox00C SCBISITxBufferAr 2 OxOOOOOOOO ISI transmit buffer access priority b register. Ox010 SCBDebugSel[1 1: 10 OxOOOO00 SCB Debug select register. 2] 0x014 USBEPODest 7 0x00000020 This register determines which of the data sinks the data arriving in EPO should be routed to. Ox018 USBEPIDest 7 0x00000021 Data sink mapping for USB EP1 Ox01C USBEP2Dest 7 0x0000003E Data sink mapping for USB EP2 0x020 USBEP3Dest 7 0x0000003F Data sink mapping for USB EP3 0x024 USBEP4Dest 7 0x00000023 Data sink mapping for USB EP4 0x028 DMA0BottomAdr[217 DMAChanneO bottom address register. 1:5] OxO2C DMAOTopAdr[21:5 17 DMAChannelO top address register. ] 0x030 DMAOCurrWPtr[21 17 DMAChannelO current write pointer. :5] 0x034 DMAOntAdr[21:5] 17 DMAChannelO interrupt address register. Ox038 DMAOMaxAdr[21: 17 DMAChannelO max address register. 5] OxO3C DMA1 BottomAdr[2 17 As per DMAOBottomAdr. 1:5] 0x040 DMA1TopAdr[21:5 17 As per DMAOTopAdr. ] 0x044 DMA1CurrWPtr[21 17 As per DMAOCurrWPtr. :5] 0x048 DMA1IntAdr[21:5] 17 As per DMAOIntAdr. OxO4C DMA1MaxAdr[21: 17 As per DMAOMaxAdr. 5] OxO5O DMAAccessEn 3 0x00000003 DMA access enable.
WO 2004/050369 PCT/AU2003/001616 175 0x054 DMAStatus 4 Ox0OOOO0 DMA status register. Ox058 DMAMask 4 OxOOOOOOOO DMA mask register. OxO5C - 0x098 CPUISITxBuff[7:0] 32x8 n/a CPU ISI transmit buffer. 32-byte packet buffer, containing the payload of a CPU sourced packet destined for transmission over the ISI. The CPU has full write access to the CPUISITxBuff. NOTE: The CPU does not have read access to CPUISITxBuff. This is because the CPU is the source of the data and to avoid arbitrating read access between the CPU and the CTRL sub-block. Any CPU reads from this address space will return Ox00000000. Ox09C CPUISITxBuffCtrl 9 0x00000000 CPU ISI transmit buffer control register. USBD Ox100 USBDIntStatus 19 0x00000000 USBD Interrupt event status register. Ox104 USBDISIFIFOStat 16 0x0000000 USBD ISI mapped OUT EP packet us FIFO status register. Ox108 USBDDMAOFIFO 8 OxOOOOO0 USBD DMAChanne0 mapped OUT EP Status packet FIFO status register. OxIOC USBDDMA1FIFO 8 0x00000000 USBD DMAChannell mapped OUT EP Status packet FIFO status register. Ox110 USBDResume 1 OxOOOOOOOO USBD core resume register. Ox114 USBDSetup 4 0x00000000 USBD setup/configuration register. Oxi 18 - OxI 54 USBDEpOinBuff{I 32x16 n/a USBD EPO-IN buffer. 5:0] 64-byte packet buffer in the, containing he payload of a USB packet destined for EPO-IN. The CPU has full write access to the USBDEpOlnBuff. NOTE: The CPU does not have read access to USBDEpOlnBuff. This is because the CPU is the source of the data and to avoid arbitrating read access between the CPU and the USB device core. Any CPU reads from this WO 2004/050369 PCT/AU2003/001616 176 address space will return OxOOOOOOOO. Ox158 USBDEpOnBuffCt 1 OxOOOOOOOO USBD EPO-IN buffer control register. ri Ox1 5C - 0x1 98 USBDEp5nBuff[1 32x16 n/a USBD EPS-IN buffer. 5:0] As per USBDEpO/nBuff. Ox19C USBDEp5lnBuffCt 1 Ox0000000 USBD EP5-IN buffer control register. rl OxIA0 USBDMask 19 OxO000000 USBD interrupt mask register. Ox1A4 USBDDebug 30 Ox0000000 USBD debug register. USBH Ox200 HcRevision Refer to [191 for #Bits, Reset, Description. Ox204 HcControl Refer to [19] for #Bits, Reset, Description. Ox208 HcCommandStatu Refer to [19] for #Bits, Reset, s Description. Ox20C HclnterruptStatus Refer to [19] for #Bits, Reset, Description. Ox210 HclnterruptEnable Refer to [19] for #Bits, Reset, Description. Ox214 HclnterruptDisable Refer to [19] for #Bits, Reset, Description. Ox218 HcHCCA Refer to [19] for #Bits, Reset, Description. Ox21C HcPeriodCurrentE Refer to [19] for #Bits, Reset, D Description. Ox220 HcControlHeadED Refer to [19] for #Bits, Reset, Description. Ox224 HcControlCurrent Refer to [19] for #Bits, Reset, ED Description. Ox228 HcBulkHeadED Refer to [19] for #Bits, Reset, Description. Ox22C HcBulkCurrentED Refer to [19] for #Bits, Reset, Description. 0x230 HcDoneHead Refer to [19] for #Bits, Reset, Description. 0x234 HcFminterval Refer to [19] for #Bits, Reset, Description. 3x238 HcFmRemaining Refer to [19] for #Bits, Reset, WO 2004/050369 PCT/AU2003/001616 177 Description. Ox23C HcFmNumber Refer to [19] for #Bits, Reset, Description. Ox240 HcPeriodicStart Refer to [19] for #Bits, Reset, Description. Ox244 HcLSTheshold Refer to [19] for #Bits, Reset, Description. 0x248 HcRhDescriptorA Refer to [19] for #Bits, Reset, Description. Ox24C HcRhDescriptorB Refer to [191 for #Bits, Reset, Description. Ox250 HcRhStatus Refer to [191 for #Bits, Reset, Description. Ox254 HcRhPortStatus[1] Refer to [19] for #Bits, Reset, Description. Ox258 USBHStatus 3 OxOOOOOOOO USBH status register. Ox25C USBHMask 2 Ox00000000 USBH interrupt mask register. Ox260 USBHDebug 2 OxOOOOOOOO USBH debug register. ISI 0x300 ISICntrl 4 OxOOOOOOOB ISI Control register 0x304 ISIld 4 OxOOOOOOOO ISIld for this SoPEC. Ox308 ISINumRetries 4 0x00000002 Number of IS[ retransmissions register. Ox3OC ISIPingScheduleO 15 OxOOOOOOOO ISI Ping schedule 0 register. Ox310 ISIPingSchedulel 15 OxOOOOOOOO ISI Ping schedule 1 register. Ox314 ISIPingSchedule2 15 OxOOOOOOOO ISI Ping schedule 2 register. Ox318 ISITotalPeriod 4 OxOOOOOOOF Reload value of the /S/Tota/Period counter. Ox31C ISILocalPeriod 4 OxOOOO0F Reload value of the ISILoca/Period counter. Ox320 lSllntStatus 4 OxOOOOOOOO ISI interrupt status register. Ox324 iSITxBuffStatus 27 OxOOOOO0 ISI Tx buffer status register. Ox328 ISIRxBuffStatus 27 OxOOOOOOOO ISI Rx buffer status register. Ox32C ISIMask 4 OxOOOOOOOO ISI Interrupt mask register. Ox330 - 0x34C ISITxBuffEntryO[7: 32x8 n/a ISI transmit Buff, packet entry #0. 0] 32-byte packet entry in the ISITxBuff, containing the payload of an ISI Tx packet. CPU read access to ISITxBuffEntryO is provided for observability only i.e. CPU WO 2004/050369 PCT/AU2003/001616 178 reads of the ISITxBuffEntryo do not alter the state of the buffer. The CPU does not have write access to the ISITxBuffEntryO. Ox350 - Ox36C ISITxBuffEntryl [7: 32x8 n/a ISI transmit Buff, packet entry #1. 0] As per ISITxBuffEntryo. 0x370 - Ox38C ISlRxBuffEntryO[7: 32x8 n/a ISI receive Buff, packet entry #0. 0] 32-byte packet entry in the ISIRxBuff, containing the payload of an ISI Rx packet. Note that the only error-free long packets are placed in the ISIRxBuffEntryO. Both ping and ACKs are consumed in the ISI. CPU access to ISIRxBuffEntryO is provided for observability only i.e. CPU reads of the ISIRxBuffEntryO do not alter the state of the buffer. 0x390 - Ox3AC ISIRxBuffEntryl [7: 32x8 n/a ISI receive Buff, packet entry #1. 0] As per ISIRxBuffEntryO. Ox3BO ISISubldOSeq 1 OxOOOOOOOO ISI sub ID 0 sequence bit register. Ox3B4 ISISubId1Seq 1 OxOO000 ISI sub ID 1 sequence bit register. Ox3B8 ISISubldSeqMask 2 OxOOOOOOOO ISI sub ID sequence bit mask register. Ox3BC ISINumPins 1 OxO00000 ISI number of pins register. Ox3CO ISITurnAround 4 OxOOO0F ISI bus turn around register. Ox3C4 ISITShortReplyWi 5 OxOO00001F ISI short packet reply window. n Ox3C8 ISITLongReplyWin 9 OxOO0001FF ISI long packet reply window. Ox3CC ISIDebug 4 0x00000000 1SI debug register. A detailed description of each register format follows. The CPU has full read access to all registers. Write access to the fields of each register is defined as: * Full: The CPU has full write access to the field, i.e. the CPU can write a 1 or a 0 to each 5 bit. * Clear: The CPU can clear the field by writing a 1 to each bit. Writing a 0 to this type of field will have no effect. * None: The CPU has no write access to the field, i.e. a CPU write will have no effect on the field. 10 12.5.5.2.1 SCBResetN Table 39. SCBResetN register format WO 2004/050369 PCT/AU2003/001616 179 Field Name Bit(s) write access Description CTRL 0 Full scb ctri sub-block reset. Setting this field will reset the SCB control sub-block logic, including all configuration registers. o = reset 1 =default state ISI 1 Full scb isisub-block reset. Setting this field will reset the ISI sub-block logic. 0 = reset 1 = default state USBH 2 Full scb usbh sub-block reset. Setting this field will reset the USB host controller core and associated logic. o = reset 1 = default state USBD 3 Full scb usbd sub-block reset. Setting this field will reset the USB device controller core and associated logic. 0 = reset 1 = default state 12.5.5.2.2 SCBGo Table 40. SCBGo register format Field Name Bls) write access Description CTRL 0 Full scb_ctrl sub-block go. 0 = halted 1 = running ISI 1 Full scb_isi sub-block go. 0 = halted 1 = running 5 12.5.5.2.3 SCBWakeUpEn This register is used to gate the propagation of the USB and ISI reset signals to the CPR block. Table 41. SCBWakeUpEn register format Field Name Bit(s) write access Description USBWakeUpEn 0 Full usbcprreset n propagation enable. 1 = enable 0 = disable WO 2004/050369 PCT/AU2003/001616 180 ISIWakeUpEn 1 Full is! cprreset n propagation enable. 1 = enable 0 = disable 12.5.5.2.4 SCBISITxBufferArb This register determines which source has priority at the ISITxBuffer interface on the ISI block. When a bit is set priority is given to the relevant source. When both bits have the same value, arbitration will be performed in a round-robin manner. 5 Table 42. SCBiSITxBufferArb register format Field Name Bit(s) write Description access CPUPriority 0 Full CPU priority 1 = high priority 0 = low priority USBPriority 1 Full USB priority 1 = high priority 0 = low priority 12.5.5.2.5 SCBDebugSel Contains address of the register selected for debug observation as it would appear on cpu_adr. The 10 contents of the selected register are output in the scb -cpuLdata bus while cpu_scb_sel is low and scbcpudebug valid is asserted to indicate the debug data is valid. It is expected that a number of pseudo-registers will be made available for debug observation and these will be outlined with the implementation details. Table 43. SCBDebugSel register format 15 Field Name Bit(s) rite JDes ription - access CPUAdr 11:2 Full cpu adr register address. 12.5.5.2.6 USBEPnDest This register description applies to USBEPODest, USBEP1Dest, USBEP2Dest, USBEP3Dest, USBEP4Dest. The SCB has two routing options for each packet received, based on the DestIS/ld associated with the packets source EP: 20 * To the DMA Manager To the ISI The SCB map therefore does not need special fields to identify the DMAChannels on the ISIMaster SoPEC as this is taken care of by the SCB hardware. Thus the USBEPODest and USBEPIDest registers should be programmed with 0x20 and 0x21 (for ISIO.0 and IS10.1) respectively to ensure 25 data arriving on these endpoints is moved directly to DRAM. Table 44. USBEPnDest register format WO 2004/050369 PCT/AU2003/001616 181 Field Name Bit(s) Write access Description SequenceBit 0 Full Sequence bit for packets going from USBEPn to DestlSlId.DestlSISubld. Every CPU write to this register initialises the value of the sequence bit and this is subsequently updated by the ISI after every successful long packet transmission. DestiSIld 4:1 Full Destination ISI ID. Denotes the ISild of the target SoPEC as per Table DestISISubld 5 Full Destination ISI sub ID. Indicates which DMAChannel of the target SoPEC the endpoint is mapped onto: 0 = DMAChannelO I = DMAChannell ChannelEn 6 Full Communication channel enable bit for EPn. This enables/disables the communication channel for EPn. When disabled, the SCB will not accept USB packets addressed to EPn. o = Channel disabled 1 = Channel enabled If the local SoPEC is connected to an external USB host, it is recommended that the EPO communication channel should always remain enabled and mapped to DMAChannelO on the local 5 SoPEC, as this is intended as the primary control communication channel between the external USB host and the local SoPEC. A SoPEC ISIMaster should map as many USB endpoints, under the control of the external host, as are required for the multi-SoPEC system it is part of. As already mentioned this mapping may be dynamically reconfigured. 10 12.5.5.2.7 DMAnBottomAdr This register description applies to DMAOBottomAdr and DMA lBottomAdr. Table 45. DMAnBottomAdr register format WO 2004/050369 PCT/AU2003/001616 182 Field Name Bit(s) Write Description access DMAnBottomAdr 21:5 Full The 256-bit aligned DRAM address of the bottom of the circular buffer (inclusive) serviced by DMAChanneln 12.5.5.2.8 DMAnTopAdr This register description applies to DMAOTopAdr and DMA 1TopAdr. Table 46. DMAnTopAdr register format 5 Field Name Bit(s) Write Description access DMAnTopAdr 21:5 Full The 256-bit aligned DRAM address of the top of the circular buffer (inclusive) serviced by DMAChanneln 12.5.5.2.9 DMAnCurrWPtr This register description applies to DMAOCurrWPtr and DMA1CurrWPtr. Table 47. DMAnCurrWptr register format Field Name Bit(s) Write Description access DMAnCurrWPtr 21:5 Full The 256-bit aligned DRAM address of the next location DMAChannelO will rite to. This register is set by the CPU at the start of a DMA operation and dynamically updated by the DMA manager during the operation. 10 12.5.5.2.10 DMAnlntAdr This register description applies to DMAO/ntAdr and DMA1/ntAdr. Table 48. DMAnlntAdr register format Bit(s) Write Description access DMAnIntAdr 21:5 Full The 256-bit aligned DRAM address of the location that will trigger an interrupt when reached by DMAChanneln buffer. 12.5.5.2.11 DMAnMaxAdr 15 This register description applies to DMAOMaxAdr and DMA lMaxAdr. Table 49. DMAnMaxAdr register format WO 2004/050369 PCT/AU2003/001616 183 Field Name Bit(s) Write Description access DMAnMaxAdr 21:5 Full The 256-bit aligned DRAM address of the last free location that in the DMAChanneln circular buffer. DMAChannelO transfers will stop when it reaches this address. 12.5.5.2.12 DMAAccessEn This register enables DMA access for the various requestors, on a per channel basis. Table 50. DMAAccessEn register format 5 Field arne Bit(s) Write Description access DMAChannelOEn 0 Full DMA Channel #0 access enable. This uni-directional write channel is used by the USBD and the ISI. 1 = enable 0 = disable DMAChannell En 1 Full As per USBDISIOEn. DMAChannel2En 2 Full DMA Channel #2 access enable. This bi-directional read/write channel is used by the USBH. 1 = enable 0 = disable 12.5.5.2.13 DMAStatus The status bits are not sticky bits i.e. they reflect the 'live' status of the channel. DMAChanne/NIntAdrHt and DMAChanneNMaxAdrHit status bits may only be cleared by writing to the relevant DMAnIntAdr or DMAnMaxAdr register. 10 Table 51. DMAStatus register format Field Name Bit(s) Write Description access DMAChannel0lntAdrHit 0 None DMA channel #0 interrupt address hit. 1= DMAChannelO has reached the address contained in the DMAOIntAdr register. 0 = default state DMAChannelOMaxAdrHit 1 None DMA channel #0 max address hit. I = DMAChannelO has reached the WO 2004/050369 PCT/AU2003/001616 184 address contained in the DMAOMaxAdr register. 0 = default state DMAChannell ntAdrHit 3 None As per DMA Channe0intAdrHit. DMAChannellMaxAdrHit 4 None As per DMA ChanneOMaxAdrHit. 12.5.5.2.14 DMAMask register All bits of the DMAMask are both readable and writable by the CPU. The DMA manager cannot alter the value of this register. All interrupts are generated in an edge sensitive manner i.e. the DMA manager will generate a dmaicuqirq pulse each time a status bit goes high and its corresponding 5 mask bit is enabled. Table 52. DMAMask register format Field Name Bit(s) Write Description access DMAChannel0lntAdrHitlntEn 0 Full DMA Channel0IntAdrHit status interrupt enable. 1 = enable 0 = disable DMAChannel0MaxAdrHitlntEn 1 Full DMA ChannelMaxAdrHit status interrupt enable. 1 = enable 0 = disable DMAChannell ntAdrHitlntEn 2 Full As per DMA Channe/0/ntAdrHit/ntEn DMAChannellMaxAdrHitlntEn 3 Full As per DMA ChannelOMaxAdrHit/ntEn 12.5.5.2.15 CPUISITxBuffCtr register Table 53. CPUISITxBuffCtrl register format 10 Field Name Bit(s) Write Description access PktValid 0 full This field should be set by the CPU to indicate the validity of the CPUISITxBuff contents. This field will be cleared by the SCB once the contents of the CPUISITxBuff has been copied to the ISITxBuff. NOTE: The CPU should not clear this field under normal operation. If the CPU clears this field during a packet transfer to the /SITxBuff, the transfer WO 2004/050369 PCT/AU2003/001616 185 will be aborted - this is not recommended. 1 = valid packet. 0 = default state. PktDesc 3:1 full PktDesc field, as per Table , of the packet contained in the CPUISITxBuff. The CPU is responsible for maintaining he correct sequence bit value for each ISIld.ISISubid channel it communicates with. Only valid when CPU lSlTxBuffCtr.PktValid = 1. DestISlid 7:4 full Denotes the ISld of the target SoPEC as per Table . DestISISubld 8 full Indicates which DMAChannel of the target SoPEC the packet in the CPUISITxBuff is destined for. 1 = DMAChannell 0 = DMAChanne0 12.5.5.2.16 USBDlntStatus The USBDlntStatus register contains status bits that are related to conditions that can cause an interrupt to the CPU, if the corresponding interrupt enable bits are set in the USBDMask register. The field name extension Sticky implies that the status condition will remain registered until cleared 5 by a CPU write of 1 to each bit of the field. NOTE: There is no EpOirregPktSticky field because the default control EP will frequently receive packets that are not multiples of 32 bytes during normal operation. Table 54. USBDlntStatus register format Field Nane Bit(s) Write Description access CoreSuspendStcky 0 Clear Device core USB suspend flag. Sticky. 1 = USB suspend state. Set when device core udcvci suspend signal transitions from I -> 0. o = default value. CoreUSBResetSticky 1 Clear Device core USB reset flag. Sticky. 1 = USB reset. Set when device core udcvci reset signal transitions from 1 -> 0. 0 = default value. CoreUSBSOFSticky 2 Clear Device core USB Start Of Frame (SOF) flag. Sticky.
WO 2004/050369 PCT/AU2003/001616 186 1 = USB SOF. Set when device core udcvci sof signal transitions from 1 -> 0 0 = default value. CPUISITxBuffEmptySticky 3 Clear CPU ISI transmit buffer empty flag. Sticky. 1 = empty. o = default value. CPUEp0lnBuffEmptySticky 4 Clear CPU EPO IN buffer empty flag. Sticky. 1 = empty. o = default value. CPUEp5lnBuffEmptySticky 5 Clear CPU EP5 IN buffer empty flag. Sticky. 1 =empty. o = default value. EpOinNAKSticky 6 clear EPO-IN NAK flag. Sticky This flag is set if the USB device core issues a read request for EPO-IN and there is not a valid packet present in the EPO-IN buffer. The core will therefore send a NAK response to the IN token that was received from external USB host. This is an indicator of any back pressure on the USB caused by EPO-IN. 1 = NAK sent. 0 = default value Ep51nNAKSticky 7 Clear As per EpOInNAK. EpOOutNAKSticky 8 Clear EPO-OUT NAK flag. Sticky This flag is set if the USB device core issues a write request for EPO-OUT and there is no space in the OUT EP buffer for a the packet. The core will therefore send a NAK response to the OUT token that was received from external USB host. This is an indicator of any back-pressure on the USB caused by EPO OUT. 1 = NAK sent. 0 = default value Ep1 OutNAKSticky 9 Clear As per EpO0utNAK. Ep2OutNAKSticky 10 Clear As per EpOOutNAK. Ep30utNAKSticky 11 Clear As per EpOutNAK. Ep40utNAKSticky 12 Clear As per EpOutNAK. Epi IrregPktSticky 13 Clear EP1 -OUT irregular sized packet flag. Sticky.
WO 2004/050369 PCT/AU2003/001616 187 Indicates a packet that is not a multiple of 32 bytes in size was received by EP1-OUT. 1 = irregular sized packet received. o = default value. Ep21rregPktSticky 14 Clear As per Ep1/rregPktSticky. Ep3lrregPktSticky 15 Clear As per EplrregPktSticky. Ep4lrregPktSticky 16 Clear As per EplrregPktSticky. OutBuffOverFlowSticky 17 Clear OUT EP buffer overflow flag. Sticky. This flag is set if the USB device core attempted to write a packet of more than 64 bytes to the OUT EP buffer. This is a fatal error, suggesting a problem in the USB device IP core. The SCB will take no further action. 1 = overflow condition detected. o = default value. InBuffUnderRunSticky 18 clear IN EP buffer underrun flag. Sticky. This flag is set if the USB device core attempted to read more data than was present from the IN EP buffer. This is a fatal error, suggesting a problem in the USB device IP core. The SCB will take no further action. 1 = underrun condition detected. o = default value. 12.5.5.2.17 USBDISIFIFOStatus This register contains the status of the ISI mapped OUT EP packet FIFO. This is a secondary status register and will not cause any interrupts to the CPU. Table 55. USBDISIFIFOStatus register format 5 Field Name Bit(s) Write Description access EntryOValid 0 none FIFO entry #0 valid field. This flag will be set by the USBD when the USB device core indicates the validity of packet entry #0 in the FIFO. 1 = valid USB packet in ISI OUT EP buffer 0. o = default value. EntryOSource 3:1 none FIFO entry #0 source field. Contains the EP associated with packet entry #0 in the FIFO. Binary Coded Decimal. Only valid when ISIBuffOPktValid = 1.
WO 2004/050369 PCT/AU2003/001616 188 EntrylValid 4 none As per EntryOValid. EntrylSource 7:5 none As per EntryOSource. Entry2Valid 8 none As per EntryOValid. Entry2Source 11:9 none As per Entry0Source. Entry3Valid 12 none As per EntryOVa/id. Entry3Source 15:13 none As per Entry0Source. 12.5.5.2.18 USBDDMAOFIFOStatus This register description applies to USBDDMAOFIFOStatus and USBDDMA1FIFOStatus. This register contains the status of the DMAChannelN mapped OUT EP packet FIFO. This is a secondary status register and will not cause any interrupts to the CPU. 5 Table 56. USBDDMANFIFOStatus register format Field Name Bit(s) Write Description access EntryOValid 0 none FIFO entry #0 valid field. This flag will be set by the USBD when the USB device core indicates the validity of packet entry #0 in the FIFO. 1 = valid USB packet in ISI OUT EP buffer 0. 0 = default value. EntryOSource 3:1 none FIFO entry #0 source field. Contains the EP associated with packet entry #0 in the FIFO. Binary Coded Decimal. Only valid when Entry0Valid = 1. EntrylValid 4 none As per EntryOVaid. Entryl Source 7:5 none As per EntryOSource. 12.5.5.2.19 USBJResume This register causes the USB device core to initiate resume signalling to the external USB host. Only applicable when the device core is in the suspend state. 10 Table 57. USBDResume register format Field Name Bit(s) Write access Description USBDResume 0 full USBD core resume register. The USBD will clear this register upon resume notification from the device core. 1 = generate resume signalling. 0 = default value. 12.5.5.2.20 USBDSetup This register controls the general setup/configuration of the USBD. Table 58. USBDSetup register format WO 2004/050369 PCT/AU2003/001616 189 Field Name Bit(s) write Description access Ep1 lrregPktCntrl 0 full EP 1 OUT irregular sized packet control. An irregular sized packet is defined as a packet that is not a multiple of 32 bytes. 1 = discard irregular sized packets. 0 = read 32 bytes from buffer, regardless of packet size. Ep21rregPktCntrl 1 full As per Ep1 IrregPktDiscard Ep31rregPktCntrl 2 full As per Ep1 lrregPktDiscard Ep41rregPktCntrl 3 full As per Ep1 IrregPktDiscard 12.5.5.2.21 USBDEpNInBuffCtrl register This register description applies to USBDEpOlnBuffCtr and USBDEp5nBuffCtrI. Table 59. USBDEpNInBuffCtrI register format 5 Field Name Bit(s) Write Description access PktValid 0 full Setting this register validates the contents of USBDEpNnBuff. This field will be cleared by the SCB once the packet has been successfully transmitted to the external USB host. NOTE: The CPU should not clear this field under normal operation. If the CPU clears this field during a packet transfer to the USB, the transfer will be aborted - this is not recommended. 1 = valid packet. 0 = default state. 12.5.5.2.22 USBDMask This register serves as an interrupt mask for all USBD status conditions that can cause a CPU interrupt. Setting a field enables interrupt generation for the associated status event. Clearing a field disables interrupt generation for the associated status event. All interrupts will be generated in an 10 edge sensitive manner, i.e. when the associated status register transitions from 0 -> 1. Table 60. USBDMask register format Field Name Bit(s) Write Description access CoreSuspendStickyEn 0 full CoreSuspendSticky status interrupt enable. CoreUSBResetStickyEn 1 full Core USBResetSticky status interrupt enable. CoreUSBSOFStickyEn 2 full CoreUSBSOFSticky status interrupt enable. CPUISITxBuffEmptyStickyEn 3 full CPU/S/TxBuffEmptySticky status interrupt enable. CPUEp0InBuffEmptyStickyEn 4 full CPUEpOlnBuffEmptySticky status interrupt enable.
WO 2004/050369 PCT/AU2003/001616 190 CPUEp5lnBuffEmptyStickyEn 5 full CPUEp5/nBuffEmptySticky status interrupt enable. EpOlnNAKStickyEn 6 full EpOlnNAKSticky status interrupt enable. Ep5lnNAKStickyEn 7 full Ep5InNAKSticky status interrupt enable. Ep0OutNAKStickyEn 8 full EpOOutNAKSticky status interrupt enable. EplOutNAKStickyEn 9 full Ep1OutNAKSticky status interrupt enable. Ep2OutNAKStickyEn 10 full Ep2OutNAKSticky status interrupt enable. Ep30utNAKStickyEn 11 full Ep3OutNAKSticky status interrupt enable. Ep40utNAKStickyEn 12 full Ep4OutNAKSticky status interrupt enable. Ep1 lrregPktStickyEn 13 full Ep1/rregPktSticky status interrupt enable. Ep2lrregPktStickyEn 14 full Ep2lrregPktSticky status interrupt enable. Ep3lrregPktStickyEn 15 full Ep31rregPkiSticky status interrupt enable. Ep4lrregPktStickyEn 16 full Ep4/rregPktSticky status interrupt enable. OutBuffOverFlowStickyEn 17 full OutBuffOverFlowSticky status interrupt enable. InBuffUnderRunStickyEn 18 full InBuffUnderRunSticky status interrupt enable. 12.5.5.2.23 USBDDebug This register is intended for debug purposes only. Contains non-sticky versions of all interrupt capable status bits, which are referred to as dynamic in the table. Table 61. USBDDebug register format 5 Field Name Bt(s) write Description access CoreTimeStamp 10:0 none USB device core frame number. CoreSuspend 11 none Dynamic version of CoreSuspendSticky. CoreUSBReset 12 none Dynamic version of CoreUSBResetSticky. CoreUSBSOF 13 none Dynamic version of CoreUSBSOFSticky. CPUlSlTxBuffEmpty 14 none Dynamic version of CPUlSTxBuffEmptySticky. CPUEpO1nBuffEmpty 15 none Dynamic version of CPUEpOlnBuffEmptySticky. CPUEp5lnBuffEmpty 16 none Dynamic version of CPUEp5/nBuffEmptySticky. EpOnNAK 17 none Dynamic version of EpOInNAKSticky. Ep51nNAK 18 none Dynamic version of Ep5nNAKSticky. EpOOutNAK 19 none Dynamic version of EpOOutNAKSticky. Ep1OutNAK 20 none Dynamic version of EplOutNAKSticky. Ep2OutNAK 21 none Dynamic version of Ep2OutNAKSticky. Ep30utNAK 22 none Dynamic version of Ep3OutNAKSticky. Ep4OutNAK 23 none Dynamic version of Ep40utNAKSticky. Ep1 lrregPkt 24 none Dynamic version of Ep1irregPktSticky. Ep2lrregPkt 25 none Dynamic version of Ep2lrregPktSticky. Ep3lrregPkt 26 none Dynamic version of Ep3lrregPktSticky.
WO 2004/050369 PCT/AU2003/001616 191 Ep4lrregPkt 27 none Dynamic version of Ep41rregPktSticky. OutBuffOverFlow 28 none Dynamic version of OutBuffOverFlowSticky. InBuffUnderRun 29 none Dynamic version of InBuffUnderRunSticky. 12.5.5.2.24 USBHStatus This register contains all status bits associated with the USBH. The field name extension Sticky implies that the status condition will remain registered until cleared by a CPU write. Table 62. USBHStatus register format 5 Field Name Bit(s) Write Desoription access CorelRQSticky 0 clear HC core IRQ interrupt flag. Sticky Set when HC core UHOSTC _rqN output signal transitions from 0 -> 1. Refer to OHCI spec for details on HC interrupt processing. 1 = IRQ interrupt from core. o = default value. CoreSMISticky 1 clear HC core SMI interrupt flag. Sticky Set when HC core UHOSTCSmiN output signal transi tions from 0 -> 1. Refer to OHCI spec for details on HC interrupt processing. 1 = SMI interrupt from HC. o = default value. CoreBuffAcc 2 none HC core buffer access flag. HC core UHOSTC _BufAcc output signal. Indicates whether the HC is accessing a descriptor or a buffer in shared system memory. 1 = buffer access 0 = descriptor access. 12.5.5.2.25 USBHMask This register serves as an interrupt mask for all USBH status conditions that can cause a CPU interrupt. All interrupts will be generated in an edge sensitive manner, i.e. when the associated status register transitions from 0 -> 1. 10 Table 63. USBHMask register format Field Name Bit(s) Write access Description CorelRQIntEn 0 full Core/RQSticky status interrupt enable. 1 = enable. 0 = disable. CoreSMllntEn I I 'ull CoreSM/Sticky status interrupt enable.
WO 2004/050369 PCT/AU2003/001616 192 1 =enable. 0 = disable. 12.5.5.2.26 USBHDebug This register is intended for debug purposes only. Contains non-sticky versions of all interrupt capable status bits, which are referred to as dynamic in the table. Table 64. USBHDebug register format 5 Field Name Bit(s) write access Description CoreIRQ 0 none Dynamic version of Core/RQSticky. CoreSMI 1 None Dynamic version of CoreSM/Sticky. 12.5.5.2.27 ISICntrl This register controls the general setup/configuration of the ISI. Note that the reset value of this register allows the SoPEC to automatically become an ISIMaster (AutoMasterEnable = 1) if any USB packets are received on endpoints 2-4. On becoming an 10 ISIMaster the IS/MasterSe/ bit is set and any USB or CPU packets destined for other ISI devices are transmitted. The CPU can override this capability at any time by clearing the AutoMasterEnable bit. Table 65. ISICntrl register format Field Narme t) Wite Description Bts access TxEnable 0 Full ISI transmit enable. Enables ISI transmission of long or ping packets. ACKs may still be transmitted when this bit is 0. This is cleared by transmit errors and needs to be restarted by the CPU. I = Transmission enabled 0 = Transmission disabled RxEnable 1 Full ISI receive enable. Enables ISI reception. This is can only be cleared by the CPU and it is only anticipated that reception will be disabled when the IS[ in not in use and the ISI pins are being used by the GPIO for another purpose. 1 = Reception enabled 0 = Reception disabled ISIMasterSel 2 Full ISI master select. Determines whether the SoPEC is an ISIMaster or not 1 = ISIMaster 0 = ISISlave WO 2004/050369 PCT/AU2003/001616 193 AutoMasterEnable 3 Full ISI auto master enable. Enables the device to automatically become the ISIMaster if activity is detected on USB endpoints2-4. I = auto-master operation enabled 0 = auto-master operation disabled 12.5.5.2.28 ISild Table 66. ISild register format Field Name Bit(s) Write Descriptionr access ISIld 3:0 Full ISIld for this SoPEC. SoPEC resets to being an ISISlave with ISlidO. OxF (the broadcast ISild) is an illegal value and should not be written to this register. 12.5.5.2.29 ISINumRetries 5 Table 67. ISINumRetries register format Field Name Bit(s) Write Description access ISINumRetries 3:0 Full Number of ISI retransmissions to attempt in response to an inferred NAK before aborting a long packet transmission 12.5.5.2.30 ISIPingScheduleN This register description applies to ISIPingScheduleO, ISIPingSchedulel and ISIPingSchedule2. 10 Table 68. ISIPingScheduleN register format Field Name Bit(s) Write Description access ISIPingSchedule 14:0 Full Denotes which ISilds will be receive ping packets. Note that bitO refers to ISlIdO, bit1 to ISldl...bitl4 to lSIld14. 12.5.5.2.31 ISITotalPeriod Table 69. ISITotalPeriod register format Field Name Bit(s) W rite access Description ISITotalPeriod 3:0 Full Reload value of the ISiTotalPeriod counter 15 12.5.5.2.32 ISILocalPeriod Table 70. ISILocalPeriod register format WO 2004/050369 PCT/AU2003/001616 194 Field Name Bit(s) Write access Description ISILocalPeriod 3:0 Full Reload value of the ISiLocalPeriod counter 12.5.5.2.33 ISllntStatus The /SlntStatus register contains status bits that are related to conditions that can cause an interrupt to the CPU, if the corresponding interrupt enable bits are set in the ISIMask register. Table 71. lSllntStatus register 5 Field Name Bit(s) Write Description access TxErrorSticky 0 None ISI transmit error flag. Sticky. Receiving ISI device would not accept the transmitted packet. Only set after NumRetr/es unsuccessful retransmissions. (excluding ping packets). This bit is cleared by the ISI after transmission has been re-enabled by the CPU setting the TxEnable bit of the ISICntr/ register. 1= transmit error. o = default state. RxFrameErrorSticky 1 Clear ISI receive framing error flag. Sticky. This bit is set by the ISI when a framing error detected in the received packet, which can be caused by an incorrect Start or Stop field or by bit stuffing errors. 1 = framing error detected. 0 = default state. RxCRCErrorSticky 2 Clear ISI receive CRC error flag. This bit is set by the ISI when a CRC error is detected in an incoming packet. Other than dropping the errored packet ISI reception is unaffected by a CRC Error. 1 = CRC error 0 = default state. RxBuffOverFlowSticky 3 Clear ISI receive buffer over flow flag. Sticky. An overflow has occurred in the ISI receive buffer and a packet had to be dropped. 1 = over flow condition detected. 0 = default state. 12.5.5.2.34 ISITxBuffStatus The /S/TxBuffStatus register contains status bits that are related to the ISI Tx buffer. This is a secondary status register and will not cause any interrupts to the CPU. Table 72. ISITxBuffStatus register format WO 2004/050369 PCT/AU2003/001616 195 Field Name Bit(s) Write Description access Entry0PktValid 0 None ISI Tx buffer entry #0 packet valid flag. This flag will be set by the ISI when a valid IS] packet is ritten to entry #0 in the /S/TxBufffor transmission over the ISI bus. A Tx packet is considered valid when it is 32 bytes in size and the ISI has written the packet header information to EntryOPktDesc, EntryODest/Sld and EntryODest/SISubld. 1 = packet valid. 0 = default value. EntryOPktDesc 3:1 None ISI Tx buffer entry #0 packet descriptor. PktDesc field as per Table for the packet entry #0 in the ISITxBuff. Only valid when EntryOPktValid = 1. Entry0DestlSild 7:4 None ISI Tx buffer entry #0 destination ISI ID. Denotes the ISild of the target SoPEC as per Table . Only valid when EntryOPktValid = 1. EntryODestlSISubld 8 None ISI Tx buffer entry #0 destination ISI sub ID. Indicates which DMAChannel on the target SoPEC that packet entry #0 in the /SITxBuff is destined for. Only valid when EntryOPktValid = 1. I = DMAChannel1 0 = DMAChanne1O Entryl PktValid 9 None As per EntryOPktVaid. Entryl PktDesc 12:10 None As per EntryOPktDesc. Entryl DestiSIld 16:13 None As per EntryODest/Sld. Entryl DestISISubId 17 None As per EntryODest/S/Subld. 12.5.5.2.35 ISIRxBuffStatus The /S/RxBuffStatus register contains status bits that are related to the ISI Rx buffer. This is a secondary status register and will not cause any interrupts to the CPU. 5 Table 73. ISIRxBuffStatus register format Field Name Bit(s) Write Description access EntryOPktValid 0 None ISI Rx buffer entry #0 packet valid flag. This flag will be set by the ISI when a valid ISI packet is received and written to entry #0 of the ISIRxBuff. A Rx packet is considered valid when it is 32 bytes in size and no framing or CRC errors were detected.
WO 2004/050369 PCT/AU2003/001616 196 1 = valid packet 0 = default value Entry0PktDesc 3:1 None ISI Rx buffer entry #0 packet descriptor. PktDesc field as per Table for packet entry #0 of the /SIRxBuff. Only valid when EntryOPktValid = 1. Entry0Dest|Slid 7:4 None ISI Rx buffer 0 destination IS] ID. Denotes the ISild of the target SoPEC as per Table . This should always correspond to the local SoPEC ISlld. Only valid when EntryOPktValid = 1. Entry0DestiSISubid 8 None ISI Rx buffer 0 destination ISI sub ID. Indicates which DMAChannel on the target SoPEC that entry #0 of the /S/RxBuff is destined for. Only valid when EntryOPktValid = 1. 1 = DMAChannell 0 = DMAChannelO Entryl PktValid 9 None s per EntryOPktValid. Entryl PktDesc 12:10 None s per EntryOPktDesc. Entryl DestiSIld 16:13 None As per EntryODest/Sld. Entryl DestISISubId 17 None As per EntryODest/S/Sub/d. 12.5.5.2.36 ISIMask register An interrupt will be generated in an edge sensitive manner i.e. the ISI will generate an is! icuirq pulse each time a status bit goes high and the corresponding bit of the IS/Mask register is enabled. Table 74. ISIMask register 5 Field Name Bit(s) Write Description access TxErrorIntEn 0 Full TxErrorSticky status interrupt enable. I = enable. 0 = disable. RxFrameErrorlntEn 1 Full RxFrameErrorSticky status interrupt enable. 1 = enable. 0 = disable. RxCRCErrorlntEn 2 Full RxCRCErrorSticky status interrupt enable. 1 = enable. 0 = disable. RxBuffOverFlowintEn 3 Full RxBuffOverFlowSticky status interrupt enable. 1 = enable. 0 = disable.
WO 2004/050369 PCT/AU2003/001616 197 12.5.5.2.37 lSISubldNSeq This register description applies to ISISubIdOSeq and ISISubldOSeq. Table 75. lSISubldNSeq register format Field Name Bit(s) Write Description access lSlSubldNSeq 0 Full ISI sub ID channel N sequence bit. This bit may be initialised by the CPU but is updated by the ISI each time an error-free long packet is received. 5 12.5.5.2.38 ISISubldSeqMask Table 76. ISISubldSeqMask register format Field Name Bit(s) Write Description access ISISubIdSeqOMask 0 Full ISI sub ID channel 0 sequence bit mask. Setting this bit ensures that the sequence bit will be ignored for incoming packets for the ISISubid. 1 = ignore sequence bit. 0 = default state. lSlSubIdSeq1 Mask I Full s per ISISubldSeqOMask. 12.5.5.2.39 ISINumPins Table 77. ISINumPins register format 10 Field Naine Bit(s) Write access Description ISINumPins 0 Full Select number of active ISI pins. 1 = 4 pins 0 = 2 pins 12.5.5.2.40 ISITurnAround The ISI bus turnaround time will reset to its maximum value of OxF to provide a safer starting mode for the ISI bus. This value should be set to a value that is suitable for the physical implementation of the ISI bus, i.e. the lowest turn around time that the physical implementation will allow without 15 significant degradation of signal integrity. Table 78. ISITurnAround register format Field Name Bit(s) Write access Description ISITurnAround 3:0 Full ISI bus turn around time in ISI clock cycles (32MHz). 12.5.5.2.41 ISIShortReplyWin WO 2004/050369 PCT/AU2003/001616 198 The ISI short packet reply window time will reset to its maximum value of Ox1 F to provide a safer starting mode for the ISI bus. This value should be set to a value that will allow for expected frequency of bit stuffing and receiver response timing. Table 79. ISIShortReplyWin register format 5 Field Name Bit(s) Write access Description ISIShortReplyWin 4:0 Full ISI long packet reply window in ISI clock cycles (32MHz). 12.5.5.2.42 ISILongReplyWin The ISI long packet reply window time will reset to its maximum value of 0x1 FF to provide a safer starting mode for the ISI bus. This value should be set to a value that will allow for expected frequency of bit stuffing and receiver response timing. 10 Table 80. ISILongReplyWin register format Field Name Bit(s) Write Description _________________ access________________________ ISILongReplyWin 8:0 Full ISI long packet reply window in ISI clock cycles (32MHz). 12.5.5.2.43 ISIDebug This register is intended for debug purposes only. Contains non-sticky versions of all interrupt capable status bits, which are referred to as dynamic in the table. 15 Table 81. ISIDebug register format Field Name Bit(s) Write access Descri'ption TxError 0 None Dynamic version of TxErrorSticky. RxFrameError 1 None Dynamic version of RxFrameErrorSticky. RxCRCError 2 None Dynamic version of RxCRCErrorSticky. RxBuffOverFlow 3 None Dynamic version of RxBuffOverFlowSticky. 12.5.5.3 CPU Bus Interface 12.5.5.4 Control Core Logic 12.5.5.5 DIU Bus Interface 20 12.6 DMA REGS All of the circular buffer registers are 256-bit word aligned as required by the DIU. The DMAnBottomAdr and DMAnTopAdr registers are inclusive i.e. the addresses contained in those registers form part of the circular buffer. The DMAnCurrWPtr always points to the next location the DMA manager will write to so interrupts are generated whenever the DMA manager reaches the 25 address in either the DMAn/ntAdr or DMAnMaxAdr registers rather than when it actually writes to these locations. It therefore can not write to the location in the DMAnMaxAdr register. SCB Map regs WO 2004/050369 PCT/AU2003/001616 199 The SCB map is configured by mapping a USB endpoint on to a data sink. This is performed on a endpoint basis i.e. each endpoint has a configuration register to allow its data sink be selected. Mapping an endpoint on to a data sink does not initiate any data flow - each endpoint/data sink needs to be enabled by writing to the appropriate configuration registers for the USBD, ISI and DMA 5 manager. 13. General Purpose 10 (GPIO) 13.1 OVERVIEW The General Purpose 10 block (GPIO) is responsible for control and interfacing of GPIO pins to the rest of the SoPEC system. It provides easily programmable control logic to simplify control of GPIO 10 functions. In all there are 32 GPIO pins of which any pin can assume any output or input function. Possible output functions are * 4 Stepper Motor control Outputs * 12 Brushless DC Motor Control Output (total of 2 different controllers each with 6 outputs) * 4 General purpose high drive pulsed outputs capable of driving LEDs. 15 * 4 Open drain 10s used for LSS interfaces * 4 Normal drive low impedance IOs used for the ISI interface in Multi-SoPEC mode Each of the pins can be configured in either input or output mode, each pin is independently controlled. A programmable de-glitching circuit exists for a fixed number of input pins. Each input is a schmidt trigger to increase noise immunity should the input be used without the de-glitch circuit. 20 The mapping of the above functions and their alternate use in a slave SoPEC to GPIO pins is shown in Table 82 below. Table 82. GPIO pin type GPIO pin(s) Pin 10 Type Default Function gpio[3:0] Normal drive, low impedance IOPins 1 and 0 in ISI Mode, pins (35 Ohm), Integrated pull-up2 and 3 in input mode resistor gpio(7:41 High drive, normal impedance 10 Input Mode (65 Ohm), intended for LED drivers gpio[31:8] Normal drive, normal impedanceInput Mode 10 (65 Ohm), no pull-up 13.2 Stepper Motor control 25 The motor control pins can be directly controlled by the CPU or the motor control logic can be used to generate the phase pulses for the stepper motors. The controller consists of two central counters from which the control pins are derived. The central counters have several registers (see Table ) used to configure the cycle period, the phase, the duty cycle, and counter granularity. There are two motor master counters (0 and 1) with identical features. The period of the master 30 counters are defined by the MotorMasterC/kPeriod[1:0] and MotorMasterClkSrc registers i.e. both master counters are derived from the same MotorMasterC/kSrc. The MotorMasterClkSrc defines WO 2004/050369 PCT/AU2003/001616 200 the timing pulses used by the master counters to determine the timing period. The MotorMasterClkSrc can select clock sources of 1ps,1j00pis,10ms and pclk timing pulses. The MotorMasterCikPeriod[1:] registers are set to the number of timing pulses required before the timing period re-starts. Each master counter is set to the relevant MotorMasterClkPeriod value and 5 counts down a unit each time a timing pulse is received. The master counters reset to MotorMasterC/kPeriod value and count down. Once the value hits zero a new value is reloaded from the MotorMasterC/kPeriod[1:0] registers. This ensures that no master clock glitch is generated when changing the clock period. Each of the 10 pins for the motor controller are derived from the master counters. Each pin has 10 independent configuration registers. The MotorMasterCkSelect[3:0] registers define which of the two master counters to use as the source for each motor control pin. The master counter value is compared with the configured MotorCtr/Low and MotorCtr/High registers (bit fields of the MotorCtrlConfig register). If the count is equal to MotorCtr/High value the motor control is set to 1, if the count is equal to MotorCtr/Low value the motor control pin is set to 0. 15 This allows the phase and duty cycle of the motor control pins to be varied at pclk granularity. The motor control generators keep a working copy of the MotorCtr/Low, MotorCtr/High values and update the configured value to the working copy when it is safe to do so. This allows the phase or duty cycle of a motor control pin to be safely adjusted by the CPU without causing a glitch on the output pin. 20 Note that when reprogramming the MotorCtriLow, MotorCtr/High registers to reorder the sequence of the transition points (e.g changing from low point less than high point to low point greater than high point and vice versa) care must still taken to avoid introducing glitching on the output pin. 13.3 LED CONTROL LED lifetime and brightness can be improved and power consumption reduced by driving the LEDs 25 with a pulsed rather than a DC signal. The source clock for each of the LED pins is a 7.8kHz (1 28gs period) clock generated from the 1 ps clock pulse from the Timers block. The LEDDutySelect registers are used to create a signal with the desired waveform. Unpulsed operation of the LED pins can be achieved by using CPU 10 direct control, or setting LEDDutySelect to 0. By default the LED pins are controlled by the LED control logic. 30 13.4 LSS INTERFACE VIA GPIO In some SoPEC system configurations one or more of the LSS interfaces may not be used. Unused LSS interface pins can be reused as general 10 pins by configuring the /OModeSelect registers. When a mode select register for a particular GPIO pin is set to 23,22,21,20 the GPIO pin is connected to LSS control 10s 3 to 0 respectively. 35 13.5 ISI INTERFACE VIA GPIO In Multi-SoPEC mode the SCB block (in particular the ISI sub-block) requires direct access to and from the GPIO pins. Control of the ISI interface pins is determined by the IOModeSelect registers. When a mode select register for a particular GPIO pin is set to 27,26,25,24 the GPIO pin connected to the ISI control bits 3 to 0 respectively. By default the GPIO pins 1 to 0 are directly controlled by 40 the IS] block.
WO 2004/050369 PCT/AU2003/001616 201 In single SoPEC systems the pins can be re-used by the GPIO. 13.6 CPU GPIO CONTROL The CPU can assume direct control of any (or all) of the 10 pins individually. On a per pin basis the CPU can turn on direct access to the pin by configuring the /OModeSelect register to CPU direct 5 mode. Once set the 10 pin assumes the direction specified by the CpulODirection register. When in output mode the value in register Cpu/OOut will be directly reflected to the output driver. When in input mode the status of the input pin can be read by reading Cpu/O/n register. When writing to the Cpu/OOut register the value being written is XORed with the current value in Cpu/OOut. The CPU can also read the status of the 10 selected de-glitched inputs by reading the Cpu/OnDeGitch 10 register. 13.7 PROGRAMMABLE DE-GLITCHING LOGIC Each 10 pin can be filtered through a de-glitching logic circuit, the pin that the de-glitching logic is connected to is configured by the InputPinSelect registers. There are 10 de-glitching circuits, so a maximum of 10 input pin can be de-glitched at any time. 15 The de-glitch circuit can be configured to sample the 10 pin for a predetermined time before concluding that a pin is in a particular state. The exact sampling length is configurable, but each de glitch circuit must use one of two possible configured values (selected by DeGlitchSelect). The sampling length is the same for both high and low states. The DeGlitchCount is programmed to the number of system time units that a state must be valid for before the state is passed on. The time 20 units are selected by DeGlitchC/kSel and can be one of 1Ips,100ls,10ms and pclk pulses. For example if DeG/itchCount is set to 10 and DeGlitchC/kSe/ set to 3, then the selected input pin must consistently retain its value for 10 system clock cycles (pck) before the input state will be propagated from CpulOln to CpulOlnDeglitch. 13.8 INTERRUPT GENERATION 25 Any of the selected input pins (selected by InputPinSelect) can generate an interrupt from the raw or deglitched version of the input pin. There are 10 possible interrupt sources from the GPIO to the interrupt controller, one interrupt per input pin. The InterruptSrcSelect register determines whether the raw input or the deglitched version is used as the interrupt source. The interrupt type, masking and priority can be programmed in the interrupt controller. 30 13.9 FREQUENCY ANALYSER The frequency analyser measures the duration between successive positive edges on a selected input pin (selected by InputP/nSelect) and reports the last period measured (FreqAnaLastPeriod) and a running average period (FreqAnaAverage). The running average is updated each time a new positive edge is detected and is calculated by 35 FreqAnaAverage = ( FreqAnaAverage / 8 ) * 7 + FreqAnaLastPeriod / 8. The analyser can be used with any selected input pin (or its deglitched form), but only one input at a time can be selected. The input is selected by the FreqAnaPinSe/ect (range of 0 to 9) and its deglitched form can be selected by FreqAnaPinFormSelect. 13.10 BRUSHLESS DC (BLDC) MOTOR CONTROLLERS WO 2004/050369 PCT/AU2003/001616 202 The GPIO contains 2 brushless DC (BLDC) motor controllers. Each controller consists of 3 hall inputs, a direction input, and six possible outputs. The outputs are derived from the input state and a pulse width modulated (PWM) input from the Stepper Motor controller, and is given by the truth table in Table 83. 5 Table 83. Truth Table for BLDC Motor Controllers direction hc hb ha q6 q5 q4 q3 q2 q1 0 o 0 1 0 0 0 1 PWM 0 0 0 1 1 PWM 0 0 1 0 0 0 0 1 0 PWM 0 0 0 0 1 0 1 1 0 0 0 PWM 0 0 1 0 1 0 0 0 1 PWM 0 0 0 0 1 0 1 0 1 0 0 PWM 0 0 0 0 0 0 0 0 0 0 0 1 1 1 0 0 0 0 0 0 1 0 0 1 0 0 PWM 0 0 1 1 0 1 1 PWM 0 0 0 0 1 1 0 1 0 PWM 0 0 1 0 0 1 1 1 0 0 0 0 1 PWM 0 1 1 0 0 0 1 0 0 PWM 0 1 1 0 1 0 1 PWM 0 0 0 1 0 0 0 0 0 0 0 0 0 1 1 1 1 0 0 0 0 0 0 All inputs to a BLDC controller must be de-glitched. Each controller has its inputs hardwired to de glitch circuits. Controller 1 hall inputs are de-glitched by circuits 2 to 0, and its direction input is de 10 glitched by circuit 3. Controller 2 inputs are de-glitched by circuits 6 to 4 for hall inputs and 7 for direction input. Each controller also requires a PWM input. The stepper motor controller outputs are reused, output 0 is connected to BLDC controller 1, and output 1 to BLDC controller 2. The controllers have two modes of operation, internal and external direction control (configured by 15 BLDCMode). If a controller is in external direction mode the direction input is taken from a de glitched circuit, if it is in internal direction mode the direction input is configured by the BLDCDirection register. The BLDC controller outputs are connected to the GPIO output pins by configuring the IOModeSelect register for each pin. e.g Setting the mode register to 8 will connect q1 Controller 1 to 20 drive the pin. 13.11 IMPLEMENTATION WO 2004/050369 PCT/AU2003/001616 203 13.11.1 Definitions of I/O Table 84. 1/0 definition Port name Pins I/O Description Clocks and Resets Pclk 1 In System Clock prst-n 1 In System reset, synchronous active low im_pulse[2:0] 3 In imers block generated timing pulses. 0 - 1 ps pulse 1 - 100 ps pulse 2 - 10 ms pulse CPU Interface cpu.adr[8:2] 8 In CPU address bus. Only 7 bits are required to decode the address space for this block cpu dataout[31:0] 32 In Shared write data bus from the CPU gpio-cpu-data[31:0] 32 Out Read data bus to the CPU cpu rwn 1 In Common read/not-write signal from the CPU cpugpio-sel 1 In Block select from the CPU. When cpu_.gpio_.se/ is high both cpu adr and cpu dataout are valid gpio-cpu.rdy 1 Out Ready signal to the CPU. When gpio cpurdy is high it indicates the last cycle of the access. For a rite cycle this means cpudataout has been registered by the GPIO block and for a read cycle his means the data on gpiocpudata is valid. gpiocpu-berr 1 Out Bus error signal to the CPU indicating an invalid access. gpiocpudebug_valid 1 Out Debug Data valid on gpio cpudata bus. Active high cpu acode[1:0] 2 In CPU Access Code signals. These decode as follows: 00 - User program access 01 - User data access 10 - Supervisor program access 11 - Supervisor data access 10 Pins gpio-o[31:0] 32 Out General purpose 10 output to 10 driver gpio-i[31:0] 32 In General purpose 10 input from 10 receiver gpio-e[31:0] 32 Out General purpose 10 output control. Active high driving GPIO to LSS WO 2004/050369 PCT/AU2003/001616 204 Issgpio dout[1:0] 2 In LSS bus data output Bit 0 - LSS bus O Bit 1 - LSS bus 1 gpioiss-din[1:0] 2 Out LSS bus data input Bit 0 - LSS bus 0 Bit 1 - LSS bus 1 Issgpio-e[1:0] 2 In LSS bus data output enable, active high Bit 0 - LSS bus 0 Bit I - LSS bus 1 Issgpio-clk[1:0] 2 In LSS bus clock output Bit 0 - LSS bus 0 Bit 1 - LSS bus 1 GPIO to ISI gpio-isi-din[1:0] 2 Out Input data from 10 receivers to ISI. isigpio dout[1:0] 2 In Data output from ISI to 10 drivers isigpio-e[1:0] 2 In GPIO ISI pins output enable (active high) from ISI interface usbhgpio-poweren 1 In Port Power enable from the USB host core, active high gpio-usbhovercurrent 1 Out Over current detect to the USB host core, active high Miscellaneous gpio-icuirq[9:0] 10 Out GPIO pin interrupts gpio cpr wakeup 1 Out SoPEC wakeup to the CPR block active high. Debug debugdata out[31:0] 32 In Output debug data to be muxed on to the GPIO pins debugcntrl[31:0] 32 In Control signal for each GPIO bound debug data line indicating whether or not the debug data should be selected by the pin mux 13.11.2 Configuration registers The configuration registers in the GPIO are programmed via the CPU interface. Refer to section 11.4.3 on page 96 for a description of the protocol and timing diagrams for reading and writing registers in the GPIO. Note that since addresses in SoPEC are byte aligned and the CPU only 5 supports 32-bit register reads and writes, the lower 2 bits of the CPU address bus are not required to decode the address space for the GPIO. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of gpio cpu data. Table 85 lists the configuration registers in the GPIO block Table 85. GPIO Register Definition 10 WO 2004/050369 PCT/AU2003/001616 205 Address Register #bits Reset Description GPIObase,+ 0x000-0x07C lOModeSelect[ 32x5 See Specifies the mode of operation for each 31:0] Table for GPIO pin. One 5 bit bus per pin. default values Possible assignment values and correspond controller outputs are as follows Value - Controlled by 3 to 0 - Output, LED controller 4 to 1 7 to 4 - Output Stepper Motor control 4-1 13 to 8 - Output BLDC 1 Motor control 6-1 19 to 14 - Output BLDC 2 Motor control 6-1 23 to 20 - LSS control 4-1 27 to 24 - ISI control 4-1 28 - CPU Direct Control 29 - USB power enable output 30 - Input Mode 0x080-OxA4 lnputPinSelect[ 10x5 0x00 Specifies which pins should be selected as 9:0] inputs. Used to select the pin source to the DeGlitch Circuits. CPU 10 Control OxOBO CpulOUserMod 32 0x0000 User Mode Access Mask to CPU GPIO eMask 0000 control register. When 1 user access is enabled. One bit per gpio pin. Enables access to CpulODirection, CpulOOut and CpulOIn in user mode. 0x0B4 CpulOSuperMo 32 OxFFFF Supervisor Mode Access Mask to CPU deMask _FFFF GPIO control register. When I supervisor access is enabled. One bit per gpio pin. Enables access to CpulODirection, CpulOOut and CpulOln in supervisor mode. Ox0B8 CpulODirection 32 xOO0 Indicates the direction of each 10 pin, when 0000 controlled by the CPU 0 - Indicates Input Mode 1 - Indicates Output Mode OxOBC CpulOOut 32 xOO0 Value used to drive output pin in CPU direct 0000 mode. bits31:0 -Value to drive on output GPIO pins When written to the register assumes the WO 2004/050369 PCT/AU2003/001616 206 new value XORed with the current value. Ox0CO CpulOln 32 External pin Value received on each input pin regardless value of mode. Read Only register. Ox0C4 CpuDeGlitchUs 10 0x000 User Mode Access Mask to erModeMask CpulOlnDeglitch control register. When 1 user access is enabled, otherwise bit reads as zero. Ox0C8 CpulOlnDeglitc 10 0x000 Deglitched version of selected input pins. h The Input pins are selected by the lnputPinSelect register. Note that after reset this register will reflect the external pin values 256 pclk cycles after they have stabilized. Read Only register. Deglitch control 0x0DO-0x0D4 DeGlitchCount[ 2x8 OxFF Deglitch circuit sample count in 1:0] DeGlitchClkSrc selected units. Ox0D8-OxODCDeGlitchClkSrc 2x2 Ox3 Specifies the unit use of the GPIO deglitch [1:0] circuits: 0 - 1 pts pulse 1 - 100 ps pulse 2 - 10 ms pulse 3 - polk OxOEO DeGlitchSelect 10 0x000 Specifies which deglitch count (DeGlitchCount) and unit select (DeGlitchClkSrc) should be used with each de-glitch circuit 0 - Specifies DeGlitchCount[O] and DeGlitchCikSrc[0] 1 - Specifies DeGlitchCount[1] and DeGlitchCkSrc[1] Motor Control OxOE4 MotorCtrlUser I Ox0 User Mode Access enable to Motor control ModeEnable configuration registers. When 1 user access is enabled. Enables user access to MotorMasterClkPeriod, MotorMasterCkSrc, MotorDutySelect, MotorPhaseSelect, MotorMasterClockEnable, Motor MasterClkSelect, BLDCMode and WO 2004/050369 PCT/AU2003/001616 207 BLDCDirection registers OxOE8-OxOEC MotorMasterCi 2x16 xOO0 Specifies the motor controller master clock kPeriod[1:0] periods in MotorMasterClkSrc selected units OxOFO MotorMasterCl 2 Ox0 Specifies the unit use by the motor controller kSrc master clock generator: 0 - 1 gs pulse 1 - 100 Ps pulse 2 - 10 ms pulse 3 -polk 0x0F4-0x100 MotorCtrlConfig4x32 0x0000 Specifies the transition points in the clock [3:0] 0000 period for each motor control pin. One register per pin bits 15:0 - MotorCtrLow, high to low transition point bits 31:16 - MotorCtr/High, low to high transition point 0x1 04 MotorMasterCI 4 Ox0 Specifies which motor master clock should kSelect be used as a pin generator source 0 - Clock derived from MotorMasterClockPe riod[0] 1 -Clock derived from MotorMasterClockPe riod[1] 0x1 08 MotorMasterCl 2 Ox0 Enable the motor master clock counter. ockEnable When 1 count is enabled Bit 0 - Enable motor master clock 0 Bit 1 - Enable motor master clock 1 BLDC Motor Controllers Ox1 OC BLDCMode 2 Ox0 Specifies the Mode of operation of the BLDC Controller. One bit per Controller. 0- External direction control 1- Internal direction control Ox1 10 BLDCDirection 2 Ox0 Specifies the direction input of the BLDC controller. Only used when BLDC controller is an internal direction control mode. One bit per controller. LED control 0x114 LEDCtrlUserMo4 Ox0 User Mode Access enable to LED control deEnable configuration registers. When 1 user access is enabled.
WO 2004/050369 PCT/AU2003/001616 208 One bit per LEDDutySelect select register. 0x118-0x124 LEDDutySelect 4x3 OxO Specifies the duty cycle for each LED [3:0] control output. See Figure 54 for encoding details. The LEDDutySelect[3:0] registers determine the duty cycle of the LED controller outputs Frequency Analyser 0x130 FreqAnaUserM 1 Ox0 User Mode Access enable to Frequency odeEnable analyser configuration registers. When 1 user access is enabled. Controls access to FreqAnaPinFormSelect, FreqAnaLastPeriod, FreqAnaAverage and FreqAnaCountlnc. Ox1 34 FreqAnaPinSel 4 Ox00 Selects which selected input should be used ect for the frequency analyses. Ox1 38 FreqAnaPinFor 1 Ox0 Selects if the frequency analyser should use mSelect the raw input or the deglitched form. 0 - Deglitched form of input pin 1 - Raw form of input pin Ox1 3C FreqAnaLastPe 16 xOO0 Frequency Analyser last period of selected riod input pin. 0x140 FreqAnaAverag 16 Ox0000 Frequency Analyser average period of e selected input pin. 0x144 FreqAnaCountl 20 Ox0000 0 Frequency Analyser counter increment nc amount. For each clock cycle no edge is detected on the selected input pin the accumulator is incremented by this amount. 0x148 FreqAnaCount 32 xOO Frequency Analyser running counter 0000 (Working register) Miscellaneous 0x1 50 InterruptSrcSel 10 Ox3FF Interrupt source select.1 bit per selected ect input. Determines whether the interrupt source is direct form the selected input pin or the deglitched version. Input pins are selected by the DeGlitchPinSelect register. 0 - Selected input direct 1 - Deglitched selected input Ox1 54 DebugSelect[8: 7 Ox00 Debug address select. Indicates the address 2] of the register to report on the WO 2004/050369 PCT/AU2003/001616 209 gpio cpu data bus when it is not otherwise being used. Ox1 58-Oxi 5C MotorMasterCo 2x16 OxOOOO Motor master clock counter values. unt[1:0] Bus 0 - Master clock count 0 Bus 1 - Master clock count I Read Only registers 0x1 60 WakeUplnputM 10 OxOOO Indicates which deglitched inputs should be ask considered to generate the CPR wakeup. Active high 0x164 WakeUpLevel 1 0 Defines the level to detect on the masked GPIO inputs to generate a wakeup to the CPR 0 - Level 0 1 - Level 1 0x168 USBOverCurre 4 Ox00 Selects which deglitched input should be ntPinSelect used for the USB over current detect. 13.11.2.1 Supervisor and user mode access The configuration registers block examines the CPU access type (cpu acode signal) and determines if the access is allowed to that particular register, based on configured user access registers. If an access is not allowed the GPIO will issue a bus error by asserting the gpioc-puberr 5 signal. All supervisor and user program mode accesses will result in a bus error. Access to the CpulODirecton, CpulOOut and CpulOln is filtered by the CpulOUserModeMask and Cpu/OSuperModeMask registers. Each bit masks access to the corresponding bits in the Cpu/O* registers for each mode, with Cpu/OUserModeMask filtering user data mode access and 10 CpulOSuperModeMask filtering supervisor data mode access. The addition of the CpulOSuperModeMask register helps prevent potential conflicts between user and supervisor code read modify write operations. For example a conflict could exist if the user code is interrupted during a read modify write operation by a supervisor ISR which also modifies the CpulO* registers. 15 An attempt to write to a disabled bit in user or supervisor mode will be ignored, and an attempt to read a disabled bit returns zero. If there are no user mode enabled bits then access is not allowed in user mode and a bus error will result. Similarly for supervisor mode. When writing to the CpuIOOut register, the value being written is XORed with the current value in the Cpu/OOut register, and the result is reflected on the GPIO pins. 20 The pseudocode for determining access to the Cpu/OOut register is shown below. Similar code could be shown for the CpulODirection and CpuIOln registers. Note that when writing to CpulODirection data is deposited directly and not XORed with the existing data (as in the Cpu/OOut case).
WO 2004/050369 PCT/AU2003/001616 210 if (cpu acode == SUPERVISORDATAMODE) then // supervisor mode if (CpuIOSuperModeMask[31:0] == 0 ) then // access is denied, and bus error 5 gpiocpuberr =. elsif (cpu rwn == 1) then // read mode (no filtering needed) gpiocpudata [31:0] = CpuIOOut [31:0] else 10 // write mode,filtered by mask mask[31:0] = (cpu-dataout[31:0] & CpuIOSuperModeMask [31: 0]) CpuIOOut[31:0] = (cpu_dataout[31:0] ^ mask[31:0] //bitwise XOR operator 15 elsif (cpuacode == USERDATAMODE) then // user datamode if (CpuIOUserModeMask[31:0] == 0 ) then // access is denied, and bus error gpio cpu berr = 1 20 elsif (cpu rwn == 1) then // read mode, filtered by mask gpio cpudata = ( CpuIOOut[31:0] & CpuIOUserModeMask [31:01) else 25 // write mode,filtered by mask mask[31:03 = (cpu-dataout[31:03 & CpulOUserModeMask [31:01) CpuIOOut[31:0] = (cpu_dataout[31:0] mask[31:0] //bitwise XOR operator 30 else // access is denied, bus error gpio-cpuberr = 1 Table 86 details the access modes allowed for registers in the GPIO block. In supervisor mode all 35 registers are accessible. In user mode forbidden accesses will result in a bus error (gpiocpuberr asserted). Table 86. GPIO supervisor and user access modes Register Address Registers Access Permitted OxOOO-OxO7C IOModeSelect[31:0] Supervisor data mode only WO 2004/050369 PCT/AU2003/001616 211 0x080-0x94 InputPinSelect[9:0] Supervisor data mode only CPU 10 Control OxOBO CpulOUserModeMask Supervisor data mode only 0x0B4 CpulOSuperModeMask Supervisor data mode only Ox0B8 CpulODirection CpulOUserModeMask and CpulOSuperModeMask filtered OxOBC CpulOOut CpulOUserModeMask and CpulOSuperModeMask filtered OxOCO CpulOln CpulOUserModeMask and CpulOSuperModeMask filtered OxOC4 CpuDeGlitchUserModeMask Supervisor data mode only OxOC8 CpulOInDeglitch CpuDeGlitchUserModeMask filtered. Unrestricted Supervisor data mode access Deglitch control Ox0DO-OxOD4 DeGlitchCount[1:0] Supervisor data mode only 0x0D8-OxODC DeGlitchClkSrc[1:0] Supervisor data mode only OxOE0 DeGlitchSelect Supervisor data mode only Motor Control OxOE4 MotorCtrlUserModeEnable Supervisor data mode only OxOE8-Ox0EC MotorMasterClkPeriod[1:0] MotorCtrlUserModeEnable enabled. OxOFO MotorMasterClkSrc MotorCtrlUserModeEnable enabled. Ox0F4-Oxl 00 MotorCtrlConfig[3:0] MotorCtrlUserModeEnable enabled Ox1 04 MotorMasterClkSelect MotorCtrlUserModeEnable enabled Ox1 08 MotorMasterClockEnable MotorCtrlUserModeEnable enabled BLDC Motor Controllers Ox1 OC BLDCMode MotorCtrlUserModeEnable Enabled Ox110 BLDCDirection MotorCtrlUserModeEnable Enabled LED control OxI 14 LEDCtrlUserModeEnable Supervisor data mode only Ox1 18-Ox1 24 LEDDutySelect[3:0] LEDCtrlUserModeEnable[3:0] enabled Frequency Analyser 0x130 FreqAnaUserModeEnable Supervisor data mode only Ox1 34 FreqAnaPinSelect FreqAnaUserModeEnable enabled Ox1 38 FreqAnaPinFormSelect FreqAnaUserModeEnable enabled Ox1 3C FreqAnaLastPeriod FreqAnaUserModeEnable enabled 0x140 FreqAnaAverage FreqAnaUserModeEnable enabled WO 2004/050369 PCT/AU2003/001616 212 Fx44 reqAnaCountlnc FreqAnaUserModeEnable enabled 0x148 FreqAnaCount FreqAnaUserModeEnable enabled Miscellaneous 0x1 50 InterruptSrcSelect Supervisor data mode only 0x1 54 DebugSelect[8:2] Supervisor data mode only 0x1 58-Ox1 5C MotorMasterCount[1:0] Supervisor data mode only 0x1 60 WakeUplnputMask Supervisor data mode only 0x1 64 WakeUpLevel Supervisor data mode only 0x1 68 USBOverCurrentPinSelect Supervisor data mode only 13.11.3 GPIO partition 13.11.4 10 control The 10 control block connects the 10 pin drivers to internal signalling based on configured setup registers and debug control signals. 5 // output Control for (i=0; i<32 ; i++) if (debug_cntrl[il == 1) then // debug mode gpio-e[i] = 1;gpio o[i] =debug data out[i] else // normal mode 10 case io_modeselect[i] is 0 : gpio e[i] =1 ;gpio_o[i] =ledctr1[0] // LED output 1 1 : gpio e[il =1 ;gpio o[i] =ledctrl[1] // LED output 2 15 2 : gpio e[i] =1 ;gpio o[i] =ledctrl [2] // LED output 3 3 : gpio e[i] =1 ;gpio o[i] =ledctrl [3] // LED output 4 4 : gpio-e[i] =1 ;gpio_o[i] =motorctrl[o] // Stepper 20 Motor Control 1 5 : gpio_e[i] =1 ;gpio_o[i] =motor ctrl [1] // Stepper Motor Control 2 6 : gpio_e[i] =1 ;gpio o[i] =motor ctrl [2] // Stepper Motor Control 3 25 7 : gpio_e[i] =1 ;gpio-o[i] =motor ctrl[3] // Stepper Motor Control 4 8 : gpio e[i] =1 ;gpioo[i] =bldcctrl[0] [0] // BLDC Motor Control 1 ,output 1 9 : gpio-e[i] =1 ;gpio_o[i] =bldcctrl [0] [1] // BLDC 30 Motor Control 1,output 2 WO 2004/050369 PCT/AU2003/001616 213 10: gpioe [i] =1 ;gpio-o[i] =bldcctr1[0] [2] // BLDC Motor Control 1,output 3 11: gpio_e[i] =1 ;gpioo[i] =bldc ctrl[0] [3) // BLDC Motor Control 1,output 4 5 12: gpio_e[i] =1 ;gpio_o[i] =bldc_ctrl[0] [4] // BLDC Motor Control 1,output 5 13: gpio_e[i] =1 ;gpio_o[i] =bldcctrl[0] [5] // BLDC Motor Control 1,output 6 14: gpio_e[i] =1 ;gpioo[i] =bldcctrl[1] [0] // BLDC 10 Motor Control 2,output 1 15: gpio e[i] =1 ;gpio-o[i] =bldcctrl[l] [1] // BLDC Motor Control 2,output 2 16: gpio_e[i] =1 ;gpioo[i] =bldcctrl[l] [2] // BLDC Motor Control 2,output 3 15 17: gpio_e[i] =1 ;gpio-o[i] =bldcctrl[1] [3] / BLDC Motor Control 2,output 4 18: gpio_e[i] =1 ;gpioo[i] =bldcctrl[1] [4] // BLDC Motor Control 2,output 5 19: gpio e[i] =1 ;gpio_o[i] =bldcctr1 [1] [5] / BLDC 20 Motor Control 2,output 6 20: gpio e[i] =1 ;gpio-o[i] =lssgpio_clk[o] // LSS Clk 0 21: gpio e[i] =1 ;gpio_o[il =lss-gpio_clk[l] // LSS Clk 1 25 22: gpio_e~i] =lss_gpio-e[o] ;gpio-o[i] =lss-gpio-dout[O]; // LSS Data 0 gpio lss din[O] = gpioli[i] 23: gpio_e[i] =lssgpio-e[l] ;gpio-o~i] =lssgpio-dout[l]; // LSS Data 1 30 gpio_iss din[l] = gpio i[i] 24: gpioe[i] =isi-gpio-e[O] ;gpio-o[i] =isi_gpio-dout[0]; // ISI Control 1 gpioisidin[Ol = gpio i[i] 25: gpio_e[i] =isigpio e[l] ;gpio-o[i] 35 =isigpio-dout[l]; // ISI Control 2 gpio isi din [l] = gpio [ii] 26: gpio e[i] =isigpio-e[2] ;gpio-o[i] =isi_gpio-dout[2]; // ISI Control 3 gpio isi din[2] = gpio i[i] 40 27: gpio_e[i] =isiagpio e[3] ;gpio-oli] =isi-gpio-dout[3]; // ISI Control 4 WO 2004/050369 PCT/AU2003/001616 214 gpio isi din[3] = gpio-i[i] 28: gpioe[i] =cpuiodir[i] ;gpio_o[i] =cpuioout[iJ]; // CPU Direct 29: gpio e[i] =1 ;gpioo[i] =usbhgpiopower-en 5 // USB host power enable 30: gpio e[i] =0 ;gpio o[i] =0 // Input only mode end case // all gpio are always readable by the CPU 10 cpuio in[i] = gpio i[i]; } The input selection pseudocode, for determining which pin connects to which de glitch circuit. for( i=0 ;i < 10 ; i++) { 15 pin num = input-pin select [i] deglitch input [i] = gpio i [pin num] } The gpio usbhovercurrent output to the USB core is driven by a selected deglitched input (configured by the USBOverCurrentPinSelect register). 20 index = USBOverCurrentPinSelect gpiousbhovercurrent = cpuioindeglitch [index] 13.11.5 Wakeup generator The wakeup generator compares the deglitched inputs with the configured mask 25 (WakeUpinputMask) and level (WakeUpLevel), and determines whether to generate a wakeup to the CPR block. for (i =0;i<10; i++) if (wakeup-level = 0) then // level 0 active 30 wakeup = wakeup OR wakeupinput mask [i] AND NOT cpuio in deglit ch Ei] else // level 1 active wakeup = wakeup OR wakeup input-mask [i] AND cpuioindeglitch [i] 35 } // assign the output gpio cpr wakeup = wakeup 13.11.6 LED pulse generator WO 2004/050369 PCT/AU2003/001616 215 The pulse generator logic consists of a 7-bit counter that is incremented on a 1 ps pulse from the timers block impulsese. The LED control signal is generated by comparing the count value with the configured duty cycle for the LED (leddutysel). The logic is given by: 5 for (i=O i<4 ;i++) { // for each LED pin // period divided into 8 segments perioddiv8 = cnt[6:4]; if (perioddiv8 < ledduty sel[i]) then led ctrl[i] 1 10 else ledctrl[i] = 0 } // update the counter every lus pulse if (timpulse[0] == 1) then 15 cnt ++ 13.11.7 Stepper Motor control The motor controller consists of 2 counters, and 4 phase generator logic blocks, one per motor control pin. The counters decrement each time a timing pulse (cnt en) is received. The counters start at the configured clock period value (motor mas_c/kAperiod) and decrement to zero. If the 20 counters are enabled (via motormas_c/k_enable), the counters will automatically restart at the configured clock period value, otherwise they will wait until the counters are re-enabled. The timing pulse period is one of pc/k, 1 ps, 1 00ps, 1ms depending on the motormas_c/k sel signal. The counters are used to derive the phase and duty cycle of each motor control pin. 25 // decrement logic if (cnten == 1) then if ((mascnt == 0) AND (motor mas clk enable == 1)) then mascnt = motormas_clk period[15:0J elsif ((mascnt == 0) AND (motormasclkenable == 0)) then 30 mas cnt= 0 else mas cnt else // hold the value mas cnt = mas cnt 35 The phase generator block generates the motor control logic based on the selected clock generator (motor mas_c/k_se/) the motor control high transition point (curr motor_ctrhigh) and the motor control low transition point (currmotor ctrl/ow). The phase generator maintains current copies of the motor_ctrlconfig configuration value 40 (motor ctrl config[31:16] becomes currmotor ctr/ high and motorctrlconfig[15:0] becomes WO 2004/050369 PCT/AU2003/001616 216 currmotorctrllow). It updates these values to the current register values when it is safe to do so without causing a glitch on the output motor pin. Note that when reprogramming the motor ctrl config register to reorder the sequence of the transition points (e.g changing from low point less than high point to low point greater than high 5 point and vice versa) care must taken to avoid introducing glitching on the output pin. There are 4 instances one per motor control pin. The logic is given by: // select the input counter to use if (motor mas clk sel == 1) then 10 count = mas cnt tl] else count = mas cnt[0] // Generate the phase and duty cycle if (count == curr motor ctrllow) then 15 motor ctrl = 0 elsif (count == curr-motor-ctrlhigh) then motor ctrl = 1 else motorctrl = motor ctrl // remain the same 20 // update the current registers at period boundary if (count == 0) then curr_motorctrlhigh = motorctrlconfig [31:16] // update to new high value currmotorctrllow = motorctrlconfig[15:0] // 25 update to new high value 13.11.8 Input deglitch The input deglitch logic rejects input states of duration less than the configured number of time units (deglitchcnt), input states of greater duration are reflected on the output cpu io in deglitch. The 30 time units used (either pck, 1 pts, 1 00is, 1 ms) by the deglitch circuit is selected by the deglitch_ck_src bus. There are 2 possible sets of deglitch cnt and deg/itch_ck src that can be used to deglitch the input pins. The values used are selected by the deglitch se/ signal. There are 10 deglitch circuits in the GPIO. Any GPIO pin can be connected to a deglitch circuit. 35 Pins are selected for deglitching by the /nputPinSelect registers. Each selected input can be used to generate an interrupt. The interrupt can be generated from the raw input signal (degfitch.Jnput) or a deglitched version of the input (cpuio-in deglitch). The interrupt source is selected by the interrupt_srcselect signal. The counter logic is given by 40 if (deglitch input != deglitch input delay) then WO 2004/050369 PCT/AU2003/001616 217 cnt = deglitch-cnt outputen = 0 elsif (cnt == 0 ) then cnt = cnt 5 outputen = 1 elsif (cnt en == 1) then cnt outputen = 0 10 13.11.9 Frequency Analyser The frequency analyser block monitors a selected deglitched input (cpuLIo in deglitch) or a direct selected input (degitchinput) and detects positive edges. The selected input is configured by FreqAnaPinSe/ect and FreqAnaPinFormSel registers. Between successive positive edges detected on the input it increments a counter (FreqAnaCount) by a programmed amount (FreqAnaCount/nc) 15 on each clock cycle. When a positive edge is detected the FreqAnaLastPeriod register is updated with the top 16 bits of the counter and the counter is reset. The frequency analyser also maintains a running average of the FreqAnaLastPeriod register. Each time a positive edge is detected on the input the FreqAnaAverage register is updated with the new calculated FreqAnaLastPeriod. The average is calculated as 7/8 the current value plus 1/8 of the new value. The FreqAnaLastPeriod, 20 FreqAnaCount and FreqAnaAverage registers can be written to by the CPU. The pseudocode is given by if ((pin == 1) AND pin-delay ==0 ))then // positive edge detected freqana lastperiod[15:0] = freq_anacount [31: 16] 25 freqanaaverage[15:01 = freqana average[i5:0] freq ana average[15:3] freqana-lastperiod [15:3] freqanacount[15:0] = 0 30 else freqanacount [31:0] = freq_ana count[31:0] + freqana countinc [19:0] // implement the configuration register write if (wr last en == 1) then 35 freqanalastperiod = wrdata elsif (wraverageen == 1 ) then freqana average = wrdata elsif (wrfreqcounten == 1) then freq ana count = wrdata 40 13.11.10 BLDC Motor Controller WO 2004/050369 PCT/AU2003/001616 218 The BLDC controller logic is identical for both instances, only the input connections are different. The logic implements the truth table shown in Table .The six q outputs are combinationally based on the direction, ha, hb, hc and pwm inputs. The direction input has 2 possible sources selected by the mode, the pseudocode is as follows 5 // determine if in internal or external direction mode if (mode == 1) then // internal mode direction = int direction else // external mode direction = ext direction 10 14 Interrupt Controller Unit (ICU) The interrupt controller accepts up to N input interrupt sources, determines their priority, arbitrates based on the highest priority and generates an interrupt request to the CPU. The ICU complies with the interrupt acknowledge protocol of the CPU. Once the CPU accepts an interrupt (i.e. processing of its service routine begins) the interrupt controller will assert the next arbitrated interrupt if one is 15 pending. Each interrupt source has a fixed vector number N, and an associated configuration register, IntReg[N]. The format of the IntRegfN] register is shown in Table 87 below. Table 87. IntReg[N] register format Field bit(s) Description Priority 3:0 Interrupt priority Type 5:4 Determines the triggering conditions for the interrupt 00 - Positive edge 10 - Negative edge 01 - Positive level 11 - Negative level Mask 6 Mask bit. 1 - Interrupts from this source are enabled, o - Interrupts from this source are disabled. Note that there may be additional masks in operation at the source of the interrupt. Reserved 31:7 Reserved. Write as 0. 20 Once an interrupt is received the interrupt controller determines the priority and maps the programmed priority to the appropriate CPU priority levels, and then issues an interrupt to the CPU. The programmed interrupt priority maps directly to the LEON CPU interrupt levels. Level 0 is no interrupt. Level 15 is the highest interrupt level. 25 14.1 INTERRUPT PREEMPTION WO 2004/050369 PCT/AU2003/001616 219 With standard LEON pre-emption an interrupt can only be pre-empted by an interrupt with a higher priority level. If an interrupt with the same priority level (1 to 14) as the interrupt being serviced becomes pending then it is not acknowledged until the current service routine has completed. Note that the level 15 interrupt is a special case, in that the LEON processor will continue to take 5 level 15 interrupts (i.e re-enter the ISR) as long as level 15 is asserted on the icu cpuilevel. Level 0 is also a special case, in that LEON consider level 0 interrupts as no interrupt, and will not issue an acknowledge when level 0 is presented on the icu cputievel bus. Thus when pre-emption is required, interrupts should be programmed to different levels as interrupt priorities of the same level have no guaranteed servicing order. Should several interrupt sources be 10 programmed with the same priority level, the lowest value interrupt source will be serviced first and so on in increasing order. The interrupt is directly acknowledged by the CPU and the ICU automatically clears the pending bit of the lowest value pending interrupt source mapped to the acknowledged interrupt level. All interrupt controller registers are only accessible in supervisor data mode. If the user code wishes 15 to mask an interrupt it must request this from the supervisor and the supervisor software will resolve user access levels. 14.2 INTERRUPT SOURCES The mapping of interrupt sources to interrupt vectors (and therefore IntReg[N] registers) is shown in Table 88 below. Please refer to the appropriate section of this specification for more details of the 20 interrupt sources. Table 88. Interrupt sources vector table Vector Source Description 0 Timers WatchDog Timer Update request 1 Timers Generic Timer 1 interrupt 2 Timers Generic Timer 2 interrupt 3 PCU PEP Sub-system Interrupt- TE finished band 4 PCU PEP Sub-system Interrupt- LBD finished band 5 PCU PEP Sub-system Interrupt- CDU finished band 6 PCU PEP Sub-system Interrupt- CDU error 7 PCU PEP Sub-system Interrupt- PCU finished band 8 PCU PEP Sub-system Interrupt- PCU Invalid address interrupt 9 PHI PEP Sub-system Interrupt- PHI Line Sync Interrupt 10 PHI PEP Sub-system Interrupt- PHI Buffer underrun 11 PHI PEP Sub-system Interrupt- PHI Page finished 12 PHI PEP Sub-system Interrupt- PHI Print ready 13 SCB USB Host interrupt 14 SCB USB Device interrupt 15 SCB ISI interrupt WO 2004/050369 PCT/AU2003/001616 220 16 SCB DMA interrupt 17 LSS LSS interrupt, LSS interface 0 interrupt request 18 LSS LSS interrupt, LSS interface 1 interrupt request 19-28 GPIO GPIO general purpose interrupts 29 Timers Generic Timer 3 interrupt 14.3 IMPLEMENTATION 14.3.1 Definitions of I/O Table 89. Interrupt Controller Unit 1/0 definition Port name Pins 11/0 Description Clocks and Resets Pclk 1 In System Clock prstn I In System reset, synchronous active low CPU interface cpu adr[7:2] 6 In CPU address bus. Only 6 bits are required to decode the address space for the ICU block cpudataout[31:0] 32 In Shared write data bus from the CPU icucpu data[31:0] 32 Out Read data bus to the CPU cpurwn 1 In Common read/not-write signal from the CPU cpu_icusel 1 In Block select from the CPU. When cpuicusel is high both cpuadr and cpu dataout are valid icucpu rdy 1 Out Ready signal to the CPU. When icu cpurdy is high it indicates the last cycle of the access. For a write cycle this means cpu_dataout has been registered by the ICU block and for a read cycle this means the data on icu_cpu data is valid. icucpuilevel[3:0] 4 Out Indicates the priority level of the current active interrupt. cpu_iack 1 In Interrupt request acknowledge from the LEON core. cpu-icuilevel[3:0] 4 In Interrupt acknowledged level from the LEON core icucpu-berr 1 Out Bus error signal to the CPU indicating an invalid access. cpu acode[1:0] 2 In CPU Access Code signals. These decode as follows: 00 - User program access 01 - User data access 10 - Supervisor program access WO 2004/050369 PCT/AU2003/001616 221 11 - Supervisor data access icu cpu debug_valid 1 Out Debug Data valid on icu cpudata bus. Active high Interrupts tim-icuwdirq 1 In Watchdog timer interrupt signal from the Timers block tim_icuirq[2:0] 3 In Generic timer interrupt signals from the Timers block gpio-icu-irq[9:0] 10 In GPIO pin interrupts usb-icuirq[1:0] 2 In USB host and device interrupts from the SCB Bit 0 - USB Host interrupt Bit 1 - USB Device interrupt isi_icu_irq 1 In ISI interrupt from the SCB dma-icu-irq 1 In DMA interrupt from the SCB issicu irq[1:0] 2 In LSS interface interrupt request cdufinishedband 1 In Finished band interrupt request from the CDU cdu-icujpegerror 1 In JPEG error interrupt from the CDU lbdfinishedband 1 In Finished band interrupt request from the LBD te_finishedband 1 In Finished band interrupt request from the TE pcu-finishedband 1 In Finished band interrupt request from the PCU pcu icuaddressinvalid 1 In Invalid address interrupt request from the PCU phi icuunderrun 1 In Buffer underrun interrupt request from the PHI phi icupagefinish 1 In Page finished interrupt request from the PHI phi icuprint rdy 1 In Print ready interrupt request from the PHI phi icu linesyncint 1 In Line sync interrupt request from the PHI 14.3.2 Configuration registers The configuration registers in the ICU are programmed via the CPU interface. Refer to section 11.4 on page 96 for a description of the protocol and timing diagrams for reading and writing registers in 5 the ICU. Note that since addresses in SoPEC are byte aligned and the CPU only supports 32-bit register reads and writes, the lower 2 bits of the CPU address bus are not required to decode the address space for the ICU. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of icu pcu data. Table 90 lists the configuration registers in the ICU block. 10 The ICU block will only allow supervisor data mode accesses (i.e. cpu_acode[1:0] SUPERVISORDATA). All other accesses will result in icu cpu berr being asserted. Table 90. ICU Register Map Address Register bits Reset Description WO 2004/050369 PCT/AU2003/001616 222 ICUbase + Ox00 - Ox74 lntReg[29:0] 30x7 0x00 Interrupt vector configuration register 0x88 IntClear 30 OxOOO Interrupt pending clear register. If written with a 0000 one it clears corresponding interrupt Bits[30:0] - Interrupts sources 30 to 0 (Reads as zero) 0x90 IntPending 30 OxO00 Interrupt pending register. (Read Only) 0000 Bits[30:0]- Interrupts sources 30 to 0 OxAO IntSource 5 Ox1 F Indicates the interrupt source of the last acknowl edged interrupt. The Nointerrupt value is defined as all bits set to one. (Read Only) xCO DebugSelect[7:2] 6 Ox00 Debug address select. Indicates the address of the register to report on the icucpudata bus when it is not otherwise being used. 14.3.3 ICU partition 14.3.4 Interrupt detect The ICU contains multiple instances of the interrupt detect block, one per interrupt source' The 5 interrupt detect block examines the interrupt source signal, and determines whether it should generate request pending (int pend) based on the configured interrupt type and the interrupt source conditions. If the interrupt is not masked the interrupt will be reflected to the interrupt arbiter via the int_active signal. Once an interrupt is pending it remains pending until the interrupt is accepted by the CPU or it is level sensitive and gets removed. Masking a pending interrupt has the effect of 10 removing the interrupt from arbitration but the interrupt will still remain pending. When the CPU accepts the interrupt (using the normal ISR mechanism), the interrupt controller automatically generates an interrupt clear for that interrupt source (cpu.jnt clear). Alternatively if the interrupt is masked, the CPU can determine pending interrupts by polling the IntPending registers. Any active pending interrupts can be cleared by the CPU without using an ISR via the 15 lntClear registers. Should an interrupt clear signal (either from the interrupt clear unit or the CPU) and a new interrupt condition happen at the same time, the interrupt will remain pending. In the particular case of a level sensitive interrupt, if the level remains the interrupt will stay active regardless of the clear signal. The logic is shown below: 20 mask = int-config[6] type = int-config[5:4] intpend = last intpend // the last pending interrupt // update the pending FF 25 // test for interrupt condition WO 2004/050369 PCT/AU2003/001616 223 if (type == NEGLEVEL) then intJpend = NOT(intsrc) elsif (type == POSLEVEL) intend = int src 5 elsif ((type == POSEDGE ) AND (int src == 1) AND (last int src == 0)) intpend = 1 elsif ((type == NEGEDGE ) AND (int src == 0) AND (last int src == 1)) 10 intend = 1 elsif ((int clear == 1 )OR (cpuintclear==1)) then intpend 0 else int pend = lastint-pend // stay the same as before 15 // mask the pending bit if (mask == 1) then int_active = intpend else int active = 0 20 // assign the registers lastint src = int src last int_pend = intpend 14.3.5 Interrupt arbiter The interrupt arbiter logic arbitrates a winning interrupt request from multiple pending requests 25 based on configured priority. It generates the interrupt to the CPU by setting icu cpullevel to a non-zero value. The priority of the interrupt is reflected in the value assigned to !cu cpu level, the higher the value the higher the priority, 15 being the highest, and 0 considered no interrupt. // arbitrate with the current winner int ilevel = 0 30 for (i=0;i<30;i++) { if ( int_active[il == 1) then { if (intconfig[i][3:0] > win int ilevel[3:0] ) then winint_ilevel[3:0] = int_config[i] [3:0 } 35 } // assign the CPU interrupt level int ilevel = win int ilevel[3:0] 14.3.6 Interrupt clear unit WO 2004/050369 PCT/AU2003/001616 224 The interrupt clear unit is responsible for accepting an interrupt acknowledge from the CPU, determining which interrupt source generated the interrupt, clearing the pending bit for that source and updating the IntSource register. When an interrupt acknowledge is received from the CPU, the interrupt clear unit searches through 5 each interrupt source looking for interrupt sources that match the acknowledged interrupt level (cpuicu level) and determines the winning interrupt (lower interrupt source numbers have higher priority). When found the interrupt source pending bit is cleared and the IntSource register is updated with the interrupt source number. The LEON interrupt acknowledge mechanism automatically disables all other interrupts temporarily 10 until it has correctly saved state and jumped to the ISR routine. It is the responsibility of the ISR to re-enable the interrupts. To prevent the IntSource register indicating the incorrect source for an interrupt level, the ISR must read and store the IntSource value before re-enabling the interrupts via the Enable Traps (ET) field in the Processor State Register (PSR) of the LEON. See section 11.9 on page 132 for a complete description of the interrupt handling procedure. 15 After reset the state machine remains in Idle state until an interrupt acknowledge is received from the CPU (indicated by cpujlack). When the acknowledge is received the state machine transitions to the Compare state, resetting the source counter (cnt) to the number of interrupt sources. While in the Compare state the state machine cycles through each possible interrupt source in decrementing order. For each active interrupt source the programmed priority (int prority[cnt][3:0]) 20 is compared with the acknowledged interrupt level from the CPU (cpu icu levell, if they match then the interrupt is considered the new winner. This implies the last interrupt source checked has the highest priority, e.g interrupt source zero has the highest priority and the first source checked has the lowest priority. After all interrupt sources are checked the state machine transitions to the /ntClear state, and updates the intsource register on the transition. 25 Should there be no active interrupts for the acknowledged level (e.g. a level sensitive interrupt was removed), the /ntSource register will be set to Nointerrupt .Nointerrupt is defined as the highest possible value that /ntSource can be set to (in this case Ox1 F), and the state machine will return to /d/e. The exact number of compares performed per clock cycle is dependent the number of interrupts, 30 and logic area to logic speed trade-off, and is left to the implementer to determine. A comparison of all interrupt sources must complete within 8 clock cycles (determined by the CPU acknowledge hardware). When in the IntClear state the state machine has determined the interrupt source to clear (indicated by the intsource register). It resets the pending bit for that interrupt source, transitions back to the 35 Idle state and waits for the next acknowledge from the CPU. The minimum time between successive interrupt acknowledges from the CPU is 8 cycles. 15 Timers Block (TIM) The Timers block contains general purpose timers, a watchdog timer and timing pulse generator for use in other sections of SoPEC. 40 15.1 WATCHDOG TIMER WO 2004/050369 PCT/AU2003/001616 225 The watchdog timer is a 32 bit counter value which counts down each time a timing pulse is received. The period of the timing pulse is selected by the WatchDogUnitSel register. The value at any time can be read from the WatchDogTimer register and the counter can be reset by writing a non-zero value to the register. When the counter transitions from 1 to 0, a system wide reset will be 5 triggered as if the reset came from a hardware pin. The watchdog timer can be polled by the CPU and reset each time it gets close to 1, or alternatively a threshold (WatchDog/ntThres) can be set to trigger an interrupt for the watchdog timer to be serviced by the CPU. If the WatchDoglntThres is set to N, then the interrupt will be triggered on the N to N-1 transition of the WatchDogTimer. This interrupt can be effectively masked by setting the 10 threshold to zero. The watchdog timer can be disabled, without causing a reset, by writing zero to the WatchDogTimer register. 15.2 TIMING PULSE GENERATOR The timing block contains a timing pulse generator clocked by the system clock, used to generate timing pulses of programmable periods. The period is programmed by accessing the 15 TimerStartValue registers. Each pulse is of one system clock duration and is active high, with the pulse period accurate to the system clock frequency. The periods after reset are set to 1 us, I 00us and 100 ms. The timing pulse generator also contains a 64-bit free running counter that can be read or reset by accessing the FreeRunCount registers. The free running counter can be used to determine elapsed 20 time between events at system clock accuracy or could be used as an input source in low-security random number generator. 15.3 GENERIC TIMERS SoPEC contains 3 programmable generic timing counters, for use by the CPU to time the system. The timers are programmed to a particular value and count down each time a timing pulse is 25 received. When a particular timer decrements from 1 to 0, an interrupt is generated. The counter can be programmed to automatically restart the count, or wait until re-programmed by the CPU. At any time the status of the counter can be read from GenCntValue, or can be reset by writing to GenCntValue register. The auto-restart is activated by setting the GenCntAuto register, when activated the counter restarts at GenCntStartValue. A counter can be stopped or started at any 30 time, without affecting the contents of the GenCntValue register, by writing a 1 or 0 to the relevent GenCntEnable register. 15.4 IMPLEMENTATION 15.4.1 Definitions of 1/O Table 91. Timers block 1/O definition 35 Port name Pins 1/O Description Clocks and Resets PcIk I In System Clock prst n 1 In System reset, synchronous active low timpulse[2:0] 3 Out Timers block generated timing pulses, each one pclk WO 2004/050369 PCT/AU2003/001616 226 wide 0 - Nominal 1p s pulse 1 - Nominal 100 ps pulse 2 - Nominal 1Oms pulse CPU interface cpu adr[6:2] 5 In CPU address bus. Only 5 bits are required to decode the address space for the ICU block cpu dataout[31:0] 32 In Shared write data bus from the CPU tim-cpu-data[31:0] 32 Out Read data bus to the CPU cpurwn 1 In Common read/not-write signal from the CPU cpu tim-sel 1 In Block select from the CPU. When cputimsel is high both cpuadr and cpudataout are valid timcpu-rdy 1 Out Ready signal to the CPU. When tim cpurdy is high it indicates the last cycle of the access. For a write cycle this means cpu dataout has been registered by the TIM block and for a read cycle this means the data on tim-cpu data is valid. tim cpuberr 1 Out Bus error signal to the CPU indicating an invalid access. cpuacode[1:0] 2 In CPU Access Code signals. These decode as follows: 00 - User program access 01 - User data access 10 - Supervisor program access 11 - Supervisor data access tim-cpu-debugvalid I Out Debug Data valid on tim cpudata bus. Active high Miscellaneous tim_icu_wd_irq 1 Out Watchdog timer interrupt signal to the ICU block tim-icu.irq[2:0] 3 Out Generic timer interrupt signals to the ICU block timcprreset_n 1 Out Watch dog timer system reset. 15.4.2 Timers sub-block partition 15.4.3 Watchdog timer The watchdog timer counts down from pre-programmed value, and generates a system wide reset when equal to one. When the counter passes a pre-programmed threshold (wdog tim thres) value 5 an interrupt is generated (tim_cu wd irq) requesting the CPU to update the counter. Setting the counter to zero disables the watchdog reset. In supervisor mode the watchdog counter can be written to or read from at any time, in user mode access is denied. Any accesses in user mode will generate a bus error. 10 The counter logic is given by WO 2004/050369 PCT/AU2003/001616 227 if (wdog-wen == 1) then wdogtimcnt = write-data // load new data elsif ( wdogtim_cnt == 0) then wdogtimcnt = wdog_timcnt // count disabled 5 elsif ( ent en== 1 ) then wdog tim cntelse wdogtimcnt = wdogtim cnt The timer decode logic is 10 if (( wdogtimcnt == wdogtimthres) AND (wdog_tim cnt != 0 )AND (cnt en == 1)) then tim-icuwd irq = 1 else tim-icu wd irq = 0 15 // reset generator logic if (wdog tim cnt == 1) AND (cnt en == 1) then timcprresetn = 0 else tim cprreset n = 1 20 15.4.4 Generic timers The generic timers block consists of 3 identical counters. A timer is set to a pre-configured value (GenCntStartValue) and counts down once per selected timing pulse (gen unit sel). The timer can be enabled or disabled at any time (genjtim en), when disabled the counter is stopped but not 25 cleared. The timer can be set to automatically restart (genjtimauto) after it generates an interrupt. In supervisor mode a timer can be written to or read from at any time, in user mode access is determined by the GenCntUserModeEnable register settings. The counter logic is given by 30 if (gen-wen == 1) then gen-tim-cnt = write-data elsif (( cnt en == 1 )AND (gen-tim-en == 1 )) then if ( gentimcnt == 1) OR ( gentimcnt == 0) then / counter may need re-starting 35 if (gentimauto == 1) then gen tim ant = gen-timcnt_stvalue else gentimcnt = 0 // hold count at zero 40 else gen tim cnt-- WO 2004/050369 PCT/AU2003/001616 228 else gen-tim-cnt = gen tim cnt The decode logic is if (gen timcnt == 1)AND ( cnt en == 1 )AND (gen-tim-en == 1 5 )then tim icu irq = 1 else tim _icu irq = 0 15.4.5 Timing pulse generator 10 The timing pulse generator contains a general free running 64-bit timer and 3 timing pulse generators producing timing pulses of one cycle duration with a programmable period. The period is programmed by changed the TimerStartValue registers, but have a nominal starting period of 1ps, 1 00pts and 1 ms. In supervisor mode the free running timer register can be written to or read from at anytime, in user mode access is denied. The status of each of the timers can be read by accessing 15 the Pulse TimerStatus registers in supervisor mode. Any accesses in user mode will result in a bus error. 15.4.5.1 Free Run Timer The increment logic block increments the timer count on each clock cycle. The counter wraps around to zero and continues incrementing if overflow occurs. When the timing register 20 (FreeRunCount) is written to, the configuration registers block will set the freerunwen high for a clock cycle and the value on writedata will become the new count value. If freerun_wen[1] is 1 the higher 32 bits of the counter will be written to, otherwise if freerunwen[O] the lower 32 bits are written to. It is the responsibility of software to handle these writes in a sensible manner. The increment logic is given by 25 if (free runwen[l] == 1) then freeruncnt [63:32] = write-data elsif (free run wen[O] == 1) then free run cnt[31:0] = writedata else 30 free run ont ++ 15.4.5.2 Pulse Timers The pulse timer logic generates timing pulses of 1 clock cycle length and programmable period. Nominally they generate pulse periods of 1 ps, I 00ps and 1 ms. The logic for timer 0 is given by: // Nominal lus generator 35 if (pulse_0_cnt == 0 ) then pulse_0_cnt = timer startvalue [0] timpulse[0]= 1 else pulse_0_cnt - 40 tim_pulse[0]= 0 WO 2004/050369 PCT/AU2003/001616 229 The logic for timer 1 is given by: // 100us generator if ((pulse 1 cnt == 0) AND (tim pulse[0] == 1)) then 5 pulse l cnt = timer start value [l] tim_pulseEll= 1 elsif (tim-pulse[0] == 1) then pulselcnt timpulse[1]= 0 10 else pulse _cnt = pulse_1_cnt timpulse[l]= 0 The logic for the timer 2 is given by: 15 // lOms generator if ((pulse_2_cnt == 0 ) AND (timpulse[l] == 1)) then pulse_2_cnt = timer start value[21 tim_pulse[2]= 1 elsif (tim-pulse[l] == 1) then 20 pulse_2_cnt tim_pulse[2]= 0 else pulse_2_cnt = pulse_2_cnt timpulse [21 = 0 25 15.4.6 Configuration registers The configuration registers in the TIM are programmed via the CPU interface. Refer to section 11.4.3 on page 96 for a description of the protocol and timing diagrams for reading and writing registers in the TIM. Note that since addresses in SoPEC are byte aligned and the CPU only supports 32-bit register reads and writes, the lower 2 bits of the CPU address bus are not required 30 to decode the address space for the TIM. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of tim_pcu data. Table 92 lists the configuration registers in the TIM block . Table 92. Timers Register Map Address TIM_base Register #bits Reset Description Ox00 WatchDogUnitSel 2 OxO Specifies the units used for the watchdog timer: 0 - Nominal I pts pulse 1 - Nominal 100 is pulse WO 2004/050369 PCT/AU2003/001616 230 2 - Nominal 10 ms pulse 3 - pclk 0x04 WatchDogTimer 32 OxFFFF Specifies the number of units to count _FFFF before watchdog timer triggers. Ox08 WatchDoglntThres 32 OxOOO Specifies the threshold value below 0000 which the watchdog timer issues an interrupt OxOC-Oxi 0 FreeRunCount[1:0] 2x32 OxOOO Direct access to the free running 0000 counter register. Bus 0 - Access to bits 31-0 Bus 1 - Access to bits 63-32 0x14 to Ox1C GenCntStartValue[ 3x32 OxOOO Generic timer counter start value, 2:0] 0000 number of units to count before event Ox20 to Ox28 GenCntValue[2:0] 3x32 OxOOO Direct access to generic timer counter 0000 registers Ox2C to 0x34 GenCntUnitSel[2:0 3x2 OxO Generic counter unit select. Selects the timing units used with corresponding counter: 0 - Nominall ps pulse 1 - Nominal100 ps pulse 2 - Nominal 10 ms pulse 3 - pclk 0x38 to 0x40 GenCntAuto[2:0] 3x1 OxO Generic counter auto re-start select. When high timer automatically restarts, otherwise timer stops. Ox44 to Ox4C GenCntEnable[2:0] 3x1 OxO Generic counter enable. 0 - Counter disabled I - Counter enabled 0x50 GenCntUserMode 3 Ox0 User Mode Access enable to generic Enable timer configuration register. When 1 user access is enabled. Bit 0 - Generic timer 0 Bit 1 - Generic timer I Bit 2 - Generic timer 2 Ox54 to Ox5C TimerStartValue[2: 3x8 Ox7F, Timing pulse generator start value. 0] 0x63, Indicates the start value for each 0x63 timing pulse timers. For timer 0 the start value specifies the timer period in pclk cycles - 1.
WO 2004/050369 PCT/AU2003/001616 231 For timer 1 the start value specifies the timer period in timer 0 intervals -1 For timer 2 the start value specifies the timer period in timer 1 intervals 1. Nominally the timers generate pulses at 1us,100us and 1Oms intervals respecitively. Ox60 DebugSelect[6:2] 5 0x00 Debug address select. Indicates the address of the register to report on the tim cpu data bus when it is not otherwise being used. Read Only Registers 0x64 PulseTimerStatus 24 OxOO Current pulse timer values, and pulses 7:0 - Timer 0 count 15:8 -Timer 1 count 23:16 -Timer 2 count 24 -Timer 0 pulse 25 - Timer 1 pulse 26 - Timer 2 pulse 15.4.6.1 Supervisor and user mode access The configuration registers block examines the CPU access type (cpuacode signal) and determines if the access is allowed to that particular register, based on configured user access registers. If an access is not allowed the block will issue a bus error by asserting the tim-cpuberr 5 signal. The timers block is fully accessible in supervisor data mode, all registers can written to and read from. In user mode access is denied to all registers in the block except for the generic timer configuration registers that are granted user data access. User data access for a generic timer is granted by setting corresponding bit in the GenCntUserModeEnable register. This can only be 10 changed in supervisor data mode. If a particular timer is granted user data access then all registers for configuring that timer will be accessible. For example if timer 0 is granted user data access the GenCntStartVaue[0], GenCntUnitSe[0], GenCntAuto[], GenCntEnabe[0] and GenCntValue[O] registers can all be written to and read from without any restriction. Attempts to access a user data mode disabled timer configuration register will result in a bus error. 15 Table 93 details the access modes allowed for registers in the TIM block. In supervisor data mode all registers are accessable. All forbidden accesses will result in a bus error (timcpuberr asserted).
WO 2004/050369 PCT/AU2003/001616 232 Table 93. TIM supervisor and user access modes Register Registers Access Permission Address Ox00 WatchDogUnitSel Supervisor data mode only 0x04 WatchDogTimer Supervisor data mode only 0x08 WatchDoglntThres Supervisor data mode only 0xOC-Oxl0 FreeRunCount Supervisor data mode only 0x14 GenCntStartValue[O] GenCntUserModeEnable[0j 0x18 GenCntStartValue[1] GenCntUserModeEnable[1] Ox1 C GenCntStartValue[2] GenCntUserModeEnable[2] 0x20 GenCntValue[O] GenCntUserModeEnabe[0] 0x24 GenCntValue[1] GenCntUserModeEnable[1] 0x28 GenCntValue[2] GenCntUserModeEnable[2] Ox2C GenCntUnitSel[0] GenCntUserModeEnable[O] 0x30 GenCntUnitSel[1] GenCntUserModeEnable[1 ] 0x34 GenCntUnitSel[2] GenCntUserModeEnable[2] 0x38 GenCntAuto[0] GenCntUserModeEnable[] Ox3C GenCntAuto[1] GenCntUserModeEnable[1 ] 0x40 GenCntAuto[2] GenCntUserModeEnable[2] 0x44 GenCntEnable[O] GenCntUserModeEnable[O] 0x48 GenCntEnable[1] GenCntUserModeEnable[1 I Ox4C GenCntEnable[2] GenCntUserModeEnable[2] 0x50 GenCntUserModeEnable Supervisor data mode only 0x54-Ox5C TimerStartValue[2:0] Supervisor data mode only 0x60 DebugSelect Supervisor data mode only 0x64 PulseTimerStatus Supervisor data mode only 16 Clocking, Power and Reset (CPR) The CPR block provides all of the clock, power enable and reset signals to the SoPEC device. 5 16.1 POWERDOWN MODES The CPR block is capable of powering down certain sections of the SoPEC device. When a section is powered down (i.e. put in sleep mode) no state is retained(except the PSS storage), the CPU must re-initialize the section before it can be used again. For the purpose of powerdown the SoPEC device is divided into sections: 10 Table 94. Powerdown sectioning Section Block Print Engine PipelinePCU SubSystem (Section 0) WO 2004/050369 PCT/AU2003/001616 233 CDU CFU LBD SFU TE TFU HCU DNC DWU LLU PHI CPU-DRAM (Section 1) DRAM CPU/MMU DIU TIM ROM LSS PSS ICU ISI Subsystem (Section 2) ISI (SCB) DMA Ctrl (SCB) GPIO USB Subsystem (Section 3) USB (SCB) Note that the CPR block is not located in any section. All configuration registers in the CPR block are clocked by an ungateable clock and have special reset conditions. 16.1.1 Sleep mode Each section can be put into sleep mode by setting the corresponding bit in the SleepModeEnable 5 register. To re-enable the section the sleep mode bit needs to be cleared and then the section should be reset by writing to the relevant bit in the ResetSection register. Each block within the section should then be re-configured by the CPU. If the CPU system (section 1) is put into sleep mode, the SoPEC device will remain in sleep mode until a system level reset is initiated from the reset pin, or a wakeup reset by the SCB block as a 10 result of activity on either the USB or ISI bus. The watchdog timer cannot reset the device as it is in section 1 also, and will be in sleep mode. If the CPU and ISI subsystem are in sleep mode only a reset from the USB or a hardware reset will re-activate the SoPEC device. If all sections are put into sleep mode, then only a system level reset initiated by the reset pin will 15 re-activate the SoPEC device.
WO 2004/050369 PCT/AU2003/001616 234 Like all software resets in SoPEC the ResetSection register is active-low i.e. a 0 should be written to each bit position requiring a reset. The ResetSection register is self-reseting. 16.1.2 Sleep Mode powerdown procedure When powering down a section, the section may retain it's current state (although not gauranteed 5 to). It is possible when powering back up a section that inconsistancies between interface state machines could cause incorrect operation. In order to prevent such condition from happening, all blocks in a section must be disabled before powering down. This will ensure that blocks are restored in a benign state when powered back up. In the case of PEP section units setting the Go bit to zero will disable the block. The DRAM 10 subsystem can be effectively disabled by setting the RotationSync bit to zero, and the SCB system disabled by setting the DMAAccessEn bits to zero turning off the DMA access to DRAM. Other CPU subsystem blocks without any DRAM access do not need to be disabled. 16.2 RESET SOURCE The SoPEC device can be reset by a number of sources. When a reset from an internal source is 15 initiated the reset source register (ResetSrc) stores the reset source value. This register can then be used by the CPU to determine the type of boot sequence required. 16.3 CLOCK RELATIONSHIP The crystal oscillator excites a 32MHz crystal through the xtalin and xtalout pins. The 32MHz output is used by the PLL to derive the master VCO frequency of 960MHz. The master clock is then 20 divided to produce 320MHz clock (ck320), 160MHz clock (clk160) and 48MHz (clk48) clock sources. The phase relationship of each clock from the PLL will be defined. The relationship of internal clocks clk320, cik48 and cik160 to xtalin will be undefined. At the output of the clock block, the skew between each pc/k domain (pc/k_section[2:0] and jc/k) 25 should be within skew tolerances of their respective domains (defined as less than the hold time of a D-type flip flop). The skew between dock and pclk should also be less than the skew tolerances of their respective domains. The usbclk is derived from the PLL output and has no relationship with the other clocks in the 30 system and is considered asynchronous. 16.4 PLL CONTROL The PLL in SoPEC can be adjusted by programming the PLLRangeA, PLLRangeB, PLLTunebits and PLLMu/t registers. If these registers are changed by the CPU the values are not updated until the PLLUpdate register is written to. Writing to the PLLUpdate register triggers the PLL control state 35 machine to update the PLL configuration in a safe way. When an update is active (as indicated by PLLUpdate register) the CPU must not change any of the configuration registers, doing so could cause the PLL to lose lock indefintely, requiring a hardware reset to recover. Configuring the PLL registers in an inconsistent way can also cause the PLL to lose lock, care must taken to keep the PLL configuration within specified parameters.
WO 2004/050369 PCT/AU2003/001616 235 The VCO frequency of the PLL is calculated by the number of divider in the feedback path. PLL output A is used as the feedback source. VCOfreq = REFCLK x PLLMult x PLLRangeA x External divider VCOfreq = 32 x 3 x 10 x 1 = 960 Mhz. 5 In the default PLL setup, PLLMu/t is set to 3, PLLRangeA is set to 3 which corresponds to a divide by 10, PLLRangeB is set to 5 which corresponds to a divide by 3. PLLouta = VCOfreq / PLLRangeA = 960Mhz / 10 = 96 Mhz PLLoutb = VCOfreq / PLLRangeB = 960Mhz /3 = 320 Mhz See [16] for complete PLL setup parameters. 10 16.5 IMPLEMENTATION 16.5.1 Definitions of 1/O Table 95. CPR 110 definition Port name Pins 1/O Description Clocks and Resets Xtalin 1 In Crystal input, direct from 10 pin. Xtalout 1 Inout Crystal output, direct to 10 pin. pclk-section[3:0] 4 Out System clocks for each section Doclk 1 Out Data out clock (2x pclk) for the PHI block Jclk 1 Out Gated version of system clock used to clock the JPEG decoder core in the CDU Usbclk 1 Out USB clock, nominally at 48 Mhz iclk_enable 1 In Gating signal for jc/k. When 1 jc/k is enabled resetn I In Reset signal from the reset n pin usb-cprresetn 1 In Reset signal from the USB block isi-cprreset_n 1 In Reset signal from the ISI block timcpr-resetn 1 In Reset signal from watch dog timer. gpio cprwakeup 1 In SoPEC wake up from the GPIO, active high. prst-n-section[3:0] 4 Out System resets for each section, synchronous active low dorstn 1 Out Reset for PHI block, synchronous to doclk jrstn 1 Out Reset for JPEG decoder core in CDU block, synchronous tojc/k usbrstn 1 Out Reset for the USB block, synchronous to usbclk CPU interface cpu-adr[5:21 3 In CPU address bus. Only 4 bits are required to decode the address space for the CPR block cpu dataout[31:0] 32 In Shared write data bus from the CPU cprcpu-data[31:0] 32 Out Read data bus to the CPU WO 2004/050369 PCT/AU2003/001616 236 cpurwn 1 In Common read/not-write signal from the CPU cpucpr-sel 1 in Block select from the CPU. When cpucprsel is high both cpu adr and cpudataout are valid cprcpu-rdy 1 Out Ready signal to the CPU. When aprcpu rdy is high it indicates the last cycle of the access. For a write cycle this means cpu dataout has been registered by the block and for a read cycle this means the data on cprcpu data is valid. cprcpu-berr 1 Out Bus error signal to the CPU indicating an invalid access. cpu acode[1:0] 2 In CPU Access Code signals. These decode as allows: 00 - User program access 01 - User data access 10 - Supervisor program access 11 - Supervisor data access cprcpu debugvalid 1 Out Debug Data valid on cprcpudata bus. Active high 16.5.2 Configuration registers The configuration registers in the CPR are programmed via the CPU interface. Refer to section 11.4 on page 96 for a description of the protocol and timing diagrams for reading and writing registers in the CPR. Note that since addresses in SoPEC are byte aligned and the CPU only supports 32-bit 5 register reads and writes, the lower 2 bits of the CPU address bus are not required to decode the address space for the CPR. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of cprpcu data. Table 96 lists the configuration registers in the CPR block. The CPR block will only allow supervisor data mode accesses (i.e. cpu acode[1:0] = 10 SUPERVISOR DA TA ). All other accesses will result in cpr cpu berr being asserted . Table 96. CPR Register Map Address Register #bits Reset Description CPR "base+ Ox00 SleepModeEnable 4 OX0 Sleep Mode enable, when high a section of logic is put into powerdown. Bit 0 - Controls section 0 Bit 1 - Controls section 1 Bit 2 - Controls section 2 Bit 3 - Controls section 3 Note that the SleepModeEnable register WO 2004/050369 PCT/AU2003/001616 237 has special reset conditions. See Section 16.5.6 for details 0x04 ResetSrc 5 0x1a Reset Source register, indicating the source of the last reset (or wake-up) Bit 0 - External Reset Bit 1 - USB wakeup reset Bit 2 - ISI wakeup reset Bit 3 - Watchdog timer reset Bit 4 - GPIO wake-up (Read Only Register) 0x08 ResetSection 4 OxF Active-low synchronous reset for each section, self-resetting. Bit 0 - Controls section 0 Bit 1 - Controls section 1 Bit 2 - Controls section 2 Bit 3 - Controls section 3 Ox0C DebugSelect[5:2] 4 OxO Debug address select. Indicates the address of the register to report on the cprcpu data bus when it is not otherwise being used. PLL Control 0x10 PLLTuneBits 10 Ox3BC PLL tuning bits 0x1 4 PLLRangeA 4 0x3 PLLOUT A frequency selector (defaults to 60Mhz to 125Mhz) 0x18 PLLRangeB 3 Ox5 PLLOUT B frequency selector (defaults to 200Mhz to 400Mhz) OxiC PLLMultiplier 5 0x03 PLL multiplier selector, defaults to refc/k x 3 0x20 PLLUpdate 1 Ox0 PLL update control. A write (of any value) to this register will cause the PLL to lose lock for -100us. Reading the register indicates the status of the update. 0 - PLL update complete 1 - PLL update active No writes to PLL TuneBits,PLLRangeA,PLL RangeB,PLLMultiplier or PLL Update are allowed while the PLL update is WO 2004/050369 PCT/AU2003/001616 238 active. a. Reset value depends on reset source. External reset shown. 16.5.3 CPR Sub-block partition 16.5.4 resetn deglitch The external reset n signal is deglitched for about 1 ps. resetn must maintain a state for 1 us 5 second before the state is passed into the rest of the device. All deglitch logic is clocked on bufrefclk. 16.5.5 Sync reset The reset synchronizer retimes an asynchronous reset signal to the clock domain that it resets. The circuit prevents the inactive edge of reset occurring when the clock is rising 10 16.5.6 Reset generator logic The reset generator logic is used to determine which clock domains should be reset, based on configured reset values (reset section n), the external reset (reset n), watchdog timer reset (timcprreset n), the USB reset (usbcpr reset n), the GPIO wakeup control (gpiocprwakeup) and the ISI reset (is! cprreset n). The reset direct from the 10 pin (reset n) is synchronized and 15 de-glitched before feeding the reset logic. All resets are lengthened to at least 16 pclk cycles, regardless of the duration of the input reset. The clock for a particular section must be running for the reset to have an effect. The clocks to each section can be enabled/disabled using the SleepModeEnable register. Resets from the ISI or USB block reset everything except its own section (section 2 or 3). 20 Table 97. Reset domains Reset signal Domain reset dom[0] Section 0 pclk domain (PEP) reset dom[1] Section 1 pclk domain (CPU) reset dom[2] Section 2 pclk domain (131) reset dom[3] Section 3 usbclk/pclk domain (USB) reset dom[4] doclk domain reset dom[5] iclk domain The logic is given by if (resetdg-n == 0) then 25 resetdom[5:0] = Ox00 // reset everything reset src[4:0] = Ox01 cfg resetn = 0 sleep-modeen[3:0] = OxO // re-awaken all sections elsif (timcprreset n == 0) then 30 reset_dom[5:0] = Ox00 // reset everything except CPR config WO 2004/050369 PCT/AU2003/001616 239 reset src[4:0] = 0x08 cfgresetn = 1 // CPR config stays the same sleepmodeen[1] = 0 // re-awaken section 1 only (awake already) 5 elsif (usb cpr resetn == 0) then resetdom[5:0] = 0x08 // all except USB domain + CPR config reset src[4:0] = Ox02 cfgresetn = 1 // CPR config stays the same 10 sleepmodeen[l] = 0 // re-awaken section 1 only, section 3 is awake elsif (isi-cprreset n == 0) then resetdom[5:0] = 0x04 // all except ISI domain + CPR config 15 resetsrc[4:0] = Ox04 cfg resetn = 1 // CPR config stays the same sleepmodeen [1 = 0 // re-awaken section 1 only, section 2 is awake elsif (gpio cprwakeup = 1) then 20 resetdom[5:0] = Ox3C // PEP and CPU sections only reset src[4:01 = 0x10 cfg reset n = 1 // CPR config stays the same sleepmodeen [1 = 0 // re-awaken section 1 only, section 2 is awake 25 else // propagate resets from reset section register reset dom[5:0] = Ox3F // default to on cfgresetn = 1 // CPR cfg registers are not in any section 30 sleep mode en[3:0] = sleep mode en[3:0] // stay the same by default if (reset sectionn[0]= 0) then resetdom[5] = 0 // jclk domain resetdom[4] = 0 // doclk domain 35 resetdom[o] = 0 // pclk section 0 domain if (reset section n[1] == 0) then reset_dom[l] = 0 // pclk section 1 domain if (reset section n[2] == 0) then resetdom[2] = 0 // pclk section 2 domain 40 (ISI) if (reset section n[3] == 0) then WO 2004/050369 PCT/AU2003/001616 240 resetdom[31 = 0 // USB domain 16.5.7 Sleep logic The sleep logic is used to generate gating signals for each of SoPECs clock domains. The gate 5 enable (gate dom) is generated based on the configured sleepmodeen and the internally generated jck_enable signal. The logic is given by // clock gating for sleep modes gate dom[5:0] = Oxo // default to all clocks 10 on if (sleep mode en[O == 1) then // section 0 sleep gate dom[0] = 1 // pclk section 0 gate dom[4] = 1 // doclk domain gatedom[51 = 1 // jclk domain 15 if (sleep_mode_en[l] = 1) then // section 1 sleep gate-dom[l] = 1 // pclk section 1 if (sleep_modeen[2] == 1) then // section 2 sleep gate dom[2] 1 // pclk section 2 if (sleepmodeen[3] == 1) then // section 3 sleep 20 gate dom[3] = 1 I/ usb section 3 // the jclk can be turned off by CDU signal if (jclkenable == 0) then gate dom[5] = 1 The clock gating and sleep logic is clocked with the masterjPclk clock which is not gated by this 25 logic, but is synchronous to other pc/ksection and jc/k domains. Once a section is in sleep mode it cannot generate a reset to restart the device. For example if section 1 is in sleep mode then the watchdog timer is effectively disabled and cannot trigger a reset. 16.5.8 Clock gate logic The clock gate logic is used to safely gate clocks without generating any glitches on the gated 30 clock. When the enable is high the clock is active otherwise the clock is gated. 16.5.9 Clock generator Logic The clock generator block contains the PLL, crystal oscillator, clock dividers and associated control logic. The PLL VCO frequency is at 960MHz locked to a 32 MHz refc/k generated by the crystal oscillator. In test mode the xtalin signal can be driven directly by the test clock generator, the test 35 clock will be reflected on the refclk signal to the PLL. 16.5.9.1 Clock divider A The clock divider A block generates the 48MHz clock from the input 96MHz clock (pilouta) generated by the PLL. The divider is enabled only when the PLL has acquired lock. 16.5.9.2 Clock divider B WO 2004/050369 PCT/AU2003/001616 241 The clock divider B block generates the 160MHz clocks from the input 320MHz clock (pl/outb) generated by the PLL. The divider is enabled only when the PLL has acquired lock. 16.5.9.3 PLL control state machine The PLL will go out of lock whenever preset goes high (the PLL reset is the only active high reset 5 in the device) or if the configuration bits plrangea, plLrangeb, pl/mult, p//tune are changed. The PLL control state machine ensures that the rest of the device is protected from glitching clocks while the PLL is being reset or it's configuration is being changed. In the case of a hardware reset (the reset is deglitched), the state machine first disables the output clocks (via the c/k gate signal), it then holds the PLL in reset while its configuration bits are reset to 10 default values. The state machine then releases the PLL reset and waits approx. 100us to allow the PLL to regain lock. Once the lock time has elapsed the state machine re-enables the output clocks and resets the remainder of the device via the resetdgn signal. When the CPU changes any of the configuration registers it must write to the PLLupdate register to allow the state machine to update the PLL to the new configuration setup. If a PLLUpdate is 15 detected the state machine first gates the output clocks. It then holds the PLL in reset while the PLL configuration registers are updated. Once updated the PLL reset is released and the state machine waits approx 1 00us for the PLL to regain lock before re-enabling the output clocks. Any write to the PLLUpdate register will cause the state machine to perform the update operation regardless of whether the configuration values changed or not. 20 All logic in the clock generator is clocked on bufrefclk which is always an active clock regardless of the state of the PLL. 17 ROM Block 17.1 OVERVIEW The ROM block interfaces to the CPU bus and contains the SoPEC boot code. The ROM block 25 consists of the CPU bus interface, the ROM macro and the ChipiD macro. The current ROM size is 16 KBytes implemented as a 4096 x32 macro. Access to the ROM is not cached because the CPU enjoys fast (no more than one cycle slower than a cache access), unarbitrated access to the ROM. Each SoPEC device is required to have a unique ChiplD which is set by blowing fuses at manufacture. IBM's 300mm ECID macro and a custom 112-bit ECID macro are used to implement 30 the ChipID offering 224-bits of laser fuses. The exact number of fuse bits to be used for the ChiplD will be determined later but all bits are made available to the CPU. The ECID macros allows all 224 bits to be read out in parallel and the ROM block will make all 224 bits available in the FuseChip/D[N] registers which are readable by the CPU in supervisor mode only. 17.2 BOOT OPERATION 35 The are two boot scenarios for the SoPEC device namely after power-on and after being awoken from sleep mode. When the device is in sleep mode it is hoped that power will actually be removed from the DRAM, CPU and most other peripherals and so the program code will need to be freshly downloaded each time the device wakes up from sleep mode. In order to reduce the wakeup boot time (and hence the perceived print latency) certain data items are stored in the PSS block (see 40 section 18). These data items include the SHA-1 hash digest expected for the program(s) to be WO 2004/050369 PCT/AU2003/001616 242 downloaded, the master/slave SoPEC id and some configuration parameters. All of these data items are stored in the PSS by the CPU prior to entering sleep mode. The SHA-1 value stored in the PSS is calculated by the CPU by decrypting the signature of the downloaded program using the appropriate public key stored in ROM. This compute intensive decryption only needs to take place 5 once as part of the power-on boot sequence - subsequent wakeup boot sequences will simply use the resulting SHA-1 digest stored in the PSS. Note that the digest only needs to be stored in the PSS before entering sleep mode and the PSS can be used for temporary storage of any data at all other times. The CPU is expected to be in supervisor mode for the entire boot sequence described by the 10 pseudocode below. Note that the boot sequence has not been finalised but is expected to be close to the following: if (ResetSrc == 1) then // Reset was a power-on reset configuresopec // need to configure peris (USB, ISI, 15 DMA, ICU etc.) // otherwise reset was a wakeup reset so peris etc. were already configured PAUSE: wait until IrqSemaphore 1= 0 // i.e. wait until an interrupt has been serviced 20 if (IrqSemaphore == DMAChanOMsg) then parse msg (DMAChanOMsgPtr) // this routine will parse the message and take any // necessary action e.g. programming the DMAChannell registers 25 elsif (IrqSemaphore == DMAChanlMsg) then // program has been downloaded CalculatedHash = gen-shal(ProgramLocn, ProgramSize) if (ResetSrc == 1) then ExpectedHash = sigdecrypt (ProgramSig, public key) 30 else ExpectedHash = PSSHash if (ExpectedHash == CalculatedHash) then jmp(PrgramLocn) // transfer control to the downloaded program 35 else send hostmsg("Program Authentication Failed") goto PAUSE: elsif (IrqSemaphore == timeout) then // nothing has happened 40 if (ResetSrc == 1) then WO 2004/050369 PCT/AU2003/001616 243 sleepmode() // put SoPEC into sleep mode to be woken up by USB/ISI activity else // we were woken up but nothing happened resetsopec (PowerOnReset) 5 else goto PAUSE The boot code places no restrictions on the activity of any programs downloaded and authenticated by it other than those imposed by the configuration of the MMU i.e. the principal function of the boot 10 code is to authenticate that any programs downloaded by it are from a trusted source. It is the responsibility of the downloaded program to ensure that any code it downloads is also authenticated and that the system remains secure. The downloaded program code is also responsible for setting the SoPEC ISlid (see section 12.5 for a description of the ISild) in a multi -SoPEC system. See the "SoPEC Security Overview" document [9] for more details of the SoPEC security features. 15 17.3 IMPLEMENTATION 17.3.1 Definitions of 1/0 Table 98. ROM Block 1/O Port name Pins 1/O Description Clocks and Resets prst-n 1 In Global reset. Synchronous to pclk, active low. Pclk 1 In Global clock CPU Interface cpu adr[14:2] 13 In CPU address bus. Only 13 bits are required to decode the address space for this block. romcpu data[31: 32 Out Read data bus to the CPU 0] cpu-rwn I In Common read/not-write signal from the CPU cpu acode[1:0] 2 In CPU Access Code signals. These decode as follows: 00 - User program access 01 - User data access 10 - Supervisor program access 11 - Supervisor data access cpu-romsel 1 In Block select from the CPU. When cpurom sel is high cpu adr is valid rom_cpurdy 1 Out Ready signal to the CPU. When rom_cpurdy is high it indicates the last cycle of the access. For a read cycle this means the data on WO 2004/050369 PCT/AU2003/001616 244 rom-cpu-data is valid. romcpuberr 1 Out ROM bus error signal to the CPU indicating an invalid access. 17.3.2 Configuration registers The ROM block will only allow read accesses to the FuseChip/D registers and the ROM with supervisor data space permissions (i.e. cpu acode[1:0J = 11). Write accesses with supervisor data space permissions 5 will have no effect. All other accesses with will result in rom cpuberr being asserted. The CPU subsystem bus slave interface is described in more detail in section 9.4.3. Table 99. ROM Block Register Map Address ROM base + Reg ster bits Reset Description' 0x4000 FuseChipDO 32 n/a Value of corresponding fuse bits 31 to 0 of the IBM 112-bit ECID macro. (Read only) 0x4004 FuseChiplID1 32 n/a Value of corresponding fuse bits 63 to 32 of the IBM 112-bit ECID macro. (Read only) 0x4008 FuseChiplD2 32 n/a Value of corresponding fuse bits 95 to 64 of the IBM 112-bit ECID macro. (Read only) Ox400C FuseChiplD3 16 n/a Value of corresponding fuse bits 111 to 96 of the IBM 112-bit ECID macro. (Read only) 0x4010 FuseChiplD4 32 n/a Value of corresponding fuse bits 31 to 0 of the Custom 112-bit ECID macro. (Read only) 0x4014 FuseChiplD5 32 n/a Value of corresponding fuse bits 63 to 32 of the Custom 112-bit ECID macro. (Read only) 0x4018 FuseChiplD6 32 n/a Value of corresponding fuse bits 95 to 64 of the Custom 112-bit ECID macro. (Read only) 0x401C FuseChiplD7 16 n/a Value of corresponding fuse bits 111 to 96 of the Custom 112-bit ECID macro. (Read only) 17.3.3 Sub-Block Partition 10 IBM offer two variants of their ROM macros; A high performance version (ROMHD) and a low power version (ROMLD). It is likely that the low power version will be used unless some implementation issue requires the high performance version. Both versions offer the same bit WO 2004/050369 PCT/AU2003/001616 245 density. The sub-block partition diagram below does not include the clocking and test signals for the ROM or ECID macros. The CPU subsystem bus interface is described in more detail in section 11.4.3. 17.3.4 Table 100. ROM Block internal signals 5 Port name idth Description Clocks and Resets prst-n 1 Global reset. Synchronous to pclk, active low. Pclk 1 Global clock Internal Signals rom_adr[l 1:0] 12 ROM address bus romsel 1 Select signal to the ROM macro instructing it to access the location at rom adr romoe 1 Output enable signal to the ROM block romdata[31:0] 32 Data bus from the ROM macro to the CPU bus interface romdvalid 1 Signal from the ROM macro indicating that the data on ram_data is valid for the address on rom_adr fusedata[31:0] 32 Data from the FuseChipD[N] register addressed by fuse reg adr fuseregadr[2:0] 3 Indicates which of the FuseChip/D registers is being addressed Sub-block signal definition 18 Power Safe Storage (PSS) Block 18.1 OVERVIEW The PSS block provides 128 bytes of storage space that will maintain its state when the rest of 10 the SoPEC device is in sleep mode. The PSS is expected to be used primarily for the storage of decrypted signatures associated with downloaded programmed code but it can also be used to store any information that needs to survive sleep mode (e.g. configuration details). Note that the signature digest only needs to be stored in the PSS before entering sleep mode and the PSS can be used for temporary storage of any data at all other times. 15 Prior to entering sleep mode the CPU should store all of the information it will need on exiting sleep mode in the PSS. On emerging from sleep mode the boot code in ROM will read the ResetSrc register in the CPR block to determine which reset source caused the wakeup. The reset source information indicates whether or not the PSS contains valid stored data, and the PSS data determines the type of boot sequence to execute. If for any reason a full power-on boot 20 sequence should be performed (e.g. the printer driver has been updated) then this is simply achieved by initiating a full software reset.
WO 2004/050369 PCT/AU2003/001616 246 Note that a reset or a powerdown (powerdown is implemented by clock gating) of the PSS block will not clear the contents of the 128 bytes of storage. If clearing of the PSS storage is required, then the CPU must write to each location individually. 18.2 IMPLEMENTATION 5 The storage area of the PSS block will be implemented as a 128-byte register array. The array is located from PSSbase through to PSS base+Ox7F in the address map. The PSS block will only allow read or write accesses with supervisor data space permissions (i.e. cpu acode[1:0 = 11). All other accesses will result in pss cpu berr being asserted. The CPU subsystem bus slave interface is described in more detail in section 11.4.3. 10 18.2.1 Definitions of I/O Table 101. PSS Block 110 Port name Pins 1/O Description Clocks and Resets prstn I In Global reset. Synchronous to pclk, active low. Pclk 1 In Global clock CPU Interface cpu _adr[6:2] 5 In CPU address bus. Only 5 bits are required to decode the address space for this block. cpu dataout[31:0] 32 In Shared write data bus from the CPU psscpudata[31:0] 32 Out Read data bus to the CPU cpusrwn 1 In Common read/not-write signal from the CPU cpu acode[1:0] 2 In CPU Access Code signals. These decode as follows: 00 - User program access 01 - User data access 10 - Supervisor program access 11 - Supervisor data access cpupss-sel 1 In Block select from the CPU. When cpu pss sel is high both cpuadr and cpudataout are valid pss-cpu-rdy 1 Out Ready signal to the CPU. When pss cpurdy is high it indicates the last cycle of the access. For a read cycle this means the data on pss cpu.data is valid. pss-cpu-berr 1 Out PSS bus error signal to the CPU indicating an invalid access. 19 Low Speed Serial Interface (LSS) 19.1 OVERVIEW 15 The Low Speed Serial Interface (LSS) provides a mechanism for the internal SoPEC CPU to communicate with external QA chips via two independent LSS buses. The LSS communicates through the GPIO block to the QA chips. This allows the QA chip pins to be reused in multi- WO 2004/050369 PCT/AU2003/001616 247 SoPEC environments. The LSS Master system-level interface is illustrated in Figure 75. Note that multiple QA chips are allowed on each LSS bus. 19.2 QA COMMUNICATION The SoPEC data interface to the QA Chips is a low speed, 2 pin, synchronous serial bus. Data is 5 transferred to the QA chips via the /ss _data pin synchronously with the Iss_c/k pin. When the /ss_c/k is high the data on /ssdata is deemed to be valid. Only the LSS master in SoPEC can drive the Issck pin, this pin is an input only to the QA chips. The LSS block must be able to interface with an open-collector pull-up bus. This means that when the LSS block should transmit a logical zero it will drive 0 on the bus, but when it should transmit a logical 1 it will leave high 10 impedance on the bus (i.e. it doesn't drive the bus). If all the agents on the LSS bus adhere to this protocol then there will be no issues with bus contention. The LSS block controls all communication to and from the QA chips. The LSS block is the bus master in all cases. The LSS block interprets a command register set by the SoPEC CPU, initiates transactions to the QA chip in question and optionally accepts return data. Any return 15 information is presented through the configuration registers to the SoPEC CPU. The LSS block indicates to the CPU the completion of a command or the occurrence of an error via an interrupt. The LSS protocol can be used to communicate with other LSS slave devices (other than QA chips). However should a LSS slave device hold the clock low (for whatever reason), it will be in violation of the LSS protocol and is not supported. The LSS clock is only ever driven by the LSS 20 master. 19.2.1 Start and stop conditions All transmissions on the LSS bus are initiated by the LSS master issuing a START condition and terminated by the LSS master issuing a STOP condition. START and STOP conditions are always generated by the LSS master. As illustrated in Figure 76, a START condition corresponds to a 25 high to low transition on Issdata while Iss c/k is high. A STOP condition corresponds to a low to high transition on Issdata while Iss_c/k is high. 19.2.2 Data transfer Data is transferred on the LSS bus via a byte orientated protocol. Bytes are transmitted serially. Each byte is sent most significant bit (MSB) first through to least significant bit (LSB) last. One 30 clock pulse is generated for each data bit transferred. Each byte must be followed by an acknowledge bit. The data on the Issdata must be stable during the HIGH period of the Iss_c/k clock. Data may only change when /ss_c/k is low. A transmitter outputs data after the falling edge of Iss c/k and a receiver inputs the data at the rising edge of Iss_c/k. This data is only considered as a valid data 35 bit at the next /ss_ c/k falling edge provided a START or STOP is not detected in the period before the next /ss c/k falling edge. All clock pulses are generated by the LSS block. The transmitter releases the Issdata line (high) during the acknowledge clock pulse (ninth clock pulse). The receiver must pull down the /ssdata line during the acknowledge clock pulse so that it remains stable low during the HIGH period of this clock pulse.
WO 2004/050369 PCT/AU2003/001616 248 Data transfers follow the format shown in Figure 77. The first byte sent by the LSS master after a START condition is a primary id byte, where bits 7-2 form a 6-bit primary id (0 is a global id and will address all QA Chips on a particular LSS bus), bit 1 is an even parity bit for the primary id, and bit 0 forms the read/ write sense. Bit 0 is high if the following command is a read to the 5 primary id given or low for a write command to that id. An acknowledge is generated by the QA chip(s) corresponding to the given id (if such a chip exists) by driving the issdata line low synchronous with the LSS master generated ninth /ss_c/k. 19.2.3 Write procedure The protocol for a write access to a QA Chip over the LSS bus is illustrated in Figure 79 below. 10 The LSS master in SoPEC initiates the transaction by generating a START condition on the LSS bus. It then transmits the primary id byte with a 0 in bit 0 to indicate that the following command is a write to the primary id. An acknowledge is generated by the QA chip corresponding to the given primary id. The LSS master will clock out M data bytes with the slave QA Chip acknowledging each successful byte written. Once the slave QA chip has acknowledged the M data byte the 15 LSS master issues a STOP condition to complete the transfer. The QA chip gathers the M data bytes together and interprets them as a command. See QA Chip Interface Specification for more details on the format of the commands used to communicate with the QA chip[8]. Note that the QA chip is free to not acknowledge any byte transmitted. The LSS master should respond by issuing an interrupt to the CPU to indicate this error. The CPU should then generate a STOP condition on the LSS bus 20 to gracefully complete the transaction on the LSS bus. 19.2.4 Read procedure The LSS master in SoPEC initiates the transaction by generating a START condition on the LSS bus. It then transmits the primary id byte with a 1 in bit 0 to indicate that the following command is a read to the primary id. An acknowledge is generated by the QA chip corresponding to the given 25 primary id. The LSS master releases the /ss_data bus and proceeds to clock the expected number of bytes from the QA chip with the LSS master acknowledging each successful byte read. The last expected byte is not acknowledged by the LSS master. It then completes the transaction by generating a STOP condition on the LSS bus. See QA Chip Interface Specification for more details on the format of the commands used to communicate with the QA chip[8]. 30 19.3 IMPLEMENTATION A block diagram of the LSS master is given in Figure 80. It consists of a block of configuration registers that are programmed by the CPU and two identical LSS master units that generate the signalling protocols on the two LSS buses as well as interrupts to the CPU. The CPU initiates and terminates transactions on the LSS buses by writing an appropriate command to the command 35 register, writes bytes to be transmitted to a buffer and reads bytes received from a buffer, and checks the sources of interrupts by reading status registers. 19.3.1 Definitions of 10 Table 102. LSS 10 pins definitions Port name Pins I/O Description WO 2004/050369 PCT/AU2003/001616 249 Clocks and Resets Pclk 1 In System Clock prst-n 1 In System reset, synchronous active low CPU Interface cpu-rwn 1 In Common read/not-write signal from the CPU cpu adr[6:2] 5 In CPU address bus. Only 5 bits are required to decode the address space for this block cpu dataout[31:0] 32 In Shared write data bus from the CPU cpu acode[1:0] 2 In CPU access code signals. cpu acode[O] - Program (0) / Data (1) access cpu-acode[1] - User (0) / Supervisor (1) access cpu-lsssel 1 In Block select from the CPU. When cpulss sel is high both cpu adr and cpu dataout are valid Isscpurdy I Out Ready signal to the CPU. When iss cpurdy is high it indicates the last cycle of the access. For a write cycle this means cpu dataout has been registered by the LSS block and for a read cycle this means the data on Iss cpu data is valid. Isscpu_berr I Out LSS bus error signal to the CPU. Isscpudata[31:0] 32 Out Read data bus to the CPU Iss cpu debug valid 1 Out Active high. Indicates the presence of valid debug data on Iss cpu data. GPIO for LSS buses lssgpio-dout[1:0] 2 Out LSS bus data output Bit 0 - LSS bus 0 Bit I - LSS bus 1 gpioIss-din[1:0] 2 In LSS bus data input Bit 0 - LSS bus 0 Bit 1 - LSS bus 1 Issgpio e[1:0] 2 Out LSS bus data output enable, active high Bit 0 - LSS bus 0 Bit 1 - LSS bus 1 Issgpio clk[1:0] 2 Out LSS bus clock output Bit 0 - LSS bus 0 Bit 1 - LSS bus 1 ICU interface Iss_icu_irq[1:0] 2 Out LSS interrupt requests Bit 0 - interrupt associated with LSS bus 0 Bit 1 - interrupt associated with LSS bus I WO 2004/050369 PCT/AU2003/001616 250 19.3.2 Configuration registers The configuration registers in the LSS block are programmed via the CPU interface. Refer to section 11.4 on page 96 for the description of the protocol and timing diagrams for reading and writing registers in the LSS block. Note that since addresses in SoPEC are byte aligned and the 5 CPU only supports 32-bit register reads and writes, the lower 2 bits of the CPU address bus are not required to decode the address space for the LSS block. Table 103 lists the configuration registers in the LSS block. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of /ss_cpu_data. The input cpuacode signal indicates whether the current CPU access is supervisor, user, 10 program or data. The configuration registers in the LSS block can only be read or written by a supervisor data access, i.e. when cpu acode equals b1 1. If the current access is a supervisor data access then the LSS responds by asserting Isscpurdy for a single clock cycle. If the current access is anything other than a supervisor data access, then the LSS generates a bus error by asserting Iss cpu_berr for a single clock cycle instead of /ss cpu rdy as shown in 15 section 11.4 on page 96. A write access will be ignored, and a read access will return zero. Table 103. LSS Control Registers address Register #bits Reset Description (LSS base +) Control registers 0x00 Reset 1 Oxi A write to this register causes a reset of the LSS. 0x04 LssClockHighLow- 16 OxOOC8 Lss_c/k has a 50:50 duty cycle, this register Duration defines the period of Iss c/k by means of specifying the duration (in pclk cycles) that Iss_c/k is low (or high). The reset value specifies transmission over the LSS bus at a nominal rate of 400kHz, corresponding to a low (or high) duration of 200 pc/k (160Mhz) cycles. Register should not be set to values less than 8. Ox08 LssClocktoDataHo 6 Ox3 Specifies the number of pc/k cycles that Data Id must remain valid for after the falling edge of Iss ck. Minimum value is 3 cycles, and must to programmed to be less than LssClockHighLowDuration. LSS bus 0 registers WO 2004/050369 PCT/AU2003/001616 251 Oxi 0 LssOlntStatus 3 OxO LSS bus 0 interrupt status registers Bit 0 - command completed successfully Bit 1 - error during processing of command, not -acknowledge received after transmission of primary id byte on LSS bus 0 Bit 2 - error during processing of command, not -acknowledge received after transmission of data byte on LSS bus 0 All the bits in LssO/ntStatus are cleared when the LssOCmd register gets written to. (Read only register) OxI 4 Lss0CurrentState 4 OxO Gives the current state of the LSS bus 0 state machine. (Read only register). (Encoding will be specified upon state machine implementation) 0x18 Lss0Cmd 21 0x00 Command register defining sequence of 0000 events to perform on LSS bus 0 before interrupting CPU. A write to this register causes all the bits in he LssOlntStatus register to be cleared as well as generating a IssO new cmd pulse. Ox1C - Ox2C LssOBuffer[4:0] 5x32 0x0000 LSS Data buffer. Should be filled with 0000 ransmit data before transmit command, or read data bytes received after a valid read command. LSS bus 1 registers 0x30 Lssl intStatus 3 Ox0 LSS bus 1 interrupt status registers Bit 0 - command completed successfully Bit 1 - error during processing of command, not -acknowledge received after transmission of primary id byte on LSS bus I Bit 2 - error during processing of command, not -acknowledge received after transmission of data byte on LSS bus 1 AlI the bits in Lss1/ntStatus are cleared when WO 2004/050369 PCT/AU2003/001616 252 the LsslCmd register gets written to. (Read only register) 0x34 LsslCurrentState4 Oxo Gives the current state of the LSS bus 1 state machine. (Read only register) (Encoding will be specified upon state machine implementation) 0x38 Lssl Cmd 21 0x00_ Command register defining sequence of 0000 events to perform on LSS bus 1 before interrupting CPU. A write to this register causes all the bits in the LsslntStatus register to be cleared as well as generating a Iss1_newcmd pulse. Ox3C - Ox4C Lssl Buffer[4:0] 5x32 0x0000 LSS Data buffer. Should be filled with 0000 transmit data before transmit command, or read data bytes received after a valid read command. Debug registers 0x50 LssDebugSel[6:2] 5 Ox00 Selects register for debug output. This value is used as the input to the register decode logic instead of cpuadr[6:2] when the LSS block is not being accessed by the CPU, i.e. when cpuIsssel is 0. The output Iss cpu debug valid is asserted to indicate that the data on Iss cpudata is valid debug data. This data can be mutliplexed onto chip pins during debug mode. 19.3.2.1 LSS command registers The LSS command registers define a sequence of events to perform on the respective LSS bus before issuing an interrupt to the CPU. There is a separate command register and interrupt for each LSS bus. The format of the command is given in Table 104, The CPU writes to the 5 command register to initiate a sequence of events on an LSS bus. Once the sequence of events has completed or an error has occurred, an interrupt is sent back to the CPU. Some example commands are: e a single START condition (Start = 1, IdByteEnable = 0, RdWrEnable = 0, Stop = 0) e a single STOP condition (Start = 0, IdByteEnable = 0, RdWrEnable = 0, Stop = 1) 10 e a START condition followed by transmission of the id byte (Start = 1, IdByteEnable = 1, RdWrEnable = 0, Stop = 0, IdByte contains primary id byte) e a write transfer of 20 bytes from the data buffer (Start = 0, ldByteEnable = 0, RdWrEnable = 1, RdWrSense = 0, Stop = 0, TxRxByteCount = 20) WO 2004/050369 PCT/AU2003/001616 253 e a read transfer of 8 bytes into the data buffer (Start = 0, IdByteEnable = 0, RdWrEnable 1, RdWrSense = 1, ReadNack = 0, Stop = 0, TxRxByteCount = 8) e a complete read transaction of 16 bytes (Start = 1, !dByteEnable = 1, RdWrEnable = 1, RdWrSense = 1, ReadNack = 1, Stop = 1, IdByte contains primary id byte, TxRxByteCount 5 = 16), etc. The CPU can thus program the number of bytes to be transmitted or received (up to a maximum of 20) on the LSS bus before it gets interrupted. This allows it to insert arbitrary delays in a transfer at a byte boundary. For example the CPU may want to transmit 30 bytes to a QA chip but insert a delay between the 20 th and 21 st bytes sent. It does this by first writing 20 bytes to the data 10 buffer. It then writes a command to generate a START condition, send the primary id byte and then transmit the 20 bytes from the data buffer. When interrupted by the LSS block to indicate successful completion of the command the CPU can then write the remaining 10 bytes to the data buffer. It can then wait for a defined period of time before writing a command to transmit the 10 bytes from the data buffer and generate a STOP condition to terminate the transaction over the 15 LSS bus. An interrupt to the CPU is generated for one cycle when any bit in LssN/ntStatus is set. The CPU can read LssN/ntStatus to discover the source of the interrupt. The LssNIntStatus registers are cleared when the CPU writes to the LssNCmd register. A null command write to the LssNCmd register will cause the LssN/ntStatus registers to clear and no new command to start. A null 20 command is defined as Start, IdbyteEnable, RdWrEnable and Stop all set to zero. Table 104. LSS command register description bit(s) name Description 0 Start When 1, issue a START condition on the LSS bus. 1 IdByteEnable ID byte transmit enable: 1 - transmit byte in IdByte field 0 - ignore byte in IdByte field 2 RdWrEnable Read/write transfer enable: 0 - ignore settings of RdWrSense, ReadNack and TxRxByteCount I - if RdWrSense is 0, then perform a write transfer of TxRxByteCount bytes from the data buffer. if RdWrSense is 1, then perform a read transfer of TxRxByteCount bytes into the data buffer. Each byte should be acknowledged and the last byte received is acknowledged/not-acknowledged according to the setting of ReadNack.
WO 2004/050369 PCT/AU2003/001616 254 3 RdWrSense Read/write sense indicator: 0 - write 1 - read 4 ReadNack Indicates, for a read transfer, whether to issue an acknowledge or a not-acknowledge after the last byte received (indicated by TxRxByteCount). 0 - issue acknowledge after last byte received 1 - issue not-acknowledge after last byte received. 5 Stop When 1, issue a STOP condition on the LSS bus. 7:6 reserved Must be 0 15:8 IdByte Byte to be transmitted if IdByteEnable is 1. Bit 8 corresponds to the LSB. 20:16 TxRxByteCount Number of bytes to be transmitted from the data buffer or the number of bytes to be received into the data buffer. The maximum value that should be programmed is 20, as the size of the data buffer is 20 bytes. Valid values are I to 20, 0 is valid when RdWrEnable = 0, other cases are invalid andundefined. The data buffer is implemented in the LSS master block. When the CPU writes to the LssNBuffer registers the data written is presented to the LSS master block via the /ssNbufferwrdata bus and configuration registers block pulses the IssNbufferwen bit corresponding to the register 5 written. For example if LssNBuffer[2] is written to IssNbufferwen[2] will be pulsed. When the CPU reads the LssNBuffer registers the configuration registers block reflect the /ssN buffer rdata bus back to the CPU. 19.3.3 LSS master unit The LSS master unit is instantiated for both LSS bus 0 and LSS bus 1. It controls transactions on 10 the LSS bus by means of the state machine shown in Figure 83, which interprets the commands that are written by the CPU. It also contains a single 20 byte data buffer used for transmitting and receiving data. The CPU can write data to be transmitted on the LSS bus by writing to the LssNBuffer registers. It can also read data that the LSS master unit receives on the LSS bus by reading the same 15 registers. The LSS master always transmits or receives bytes to or from the data buffer in the same order. For a transmit command, LssNBuffer[0l7:0] gets transmitted first, then LssNBuffer[0][15:8], LssNBuffer[0][23:16], LssNBuffer[0][31:24], LssNBuffer[1][7:0] and so on until TxRxByteCount number of bytes are transmitted. A receive command fills data to the buffer in the same order. 20 Each new command the buffer start point is reset. All state machine outputs, flags and counters are cleared on reset. After a reset the state machine goes to the Reset state and initialises the LSS pins (Iss_c/k is set to 1, Issdata is tristated and WO 2004/050369 PCT/AU2003/001616 255 allowed to be pulled up to 1). When the reset condition is removed the state machine transitions to the Wait state. It remains in the Wait state until Issnewcmd equals 1. If the Start bit of the command is 0 the state machine proceeds directly to the Check/dByteEnable state. If the Start bit is 1 it proceeds to 5 the GenerateStart state and issues a START condition on the LSS bus. In the CheckldByteEnable state, if the IdByteEnable bit of the command is 0 the state machine proceeds directly to the CheckRdWrEnable state. If the IdByteEnable bit is 1 the state machine enters the Send/dByte state and the byte in the IdByte field of the command is transmitted on the LSS. The WaitForldAck state is then entered. If the byte is acknowledged, the state machine 10 proceeds to the CheckRdWrEnable state. If the byte is not-acknowledged, the state machine proceeds to the GenerateInterrupt state and issues an interrupt to indicate a not-acknowledge was received after transmission of the primary id byte. In the CheckRdWrEnable state, if the RdWrEnable bit of the command is 0 the state machine proceeds directly to the CheckStop state. If the RdWrEnable bit is 1, count is loaded with the 15 value of the TxRxByteCount field of the command and the state machine enters either the ReceiveByte state if the RdWrSense bit of the command is 1 or the TransmitByte state if the RdWrSense bit is 0. For a write transaction, the state machine keeps transmitting bytes from the data buffer, decrementing count after each byte transmitted, until count is 1. If all the bytes are successfully 20 transmitted the state machine proceeds to the CheckStop state. If the slave QA chip not acknowledges a transmitted byte, the state machine indicates this error by issuing an interrupt to the CPU and then entering the GenerateInterrupt state. For a read transaction, the state machine keeps receiving bytes into the data buffer, decrementing count after each byte transmitted, until count is 1. After each byte received the LSS master must 25 issue an acknowledge. After the last expected byte (i.e. when count is 1) the state machine checks the ReadNack bit of the command to see whether it must issue an acknowledge or not acknowledge for that byte. The CheckStop state is then entered. In the CheckStop state, if the Stop bit of the command is 0 the state machine proceeds directly to the Generate/nterrupt state. If the Stop bit is 1 it proceeds to the GenerateStop state and issues a 30 STOP condition on the LSS bus before proceeding to the Generate/nterrupt state. In both cases an interrupt is issued to indicate successful completion of the command. The state machine then enters the Wait state to await the next command. When the state machine reenters the Wait state the output pins (Iss data and Iss_c/k) are not changed, they retain the state of the last command. This allows the possibility of multi-command transactions. 35 The CPU may abort the current transfer at any time by performing a write to the Reset register of the LSS block. 19.3.3.1 START and STOP generation START and STOP conditions, which signal the beginning and end of data transmission, occur when the LSS master generates a falling and rising edge respectively on the data while the clock 40 is high.
WO 2004/050369 PCT/AU2003/001616 256 In the GenerateStart state, iss gpio c/k is held high with Iss gpio_.e remaining deasserted (so the data line is pulled high externally) for LssClockHighLowDuration pc/k cycles. Then /ss gpio e is asserted and Iss_gpio dout is pulled low (to drive a 0 on the data line, creating a falling edge) with Iss gpio_c/k remaining high for another LssClockHighLowDuration pc/k cycles. 5 In the GenerateStop state, both Iss gpio c/k and issgpio dout are pulled low followed by the assertion of Iss gpio_e to drive a 0 while the clock is low. After LssClockHighLowDuration pc/k cycles, Iss gpio-c/k is set high. After a further LssClockHighLowDuration pc/k cycles, Iss gpio e is deasserted to release the data bus and create a rising edge on the data bus during the high period of the clock. 10 If the bus is not in the required state for start and stop generation (Issclk=1, /ss_data=1 for start, and /ss_c/k=1, lss-data=0), the state machine moves the bus to the correct state and proceeds as described above. Figure 82 shows the transition timing from any bus state to start and stop generation 19.3.3.2 Clock pulse generation 15 The LSS master holds /ss gpio c/k high while the LSS bus is inactive. A clock pulse is generated for each bit transmitted or received over the LSS bus. It is generated by first holding iss gpio c/k low for LssClockHighLowDuration pc/k cycles, and then high for LssClockHighLowDuration pclk cycles. 19.3.3.3 Data De-glitching 20 When data is received in the LSS block it is passed to a de-glitching circuit. The de-glitch circuit samples the data 3 times on pclk and compares the samples. If all 3 samples are the same then the data is passed, otherwise the data is ignored. Note that the LSS data input on SoPEC is double registered in the GPIO block before being passed to the LSS. 25 19.3.3.4 Data reception The input data, gpio_Iss di, is first synchronised to the pc/k domain by means of two flip-flops clocked by pc/k (the double register resides in the GPIO block) . The LSS master generates a clock pulse for each bit received. The output /ss gpiode is deasserted LssC/ockToDataHold pc/k cycles after the falling edge of Iss gpio c/k to release the data bus. The value on the 30 synchronised gpio /ssdi is sampled Tstrobe number of clock cycles after the rising edge of /ss-gpio c/k (the data is de-glitched over a further 3 stage register to avoid possible glitch detection). See Figure 84 for further timing information. In the ReceiveByte state, the state machine generates 8 clock pulses. At each Tstrobe time after the rising edge of /ssgpio c/k the synchronised gpio issdi is sampled. The first bit sampled is 35 LssNBuffer[][7, the second LssNBuffer[0][6], etc to LssNBuffer[][J. For each byte received the state machine either sends an NAK or an ACK depending on the command configuration and the number of bytes received. In the SendNack state the state machine generates a single clock pulse. Iss gpio e is deasserted and the LSS data line is pulled high externally to issue a not-acknowledge.
WO 2004/050369 PCT/AU2003/001616 257 In the SendAck state the state machine generates a single clock pulse. Iss gpio e is asserted and a 0 driven on /ss gpio dout after /ssgpio c/k falling edge to issue an acknowledge. 19.3.3.5 Data transmission The LSS master generates a clock pulse for each bit transmitted. Data is output on the LSS bus 5 on the falling edge of Iss gpio_ck. When the LSS master drives a logical zero on the bus it will assert Iss gpioe and drive a 0 on /ssgpiodout after Iss gpioc/k failing edge. Iss gpio_e will remain asserted and /ss gpiodout will remain low until the next Iss c/k falling edge. When the LSS master drives a logical one Iss gpio e should be deasserted at /ss gpiodclk falling 10 edge and remain deasserted at least until the next Issgpio c/k falling edge. This is because the LSS bus will be externally pulled up to logical one via a pull-up resistor. In the Send/d byte state, the state machine generates 8 clock pulses to transmit the byte in the IdByte field of the current valid command. On each falling edge of Iss gpio c/k a bit is driven on the data bus as outlined above. On the first falling edge IdByte[7] is driven on the data bus, on the 15 second falling edge /dByte[6] is driven out, etc. In the TransmitByte state, the state machine generates 8 clock pulses to transmit the byte at the output of the transmit FIFO. On each falling edge of Issgpio c/k a bit is driven on the data bus as outlined above. On the first falling edge LssNBuffer[0][7] is driven on the data bus, on the second falling edge LssNBuffer[0][6] is driven out, etc on to LssNBuffer[0][7] bits. 20 In the WaitForAck state, the state machine generates a single clock pulse. At Tstrobe time after the rising edge of Iss gpio c/k the synchronized gpio Issdi is sampled. A 0 indicates an acknowledge and ackdetect is pulsed, a 1 indicates a not-acknowledge and nackdetect is pulsed. 19.3.3.6 Data rate control 25 The CPU can control the data rate by setting the clock period of the LSS bus clock by programming appropriate value in LssClockHighLowDuraton. The default setting for the register is 200 (pc/k cycles) which corresponds to transmission rate of 400kHz on the LSS bus (the Iss_c/k is high for LssClockHighLowDuration cycles then low for LssClockHighLowDuration cycles). The /ss_c/k will always have a 50:50 duty cycle. The LssClockHighLowDuration register should not be 30 set to values less than 8. The hold time of /ssdata after the falling edge of Iss c/k is programmable by the LssClocktoDataHo/d register. This register should not be programmed to less than 2 or greater than the LssClockHighLowDuration value. 19.3.3.7 LSS master timing parameters 35 The LSS master timing parameters are shown in Figure 84 and the associated values are shown in Table 105. Table 105. LSS master timing parameters Parameter Description min nom max unit LSS Master Driving WO 2004/050369 PCT/AU2003/001616 258 Tp LSS clock period divided by 2 8 200 FFFF pclk cycles Start delay Time to start data edge from rising Tp +pclk cycles clock edge LssClocktoDataHold Tstopdelay Time to stop data edge from rising Tp +pclk cycles clock edge LssClocktoDataHold Data setup Time from data setup to rising clock Tp - 2 -pclk cycles edge LssClocktoDataHold Tdatahold Time from falling clock edge to data LssClocktoDataHold pclk cycles hold Tack-setup Time that outgoing (N)Ack is setup Tp - 2 -pclk cycles before fss clk rising edge LssClocktoDataHold Tackhold Time that outgoing (N)Ack is held LssClocktoDataHold pclk cycles after Iss c/k falling edge LSS Master Sampling Tstrobe LSS master strobe point for Tp -2 Tp -2 pclk cycles incoming data and (N)Ack values DRAM SUBSYSTEM 20 DRAM Interface Unit (DIU) 20.1 OVERVIEW 5 Figure 85 shows how the DIU provides the interface between the on-chip 20 Mbit embedded DRAM and the rest of SoPEC. In addition to outlining the functionality of the DIU, this chapter provides a top-level overview of the memory storage and access patterns of SoPEC and the buffering required in the various SoPEC blocks to support those access requirements. The main functionality of the DIU is to arbitrate between requests for access to the embedded 10 DRAM and provide read or write accesses to the requesters. The DIU must also implement the initialisation sequence and refresh logic for the embedded DRAM. The arbitration scheme uses a fully programmable timeslot mechanism for non-CPU requesters to meet the bandwidth and latency requirements for each unit, with unused slots re-allocated to provide best effort accesses. The CPU is allowed high priority access, giving it minimum latency, 15 but allowing bounds to be placed on its bandwidth consumption. The interface between the DIU and the SoPEC requesters is similar to the interface on PEC1 i.e. separate control, read data and write data busses. The embedded DRAM is used principally to store: a CPU program code and data. 20 e PEP (re)programming commands. * Compressed pages containing contone, bi-level and raw tag data and header information. * Decompressed contone and bi-level data. * Dotline store during a print.
WO 2004/050369 PCT/AU2003/001616 259 Print setup information such as tag format structures, dither matrices and dead nozzle information. 20.2 IBM Cu-11 EMBEDDED DRAM 20.2.1 Single bank 5 SoPEC will use the 1.5 V core voltage option in IBM's 0.13 pm class Cu-11 process. The random read/write cycle time and the refresh cycle time is 3 cycles at 160 MHz [16]. An open page access will complete in 1 cycle if the page mode select signal is clocked at 320 MHz or 2 cycles if the page mode select signal is clocked every 160 MHz cycle. The page mode select signal will be clocked at 160 MHz in SoPEC in order to simplify timing closure. The DRAM word 10 size is 256 bits. Most SoPEC requesters will make single 256 bit DRAM accesses (see Section 20.4). These accesses will take 3 cycles as they are random accesses i.e. they will most likely be to a different memory row than the previous access. The entire 20 Mbit DRAM will be implemented as a single memory bank. In Cu-11, the maximum 15 single instance size is 16 Mbit. The first I Mbit tile of each instance contains an area overhead so the cheapest solution in terms of area is to have only 2 instances. 16 Mbit and 4Mbit instances would together consume an area of 14.63 mm 2 as would 2 times 10 Mbit instances. 4 times 5 Mbit instances would require 17.2 mm 2 . The instance size will determine the frequency of refresh. Each refresh requires 3 clock cycles. In 20 Cu-11 each row consists of 8 columns of 256-bit words. This means that 10 Mbit requires 5120 rows. A complete DRAM refresh is required every 3.2 ms. Two times 10 Mbit instances would require a refresh every 100 clock cycles, if the instances are refreshed in parallel. The SoPEC DRAM will be constructed as two 10 Mbit instances implemented as a single memory bank. 25 20.3 SoPEC MEMORY USAGE REQUIREMENTS The memory usage requirements for the embedded DRAM are shown in Table 106. Table 106. Memory Usage Requirements Block Size Description Compressed page2048 Kbytes Compressed data page store for Bi store level and contone data Decompressed 108 Kbyte 13824 lines with scale factor 6 2304 Contone Store pixels, store 12 lines, 4 colors = 108 kB 13824 lines with scale factor 5 = 2765 pixels, store 12 lines, 4 colors = 130 kB Spot line store 5.1 Kbyte 13824 dots/line so 3 lines is 5.1 kB WO 2004/050369 PCT/AU2003/001616 260 Tag Format Structure Typically 12 Kbyte (2.5 mm 55 kB in for 384 dot line tags tags @ 800 dpi) 2.5 mm tags (1/10th inch) @ 1600 dpi require 160 dot lines = 160/384 x55 or 23 kB 2.5 mm tags (1/10th inch) @ 800 dpi require 80/384 x55 = 12 kB Dither Matrix store 4 Kbytes 64x64 dither matrix is 4 kB 128x128 dither matrix is 16 kB 256x256 dither matrix is 64 kB DNC Dead Nozzle 1.4 Kbytes Delta encoded, (10 bit delta position + Table 6 dead nozzle mask) x% Dnozzle 5% dead nozzles requires (1 0+6)x 692 Dnoz zles = 1.4 Kbytes Dot-line store 369.6 Kbytes Assume each color row is separated by 5 dot lines on the print head The dot line store will be 0+5+10.. .50+55 = 330 half dot lines + 48 extra half dot lines (4 per dot row) + 60 extra half dot lines estimated to account for printhead misalignment = 438 half dot lines. 438 half dot lines of 6912 dots = 369.6Kbytes PCU Program code 8 Kbytes 1024 commands of 64 bits = 8 kB CPU 64 Kbytes Program code and data TOTAL 2620 Kbytes (12 Kbyte TFS storage) Note: e Total storage is fixed to 2560 Kbytes to align to 20 Mbit DRAM. This will mean that less space than noted in Table may be available for the compressed band store. 5 20.4 SoPEC MEMORY AcCESS PATTERNS Table 107 shows a summary of the blocks on SoPEC requiring access to the embedded DRAM and their individual memory access patterns. Most blocks will access the DRAM in single 256-bit accesses. All accesses must be padded to 256-bits except for 64-bit CDU write accesses and CPU write accesses. Bits which should not be written are masked using the individual DRAM bit 10 write inputs or byte write inputs, depending on the foundry. Using single 256-bit accesses means that the buffering required in the SoPEC DRAM requesters will be minimized. Table 107. Memory access patterns of SoPEC DRAM Requesters WO 2004/050369 PCT/AU2003/001616 261 DRAM requester Direction Memory access pattern CPU R Single 256-bit reads. W Single 32-bit, 16-bit or 8-bit writes. SCB R Single 256-bit reads. W Single 256-bit writes, with byte enables. CDU R Single 256-bit reads of the compressed contone data. W Each CDU access is a write to 4 consecutive DRAM words in the same row but only 64 bits of each word are written with the remaining bits write masked. The access time for this 4 word page mode burst is 3 + 2 + 2 +2 = 9 cycles if the page mode select signal is clocked at 160 MHz. CFU R Single 256 bit reads. LBD R Single 256 bit reads. SFU R Separate single 256 bit reads for previous and current line but sharing the same DIU interface W Single 256 bit writes. TE(TD) R Single 256 bit reads. Each read returns 2 times 128 bit tags. TE(TFS) R Single 256 bit reads. TFS is 136 bytes. This means there is unused data in the fifth 256 bit read. A total of 5 reads is required. HCU R Single 256 bit reads. 128 x 128 dither matrix requires 4 reads per line with double buffering. 256 x 256 dither matrix requires 8 reads at the end of the line with single buffering. DNC R Single 256 bit dead nozzle table reads. Each dead nozzle table read con tains 16 dead-nozzle tables entries each of 10 delta bits plus 6 dead nozzle mask bits. DWU W Single 256 bit writes since enable/disable DRAM access per color plane. LLU R Single 256 bit reads since enable/disable DRAM access per color plane. PCU R Single 256 bit reads. Each PCU command is 64 bits so each 256 bit word can contain 4 PCU commands. PCU reads from DRAM used for reprogramming PEP should be executed with minimum latency. If this occurs between pages then there will be free bandwidth as most of the other SoPEC Units will not be requesting from DRAM. If this occurs between bands then the LDB, CDU and TE bandwidth will be free. So the PCU should have a high priority to access to any spare bandwidth.
WO 2004/050369 PCT/AU2003/001616 262 Refresh Single refresh. 20.5 BUFFERING REQUIRED IN SOPEC DRAM REQUESTERS If each DIU access is a single 256-bit access then we need to provide a 256-bit double buffer in the DRAM requester. If the DRAM requester has a 64-bit interface then this can be implemented as an 8 x 64-bit FIFO. 5 Table 108. Buffer sizes in SoPEC DRAM requesters DRAM Requester Direction Access patterns Buffering required in block CPU R Single 256-bit reads. Cache. W Single 32-bit writes but allowing 16-bit or None. byte addressable writes. SCB R Single 256-bit reads. Double 256-bit buffer. W Single 256-bit writes, with byte enables. Double 256-bit buffer. CDU R Single 256-bit reads of the compressed Double 256-bit buffer. contone data. W Each CDU access is a write to 4 Double half JPEG block consecutive DRAM words in the same buffer. row but only 64 bits of each word are written with the remaining bits write masked. CFU R Single 256 bit reads. Triple 256-bit buffer. LBD R Single 256 bit reads. Double 256-bit buffer. SFU R Separate single 256 bit reads for Double 256-bit buffer for previous and cur rent line but sharing each read channel. the same DIU interface W Single 256 bit writes. Double 256-bit buffer. TE(TD) R Single 256 bit reads. Double 256-bit buffer. TE(TFS) R Single 256 bit reads. TFS is 136 bytes. Double line-buffer for This means there is unused data in the 136 bytes implemented fifth 256 bit read. A total of 5 reads is in TE. required. HCU R Single 256 bit reads. 128 x 128 dither Configurable between matrix requires 4 reads per line with dou ble 128 byte buffer double buffering. 256 x 256 dither matrix and requires 8 reads at the end of the line single 256 byte buffer. with single buffering. DNC R Single 256 bit reads Double 256-bit buffer. Deeper buffering could WO 2004/050369 PCT/AU2003/001616 263 be specified to cope with local clusters of dead nozzles. DWU W Single 256 bit writes per enabled Double 256-bit buffer per odd/even color plane. color plane. LLU R Single 256 bit reads per enabled Double 256-bit buffer per odd/even color plane. color plane. PCU R Single 256 bit reads. Each PCU Single 256-bit buffer. command is 64 bits so each 256 bit DRAM read can contain 4 PCU com mands. Requested command is read from DRAM together with the next 3 contiguous 64-bits which are cached to avoid unnecessary DRAM reads. Refresh Single refresh. None. 20.6 SoPEC DIU BANDWIDTH REQUIREMENTS Table 109. SoPEC DIU Bandwidth Requirements Block Name Direction Number of Peak Average Example number of cycles between Bandwidth Bandwidth allocated each which must be (bits/cycle) timeslots 256-bit DRAM supplied access to meet (bits/cycle) peak bandwidth CPU R W SCB R W 3482 0.734 0.3933 1 CDU R 128 (SF = 4), 28864/n2 (SF=n), 32/10*n2 (SF=n), 1 (SF=6) (SF = 6), 1:11.8 (SF = 6), 0.09 (SF = 6), 2 (SF=4) compression4 4 (SF = 4) 0.2 (SF = 4) (1:1 (10:1 compression) compression)5 W For individual 64/n2 (SF=n), 32/n2 (SF=n)7, 2 (SF=6)8 accesses: 16 1.8 (SF = 6), 0.9 (SF = 6), 4(SF=4) cycles (SF = 4), 36 4 (SF = 4) 2 (SF = 4) cycles (SF = 6), n2 cycles (SF=n). Will be WO 2004/050369 PCT/AU2003/001616 264 implemented as a page mode burst of 4 accesses every 64 cycles (SF = 4), 144 (SF =6), 4*n2 (SF =n) cycles6 CFU R 32 (SF = 4), 48 (SF32/n (SF=n), 32/n (SF=n), 6 (SF=6) = 6)9 5.4 (SF = 6), 5.4 (SF = 6), 8 (SF=4) 8(SF=4) 8(SF=4) LBD R 256 (1:11 (1:10.1 (10:11 compression)10 compression) compression)1I SFU R 12812 2 2 2 W 25613 1 1 1 TE(TD) R 25214 1.02 1.02 1 TE(TFS) R 5 reads per line15 0.093 0.093 0 HCU R 4 reads per line for0.074 0.074 0 128 x 128 dither matrix16 DNC R 106 (5% dead-2.4 (clump o00.8 (equally3 nozzles 10-bit deltadead nozzles) spaced dead encoded)1 7 nozzles) DWU W 6 writes every 6 6 6 25618 LLU R 8 reads every8 6 8 25619 PCU R 25620 1 1 1 Refresh 10021 2.56 2.56 3(effective) TOTAL SF = 6: 34.9 SF = 6: 27.5 SF = 6: 36 SF = 4: 41.9 SF = 4: 31.2 excluding CPU. excluding CPU excluding CPU SF= 4: 41 excluding CPU Notes: 1: The number of allocated timeslots is based on 64 timeslots each of 1 bit/cycle but broken down to a granularity of 0.25 bit/cycle. Bandwidth is allocated based on peak bandwidth. 2: Wire-speed bandwidth for a 4 wire SCB configuration is 32 Mbits/s for each wire plus 12 Mbit/s 5 for USB. This is a maximum of 138 Mbit/s. The maximum effective data rate is 26 Mbits/s for each wire plus 8 Mbit/s for USB. This is 112 Mbit/s. 112 Mbit/s is 0.734 bits/cycle or 256 bits every 348 cycles.
WO 2004/050369 PCT/AU2003/001616 265 3: Wire-speed bandwidth for a 2 wire SCB configuration is 32 Mbits/s for each wire plus 12 Mbit/s for USB. This is a maximum of 74 Mbit/s. The maximum effective data rate is 26 Mbits/s for each wire plus 8 Mbit/s for USB. This is 60 Mbit/s. 60 Mbit/s is 0.393 bits/cycle or 256 bits every 650 cycles. 5 4: At 1:1 compression CDU must read a 4 color pixel (32 bits) every SF 2 cycles. 5: At 10:1 average compression CDU must read a 4 color pixel (32 bits) every 10 *SF 2 cycles. 6: 4 color pixel (32 bits) is required, on average, by the CFU every SF (scale factor) cycles. The time available to write the data is a function of the size of the buffer in DRAM. 1.5 buffering means 4 color pixel (32 bits) must be written every SF2 / 2 (scale factor) cycles. Therefore, at a 10 scale factor of SF, 64 bits are required every SF 2 cycles. Since 64 valid bits are written per 256-bit write (Figure n page379 on page Error! Bookmark not defined.) then the DRAM is accessed every SF 2 cycles i.e. at SF4 an access every 16 cycles, at SF6 an access every 36 cycles. If a page mode burst of 4 accesses is used then each access takes (3 + 2 + 2 +2) equals 9 15 cycles. This means at SF, a set of 4 back-to-back accesses must occur every 4*SF 2 cycles. This assumes the page mode select signal is clocked at 160 MHz. CDU timeslots therefore take 9 cycles. For scale factors lower than 4 double buffering will be used. 7: The peak bandwidth is twice the average bandwidth in the case of 1.5 buffering. 20 8: Each CDU(W) burst takes 9 cycles instead of 4 cycles for other accesses so CDU timeslots are longer. 9: 4 color pixel (32 bits) read by CFU every SF cycles. At SF4, 32 bits is required every 4 cycles or 256 bits every 32 cycles. At SF6, 32bits every 6 cycles or 256 bits every 48 cycles. 10: At 1:1 compression require 1 bit/cycle or 256 bits every 256 cycles. 25 11: The average bandwidth required at 10:1 compression is 0.1 bits/cycle. 12: Two separate reads of 1 bit/cycle. 13: Write at 1 bit/cycle. 14: Each tag can be consumed in at most 126 dot cycles and requires 128 bits. This is a maximum rate of 256 bits every 252 cycles. 30 15: 17 x 64 bit reads per line in PEC1 is 5 x 256 bit reads per line in SoPEC. Double-line buffered storage. 16: 128 bytes read per line is 4 x 256 bit reads per line. Double-line buffered storage. 17: 5% dead nozzles 10-bit delta encoded stored with 6-bit dead nozzle mask requires 0.8 bits/cycle read access or a 256-bit access every 320 cycles. This assumes the dead nozzles are 35 evenly spaced out. In practice dead nozzles are likely to be clumped. Peak bandwidth is estimated as 3 times average bandwidth. 18: 6 bits/cycle requires 6 x 256 bit writes every 256 cycles. 19: 6 bits/1 60 MHz SoPEC cycle average but will peak at 2 x 6 bits per 106 MHz print head cycle or 8 bits/ SoPEC cycle. The PHI can equalise the DRAM access rate over the line so that the WO 2004/050369 PCT/AU2003/001616 266 peak rate equals the average rate of 6 bits/ cycle. The print head is clocked at an effective speed of 106 MHz. 20: Assume one 256 read per 256 cycles is sufficient i.e. maximum latency of 256 cycles per access is allowable. 5 21: Refresh must occur every 3.2 ms. Refresh occurs row at a time over 5120 rows of 2 parallel 10 Mbit instances. Refresh must occur every 100 cycles. Each refresh takes 3 cycles. 20.7 DIU BUS TOPOLOGY 20.7.1 Basic topology 10 Table 110. SoPEC DIU Requesters Read Write Other CPU CPU Refresh SCB SCB CDU CDU CFU SFU LBD DWU SFU TE(TD) TE(TFS) HCU DNC LLU PCU Table 110 shows the DIU requesters in SoPEC. There are 12 read requesters and 5 write requesters in SoPEC as compared with 8 read requesters and 4 write requesters in PEC1. Refresh is an additional requester. 15 In PEC1, the interface between the DIU and the DIU requesters had the following main features: * separate control and address signals per DIU requester multiplexed in the DIU according to the arbitration scheme, * separate 64-bit write data bus for each DRAM write requester multiplexed in the DIU, e common 64-bit read bus from the DIU with separate enables to each DIU read requester. 20 Timing closure for this bussing scheme was straight-forward in PEC1. This suggests that a similar scheme will also achieve timing closure in SoPEC. SoPEC has 5 more DRAM requesters but it will be in a 0.13 um process with more metal layers and SoPEC will run at approximately the same speed as PEC1. Using 256-bit busses would match the data width of the embedded DRAM but such large busses 25 may result in an increase in size of the DIU and the entire SoPEC chip. The SoPEC requestors would require double 256-bit wide buffers to match the 256-bit busses. These buffers, which must WO 2004/050369 PCT/AU2003/001616 267 be implemented in flip-flops, are less area efficient than 8-deep 64-bit wide register arrays which can be used with 64-bit busses. SoPEC will therefore use 64-bit data busses. Use of 256-bit busses would however simplify the DIU implementation as local buffering of 256-bit DRAM data would not be required within the DIU. 5 20.7.1.1 CPU DRAM access The CPU is the only DIU requestor for which access latency is critical. All DIU write requesters transfer write data to the DIU using separate point-to-point busses. The CPU will use the cpudataout[31:0] bus. CPU reads will not be over the shared 64-bit read bus. Instead, CPU reads will use a separate 256-bit read bus. 10 20.7.2 Making more efficient use of DRAM bandwidth The embedded DRAM is 256-bits wide. The 4 cycles it takes to transfer the 256-bits over the 64 bit data busses of SoPEC means that effectively each access will be at least 4 cycles long. It takes only 3 cycles to actually do a 256-bit random DRAM access in the case of IBM DRAM. 20.7.2.1 Common read bus 15 If we have a common read data bus, as in PEC1, then if we are doing back to back read accesses the next DRAM read cannot start until the read data bus is free. So each DRAM read access can occur only every 4 cycles. This is shown in Figure 86 with the actual DRAM access taking 3 cycles leaving 1 unused cycle per access. 20.7.2.2 Interleaving CPU and non-CPU read accesses 20 The CPU has a separate 256-bit read bus. All other read accesses are 256-bit accesses are over a shared 64-bit read bus. Interleaving CPU and non-CPU read accesses means the effective duration of an interleaved access timeslot is the DRAM access time (3 cycles) rather than 4 cycles. Figure 87 shows interleaved CPU and non-CPU read accesses. 25 20.7.2.3 Interleaving read and write accesses Having separate write data busses means write accesses can be interleaved with each other and with read accesses. So now the effective duration of an interleaved access timeslot is the DRAM access time (3 cycles) rather than 4 cycles. Interleaving is achieved by ordering the DIU arbitration slot allocation appropriately. 30 Figure 88 shows interleaved read and write accesses. Figure 89 shows interleaved write accesses. 256-bit write data takes 4 cycles to transmit over 64-bit busses so a 256-bit buffer is required in the DIU to gather the write data from the write requester. The exception is CPU write data which 35 is transferred in a single cycle. Figure 89 shows multiple write accesses being interleaved to obtain 3 cycle DRAM access. Since two write accesses can overlap two sets of 256-bit write buffers and multiplexors to connect two write requestors simultaneously to the DIU are required. Write requestors only require approximately one third of the total non-CPU bandwidth. This 40 means that a rule can be introduced such that non-CPU write requestors are not allocated WO 2004/050369 PCT/AU2003/001616 268 adjacent timeslots. This means that a single 256-bit write buffer and multiplexor to connect the one write requestor at a time to the DIU is all that is required. Note that if the rule prohibiting back-to-back non-CPU writes is not adhered to, then the second write slot of any attempted such pair will be disregarded and re-allocated under the unused read 5 round-robin scheme. 20.7.3 Bus widths summary Table 111. SoPEC DIU Requesters Data Bus Width Read Bus access width rite Bus access width CPU 256 (separate) CPU 32 SCB 64 (shared) SCB 64 CDU 64 (shared) CDU 64 CFU 64 (shared) SFU 64 LBD 64 (shared) DWU 64 SFU 64 (shared) TE(TD) 64 (shared) TE(TFS) 64 (shared) HCU 64 (shared) DNC 64 (shared) LLU 64 (shared) PCU 64 (shared) 10 20.7.4 Conclusions Timeslots should be programmed to maximise interleaving of shared read bus accesses with other accesses for 3 cycle DRAM access. The interleaving is achieved by ordering the DIU arbitration slot allocation appropriately. CPU arbitration has been designed to maximise interweaving with non-CPU requesters 15 20.8 SoPEC DRAM ADDRESSING SCHEME The embedded DRAM is composed of 256-bit words. However the CPU-subsystem may need to write individual bytes of DRAM. Therefore it was decided to make the DIU byte addressable. 22 bits are required to byte address 20 Mbit of DRAM. Most blocks read or write 256 bit words of DRAM. Therefore only the top 17 bits i.e. bits 21 to 5 20 are required to address 256-bit word aligned locations. The exceptions are e CDU which can write 64-bits so only the top 19 address bits i.e. bits 21-3 are required. * CPU writes can be 8, 16 or 32-bits. The cpudiu_wmask[1:0J pins indicate whether to write 8, 16 or 32 bits. 25 All DIU accesses must be within the same 256-bit aligned DRAM word. The exception is the CDU write access which is a write of 64-bits to each of 4 contiguous 256-bit DRAM words.
WO 2004/050369 PCT/AU2003/001616 269 20.8.1 Write Address Constaints Specific to the CDU Note the following conditions which apply to the CDU write address, due to the four masked page mode writes which occur whenever a CDU write slot is arbitrated. * The CDU address presented to the DIU is cdu_diuwadr[21:3]. 5 * Bits [4:3] indicate which 64-bit segment out of 256 bits should be written in 4 successive masked page-mode writes. " Each 10-Mbit DRAM macro has an input address port of width [15:0]. Of these bits, [2:0] are the "page address". Page-mode writes, where you just vary these LSBs (i.e. the "page" or column address), but keep the rest of the address constant, are faster than random 10 writes. This is taken advantage of for CDU writes. " To guarantee against trying to span a page boundary, the DIU treats "cdu_diu_wadr[6:5]" as being fixed at "00". * From cdudiu wadr[21:3], a initial address of cdudiuwadr[21:7] , concatenated with "00", is used as the starting location for the first CDU write. This address is then auto 15 incremented a further three times. 20.9 DIU PROTOCOLS The DIU protocols are e Pipelined i.e. the following transaction is initiated while the previous transfer is in progress. * Split transaction i.e. the transaction is split into independent address and data transfers. 20 20.9.1 Read Protocol except CPU The SoPEC read requestors, except for the CPU, perform single 256-bit read accesses with the read data being transferred from the DIU in 4 consecutive cycles over a shared 64-bit read bus, diu_data[63:0]. The read address <unit>_diuradr[21:5 is 256-bit aligned. The read protocol is: 25 e <unit>_diu_rreq is asserted along with a valid <unit>_diu_radr[21:5]. e The DIU acknowledges the request with diu_<unit>_rack. The request should be deasserted. The minimum number of cycles between <unit> diu rreq being asserted and the DIU generating an diu_<unit>_rack strobe is 2 cycles (1 cycle to register the request, 1 cycle to perform the arbitration - see Section 20.14.10). 30 * The read data is returned on diudata[63:0] and its validity is indicated by diu_<unit>_rvalid. The overall 256 bits of data are transferred over four cycles in the order: [63:0] -> [127:64] -> [191:128] -> [255:192]. * When four diu_<unit> rvalid pulses have been received then if there is a further request <unit>_diurreq should be asserted again. diu_<unit>_rvalid will be always be asserted by 35 the DIU for four consecutive cycles. There is a fixed gap of 2 cycles between diu_<unit>_rack and the first diu_<unit>_rvaid pulse. For more detail on the timing of such reads and the implications for back-to-back sequences, see Section 20.14.10. 20.9.2 Read Protocol for CPU WO 2004/050369 PCT/AU2003/001616 270 The CPU performs single 256-bit read accesses with the read data being transferred from the DIU over a dedicated 256-bit read bus for DRAM data, dram-cpudata[255:O]. The read address cpuadr[21:5] is 256-bit aligned. The CPU DIU read protocol is: 5 u cpudiurreq is asserted along with a valid cpuadr[21:5]. * The DIU acknowledges the request with diu cpurack. The request should be deasserted. The minimum number of cycles between cpu diurreq being asserted and the DIU generating a cpudiu rack strobe is 1 cycle (1 cycle to perform the arbitration - see Section 20.14.10). 10 * The read data is returned on dramcpudata[255:0] and its validity is indicated by diucpurvaid. * When the diucpurvaid pulse has been received then if there is a further request cpudiurreq should be asserted again. The diu cpurvalid pulse with a gap of 1 cycle after rack (1 cycle for the read data to be returned from the DRAM - see Section 20.14.10). 15 20.9.3 Write Protocol except CPU and CDU The SoPEC write requestors, except for the CPU and CDU, perform single 256-bit write accesses with the write data being transferred to the DIU in 4 consecutive cycles over dedicated point-to point 64-bit write data busses. The write address <unit>_diuwadr[21:5] is 256-bit aligned. The write protocol is: 20 e <unit>_diu wreq is asserted along with a valid <unit>_diuwadr[21:5]. * The DIU acknowledges the request with diu <unit>_wack. The request should be deasserted. The minimum number of cycles between <unit> diu wreq being asserted and the DIU generating an diu <unit> wack strobe is 2 cycles (1 cycle to register the request, 1 cycle to perform the arbitration - see Section 20.14.10). 25 e In the clock cycles following diu_<unit>_wack the SoPEC Unit outputs the <unit>_diu data[63:0], asserting <unit> diu wvalid. The first <unit>_diu valid pulse can occur the clock cycle after diu_<unit>_wack. <unit>_diuwvalid remains asserted for the following 3 clock cycles. This allows for reading from an SRAM where new data is available in the clock cycle after the address has changed e.g. the address for the second 64-bits of 30 write data is available the cycle after diu_<unit>_wack meaning the second 64-bits of write data is a further cycle later. The overall 256 bits of data is transferred over four cycles in the order: [63:0] -> [127:64] -> [191:128] -> [255:192]. * Note that for SCB writes, each 64-bit quarter-word has an 8-bit byte enable mask associated with it. A different mask is used with each quarter-word. The 4 mask values are 35 transferred along with their associated data, as shown in Figure 92. * If four consecutive <unit> diu wvalid pulses are not provided by the requester, then the arbitration logic will disregard the write and re-allocate the slot under the unused read round-robin scheme. Once all the write data has been output then if there is a further request <unit> diu wreq should 40 be asserted again.
WO 2004/050369 PCT/AU2003/001616 271 20.9.4 CPU Write Protocol The CPU performs single 128-bit writes to the DIU on a dedicated write bus, cpudiuwdata[127:0j. There is an accompanying write mask, cpu_diu_wmask[15:0J, consisting of 16 byte enables and the CPU also supplies a 128-bit aligned write address on 5 cpu diuwadr[21:4]. Note that writes are posted by the CPU to the DIU and stored in a 1-deep buffer. When the DAU subsequently arbitrates in favour of the CPU, the contents of the buffer are written to DRAM. The CPU write protocol, illustrated in Figure 93., is as follows * The DIU signals to the CPU via diu cpuwriterdy that its write buffer is empty and that the 10 CPU may post a write whenever it wishes. * The CPU asserts cpudiuwdatavalid to enable a write into the buffer and to confirm the validity of the write address, data and mask. " The DIU de-asserts diucpu writerdy in the following cycle to indicate that its buffer is full and that the posted write is pending execution. 15 e When the CPU is next awarded a DRAM access by the DAU, the buffer's contents are written to memory. The DIU re-asserts diu cpu write rdy once the write data has been captured by DRAM, namely in the "MSN1" DCU state. * The CPU can then, if it wishes, asynchronously use the new value of .diu cpu write rdy to enable a new posted write in the same "MSN1" cycle. 20 20.9.5 CDU Write Protocol The CDU performs four 64-bit word writes to 4 contiguous 256-bit DRAM addresses with the first address specified by cdu diu wadr[21:3]. The write address cdu diu wadr[21:5] is 256-bit aligned with bits cdu diuwadr[4:3] allowing the 64-bit word to be selected. The write protocol is: 25 e cdudiu_wdata is asserted along with a valid cdudiuwadr[21:3]. * The DIU acknowledges the request with diu_cduwack. The request should be deasserted. The minimum number of cycles between cdudiu wreq being asserted and the DIU generating an diucduwack strobe is 2 cycles (1 cycle to register the request, 1 cycle to perform the arbitration -see Section 20.14.10). 30 In the clock cycles following diucdu_wack the CDU outputs the cdudiu data[63:0], together with asserted cdu_diuwvafid. The first cdu_diuwvalid pulse can occur the clock cycle after diu_cdu_ wack. cdu_diu_wvalid remains asserted for the following 3 clock cycles. This allows for reading from an SRAM where new data is available in the clock cycle after the address has changed e.g. the address for the second 64-bits of write data is available 35 the cycle after diu_cduwack meaning the second 64-bits of write data is a further cycle later. Data is transferred over the 4-cycle window in an order, such that each successive 64 bits will be written to a monotonically increasing (by 1 location) 256-bit DRAM word. * If four consecutive cdudiu_wvalid pulses are not provided with the data, then the arbitration logic will disregard the write and re-allocate the slot under the unused read 40 round-robin scheme.
WO 2004/050369 PCT/AU2003/001616 272 Once all the write data has been output then if there is a further request cdudiu_wreq should be asserted again. 20.10 DIU ARBITRATION MECHANISM The DIU will arbitrate access to the embedded DRAM. The arbitration scheme is outlined in the 5 next sections. 20.10.1 Timeslot based arbitration scheme Table summarised the bandwidth requirements of the SoPEC requestors to DRAM. If we allocate the DIU requestors in terms of peak bandwidth then we require 35.25 bits/cycle (at SF =6) and 40.75 bits/ cycle (at SF = 4) for all the requestors except the CPU. 10 A timeslot scheme is defined with 64 main timeslots. The number of used main timeslots is programmable between 1 and 64. Since DRAM read requestors, except for the CPU, are connected to the DIU via a 64-bit data bus each 256-bit DRAM access requires 4 pclk cycles to transfer the read data over the shared read bus. The timeslot rotation period for 64 timeslots each of 4 pclk cycles is 256 pc/k cycles or 1.6 ps, 15 assuming pck is 160 MHz. Each timeslot represents a 256-bit access every 256 pck cycles or 1 bit/cycle. This is the granularity of the majority of DIU requestors bandwidth requirements in Table . The SoPEC DIU requesters can be represented using 4 bits (Table n page288 on page 298). Using 64 timeslots means that to allocate each timeslot to a requester, a total of 64 x 5-bit 20 configuration registers are required for the 64 main timeslots. Timeslot based arbitration works by having a pointer point to the current timeslot. When re arbitration is signaled the arbitration winner is the current timeslot and the pointer advances to the next timeslot. Each timeslot denotes a single access. The duration of the timeslot depends on the access. 25 Note that advancement through the timeslot rotation is dependent on an enable bit, RotationSync, being set. The consequences of clearing and setting this bit are described in section 20.14.12.2.1 on page 325. If the SoPEC Unit assigned to the current timeslot is not requesting then the unused timeslot arbitration mechanism outlined in Section 20.10.6 is used to select the arbitration winner. 30 Note that there is always an arbitration winner for every slot. This is because the unused read re allocation scheme includes refresh in its round-robin protocol. If all other blocks are not requesting, an early refresh will act as fall-back for the slot. 20.10.2 Separate read and write arbitration windows For write accesses, except the CPU, 256-bits of write data are transferred from the SoPEC DIU 35 write requestors over 64-bit write busses in 4 clock cycles. This write data transfer latency means that writes accesses, except for CPU writes and also the CDU, must be arbitrated 4 cycles in advance. (The CDU is an exception because CDU writes can start once the first 64-bits of write data have been transferred since each 64-bits is associated with a write to a different 256-bit word).
WO 2004/050369 PCT/AU2003/001616 273 Since write arbitration must occur 4 cycles in advance, and the minimum duration of a timeslot duration is 3 cycles, the arbitration rules must be modified to initiate write accesses in advance. Accordingly, there is a write timeslot lookahead pointer shown in Figure 96 two timeslots in advance of the current timeslot pointer. 5 The following examples illustrate separate read and write timeslot arbitration with no adjacent write timeslots. (Recall rule on adjacent write timeslots introduced in Section 20.7.2.3 on page 267.) In Figure 97 writes are arbitrated two timeslots in advance. Reads are arbitrated in the same timeslot as they are issued. Writes can be arbitrated in the same timeslot as a read. During 10 arbitration the command address of the arbitrated SoPEC Unit is captured. Other examples are shown in Figure 98 and Figure 99. The actual timeslot order is always the same as the programmed timeslot order i.e. out of order accesses do not occur and data coherency is never an issue. Each write must always incur a latency of two timeslots. 15 Startup latency may vary depending on the position of the first write timeslot. This startup latency is not important. Table 112 shows the 4 scenarios depending on whether the current timeslot and write timeslot lookahead pointers point to read or write accesses. Table 112. Arbitration with separate windows for read and write accesses 20 current timeslot pointer write timeslot actions lookahead pointer Read write Initiate DRAM read, Initiate write arbitration Read1 read2 Initiate DRAM read. Write write2 Initiate write2 arbitration. Execute DRAM writer. Write read Execute DRAM write. If the current timeslot pointer points to a read access then this will be initiated immediately. If the write timeslot lookahead pointer points to a write access then this access is arbitrated immediately, or immediately after the read access associated with the current timeslot pointer is 25 initiated. When a write access is arbitrated the DIU will capture the write address. When the current timeslot pointer advances to the write timeslot then the actual DRAM access will be initiated. Writes will therefore be arbitrated 2 timeslots in advance of the DRAM write occurring.
WO 2004/050369 PCT/AU2003/001616 274 At initialisation, the write lookahead pointer points to the first timeslot. The current timeslot pointer is invalid until the write lookahead pointer advances to the third timeslot when the current timeslot pointer will point to the first timeslot. Then both pointers advance in tandem. CPU write accesses are excepted from the lookahead mechanism. 5 If the selected SoPEC Unit is not requesting then there will be separate read and write selection for unused timeslots. This is described in Section 20.10.6. 20.10.3 Arbitration of CPU accesses What distinguishes the CPU from other SoPEC requestors, is that the CPU requires minimum latency DRAM access i.e. preferably the CPU should get the next available timeslot whenever it 10 requests. The minimum CPU read access latency is estimated in Table 113. This is the time between the CPU making a request to the DIU and receiving the read data back from the DIU. Table 113. Estimated CPU read access latency ignoring caching CPU read access latency Duration CPU cache miss 1 cycle CPU MMU logic issues request and 1 cycle DIU arbitration completes Transfer the read address to the DRAM 1 cycle DRAM read latency 1 cycle Register the read data in CPU bridge 1 cycle Register the read data in CPU 1 cycle CPU cache miss 1 cycle CPU MMU logic issues request and 1 cycle DIU arbitration completes TOTAL gap between requests cycles 15 If the CPU, as is likely, requests DRAM access again immediately after receiving data from the DIU then the CPU could access every second timeslot if the access latency is 6 cycles. This assumes that interleaving is employed so that timeslots last 3 cycles. If the CPU access latency were 7 cycles, then the CPU would only be able to access every third timeslot. 20 If a cache hit occurs the CPU does not require DRAM access. For its next DIU access it will have to wait for its next assigned DIU slot. Cache hits therefore will reduce the number of DRAM accesses but not speed up any of those accesses. To avoid the CPU having to wait for its next timeslot it is desirable to have a mechanism for ensuring that the CPU always gets the next available timeslot without incurring any latency on the 25 non-CPU timeslots. This can be done by defining each timeslot as consisting of a CPU access preceding a non-CPU access. Each timeslot will last 6 cycles i.e. a CPU access of 3 cycles and a non-CPU access of 3 cycles. This is exactly the interweaving behaviour outlined in Section 20.7.2.2. If the CPU does not WO 2004/050369 PCT/AU2003/001616 275 require an access, the timeslot will take 3 or 4 and the timeslot rotation will go faster. A summary is given in Table 114. Table 114. Timeslot access times. ccess Duration Explanation CPU access + non-CPU access 3 + 3 = 6 cycles Interleaved access non-CPU access 4 cycles Access and preceding access both to shared read bus non-CPU access 3 cycles Access and preceding access not both to shared read bus CDU write access 3+2+2+2 = 9 cycles Page mode select signal is clocked at 160 MHz 5 CDU write accesses require 9 cycles. CDU write accesses preceded by a CPU access require 12 cycles. CDU timeslots therefore take longer than all other DIU requestors timeslots. With a 256 cycle rotation there can be 42 accesses of 6 cycles. For low scale factor applications, it is desirable to have more timeslots available in the same 256 cycle rotation. So two counters of 4-bits each are defined allowing the CPU to get a maximum of 10 (CPUPreAccessTimeslots + 1) pre-accesses for every (CPUTotalTimeslots + 1) main slots. A timeslot counter starts at CPUTotalTimesfots and decrements every timeslot, while another counter starts at CPUPreAccessTimeslots and decrements every timeslot in which the CPU uses its access. When the CPU pre-access counter goes to zero before CPUTotalTimeslots, no further CPU accesses are allowed. When the CPUTotalTimeslots counter reaches zero both counters 15 are reset to their respective initial values. The CPU is not included in the list of SoPEC DIU requesters, Table , for the main timeslot allocations. The CPU cannot therefore be allocated main timeslots. It relies on pre-accesses in advance of such slots as the sole method for DRAM transfers. CPU access to DRAM can never be fully disabled, since to do so would render SoPEC 20 inoperable. Therefore the CPUPreAccessTimeslots and CPUTotalTimeslots register values are interpreted as follows : In each succeeding window of (CPUTota/Timeslots+ 1) slots, the maximum quota of CPU pre-accesses allowed is (CPUPreAccessTimeslots + 1). The "+ 1" implementations mean that the CPU quota cannot be made zero. The various modes of operation are summarised in Table 115 with a nominal rotation period of 25 256 cycles. Table 115. CPU timeslot allocation modes with nominal rotation period of 256 cycles Access Type Nominal Number of Notes Timeslot timeslots duration CPU Pre-access 6 cycles 42 timeslots Each access is CPU + non-CPU. i.e. If CPU does not use a timeslot then WO 2004/050369 PCT/AU2003/001616 276 CPUPreAccessTimeslo rotation is faster. ts = CPUTotalTimeslots Fractional CPU Pre- 4 or 6 42-64 timeslots Each CPU + non-CPU access access cycles requires a 6 cycle i.e. timeslot. CPUPreAccessTimeslo ts < CPUTotalTimeslots Individual non-CPU timeslots take 4 cycles if current access and preceding access are both to shared read bus. Individual non-CPU timeslots take 3 cycles if current access and preceding access are not both to shared read bus. 20.10.4 CDU accesses As indicated in Section 20.10.3, CDU write accesses require 9 cycles. CDU write accesses preceded by a CPU access require 12 cycles. CDU timeslots therefore take longer than all other DIU requestors timeslots. This means that when a write timeslot is unused it cannot be re 5 allocated to a CDU write as CDU accesses take 9 cycles. The write accesses which the CDU write could otherwise replace require only 3 or 4 cycles. Unused CDU write accesses can be replaced by any other write access according to 20.10.6.1 Unused write timeslots allocation on page 277. 20.10.5 Refresh controller 10 Refresh is not included in the list of SoPEC DIU requesters, Table ,for the main timeslot allocations. Timeslots cannot therefore be allocated to refresh. The DRAM must be refreshed every 3.2 ms. Refresh occurs row at a time over 5120 rows of 2 parallel 10 Mbit instances. A refresh operation must therefore occur every 100 cycles. The refreshperiod register has a default value of 99. Each refresh takes 3 cycles. 15 A refresh counter will count down the number of cycles between each refresh. When the down counter reaches 0, the refresh controller will issue a refresh request and the down-counter is reloaded with the value in refreshperiod and the count-down resumes immediately. Allocation of main slots must take into account that a refresh is required at least once every 100 cycles. Refresh is included in the unused read and write timeslot allocation. If unused timeslot allocation 20 results in refresh occurring early by N cycles, then the refresh counter will have counted down to N. In this case, the refresh counter is reset to refresh_period and the count-down recommences.
WO 2004/050369 PCT/AU2003/001616 277 Refresh can be preceded by a CPU access in the same way as any other access. This is controlled by the CPUPreAccessTimeslots and CPUTotalTimeslots configuration registers. Refresh will therefore not affect CPU performance. A sequence of accesses including refresh might therefore be CPU, refresh, CPU, actual timeslot. 5 20.10.6 Allocating unused timeslots Unused slots are re-allocated separately depending on whether the unused access was a read access or a write access. This is best-effort traffic. Only unused non-CPU accesses are re allocated. 20.10.6.1 Unused write timeslots allocation 10 Unused write timeslots are re-allocated according to a fixed priority order shown in Table 116 . Table 116. Unused write timeslot priority order Name Priority Order SCB(W) 1 SFU(W) 2 DWU 3 Unused read timeslot allocation CDU write accesses cannot be included in the unused timeslot allocation for write as CDU accesses take 9 cycles. The write accesses which the CDU write could otherwise replace require 15 only 3 or 4 cycles. Unused write timeslot allocation occurs two timeslots in advance as noted in Section 20.10.2. If the units at priorities 1-3 are not requesting then the timeslot is re-allocated according to the unused read timeslot allocation scheme described in Section 20.10.6.2. However, the unused read timeslot allocation will occur when the current timeslot pointer of Figure 96 reaches the 20 timeslot i.e. it will not occur in advance. 20.10.6.2 Unused read timeslots allocation Unused read timeslots are re-allocated according to a two level round-robin scheme. The SoPEC Units included in read timeslot re-allocation is shown in Table 117. 25 Table 117. Unused read timeslot allocation Name SCB(R) CDU(R) CFU LBD
SFU(R)
WO 2004/050369 PCT/AU2003/001616 278 TE(TD) TE(TFS) HCU DNC LLU PCU CPU Refresh Each SoPEC requestor has an associated bit, ReadRoundRobinLevel, which indicates whether it is in level 1 or level 2 round-robin. Table 118. Read round-robin level selection 5 Level Action ReadRoundRobinLevel = 0 Level 1 ReadRoundRobinLevel= I Level 2 A pointer points to the most recent winner on each of the round-robin levels. Re-allocation is carried out by traversing level 1 requesters, starting with the one immediately succceding the last level 1 winner. If a requesting unit is found, then it wins arbitration and the level 1 pointer is shifted 10 to its position. If no level 1 unit wants the slot, then level 2 is similarly examined and its pointer adjusted. Since refresh occupies a (shared) position on one of the two levels and continually requests access, there will always be some round-robin winner for any unused slot. 20.10.6.2.1 Shared CPU / Refresh Round-Robin Position 15 Note that the CPU can conditionally be allowed to take part in the unused read round-robin scheme. Its participation is controlled via the configuration bit EnableCPURoundRobin. When this bit is set, the CPU and refresh share a joint position in the round-robin order, shown in Table When cleared, the position is occupied by refresh alone. If the shared position is next in line to be awarded an unused non-CPU read/write slot, then the 20 CPU will have first option on the slot. Only if the CPU doesn't want the access, will it be granted to refresh. If the CPU is excluded from the round robin, then any awards to the position benefit refresh. 20.11 GUIDELINES FOR PROGRAMMING THE DIU Some guidelines for programming the DIU arbitration scheme are given in this section together 25 with an example. 20.11.1 Circuit Latency WO 2004/050369 PCT/AU2003/001616 279 Circuit latency is a fixed service delay which is incurred, as and from the acceptance by the DIU arbitration logic of a block's pending read/write request. It is due to the processing time of the request, readying the data, plus the DRAM access time. Latencies differ for read and write requests. See Tables 79 and 80 for respective breakdowns. 5 If a requesting block is currently stalled, then the longest time it will have to wait between issuing a new request for data and actually receiving it would be its timeslot period, plus the circuit latency overhead, along with any intervening non-standard slot durations, such as refresh and CDU(W). In any case, a stalled block will always incur this latency as an additional overhead, when coming out of a stall. 10 In the case where a block starts up or unstalls, it will start processing newly-received data at a time beyond its serviced timeslot equivalent to the circuit latency. If the block's timeslots are evenly spaced apart in time to match its processing rate, (in the hope of minimising stalls,) then the earliest that the block could restall, if not re-serviced by the DIU, would be the same latency delay beyond its next timeslot occurrence. Put another way, the latency incurred at start-up 15 pushes the potential DIU-induced stall point out by the same fixed delta beyond each successive timeslot allocated to the block. This assumes that a block re-requests access well in advance of its upcoming timeslots. Thus, for a given stall-free run of operation, the circuit latency overhead is only incurred inititially when unstalling. While a block can be stalled as a result of how quickly the DIU services its DRAM requests, it is 20 also prone to stalls caused by its upstream or downstream neighbours being able to supply or consume data which is transferred between the blocks directly, (as opposed to via the DIU). Such neighbour-induced stalls, often occurring at events like end of line, will have the effect that a block's DIU read buffer will tend to fill, as the block stops processing read data. Its DIU write buffer will also tend to fill, unable to despatch to DRAM until the downstream block frees up 25 shared-access DRAM locations. This scenario is beneficial, in that when a block unstalls as a result of its neighbour releasing it, then that block's read/write DIU buffers will have a fill state less likely to stall it a second time, as a result of DIU service delays. A block's slots should be scheduled with a service guarantee in mind. This is dictated by the block's processing rate and hence, required access to the DRAM. The rate is expressed in terms 30 of bits per cycle across a processing window, which is typically (though not always) 256 cycles. Slots should be evenly interspersed in this window (or "rotation") so that the DIU can fulfill the block's service needs. The following ground rules apply in calculating the distribution of slots for a given non-CPU block: . The block can, at maximum, suffer a stall once in the rotation, (i.e. unstall and restall) and 35 hence incur the circuit latency described above. This rule is, by definition, always fulfilled by those blocks which have a service requirement of only 1 bit/cycle (equivalent to 1 slot/rotation) or fewer. It can be shown that the rule is also satisfied by those blocks requiring more than 1 bit/cycle. See Section 20.12.1 Slot Distributions and Stall Calculations for Individual Blocks, on page 285.
WO 2004/050369 PCT/AU2003/001616 280 " Within the rotation, certain slots will be unavailable, due to their being used for refresh. (See Section 20.11.2 Refresh latencies) * In programming the rotation, account must be taken of the fact that any CDU(W) accesses will consume an extra 6 cycles/access, over and above the norm, in CPU pre-access mode, 5 or 5 cycles/access without pre-access. * The total delay overhead due to latency, refreshes and CDU(W) can be factored into the service guarantee for all blocks in the rotation by deleting once, (i.e. reducing the rotation window,) that number of slots which equates to the cumulative duration of these various anomalies. 10 o The use of lower scale factors will imply a more frequent demand for slots by non-CPU blocks. The percentage of slots in the overall rotation which can therefore be designated as CPU pre-access ones should be calculated last, based on what can be accommodated in the light of the non-CPU slot need. Read latency is summarised below in Table 119 15 Table 119. Read latency Non-CPU read access latency Duration non-CPU read requestor internally 1 cycle generates DIU request register the non- CPU read request 1 cycle complete the arbitration of the request I cycle transfer the read address to the DRAM 1 cycle DRAM read latency 1 cycle register the DRAM read data in DIU 1 cycle register the 1st 64-bits of read data in 1 cycle requester register the 2nd 64-bits of read data in 1 cycle requester register the 3rd 64-bits of read data in 1 cycle requester register the 4th 64-bits of read data in I cycle requester TOTAL 10 cycles Write latency Is summarised in Table 120. Table 120. Write latency 20 Non-CPU write access latency Duration non-CPU write requestor internally generates DIU request 1 cycle WO 2004/050369 PCT/AU2003/001616 281 register the non-CPU write request I cycle complete the arbitration of the request 1 cycle transfer the acknowledge to the write requester 1 cycle transfer the 1st 64 bits of write data to the DIU 1 cycle transfer the 2nd 64 bits of write data to the DIU 1 cycle transfer the 3rd 64 bits of write data to the DIU 1 cycle transfer the 4th 64 bits of write data to the DIU 1 cycle Write to DRAM with locally registered write data I cycle TOTAL 9 cycles Timeslots removed to allow for read latency will also cover write latency, since the former is the larger of the two. 20.11.2 Refresh latencies 5 The number of allocated timeslots for each requester needs to take into account that a refresh must occur every 100 cycles. This can be achieved by deleting timeslots from the rotation since the number of timeslots is made programmable. Refresh is preceded by a CPU access in the same way as any other access. This is controlled by the CPUPreAccessTimeslots and CPUTotaITimeslots configuration registers. Refresh will 10 therefore not affect CPU performance. As an example, in CPU pre-access mode each timeslot will last 6 cycles. If the timeslot rotation has 50 timeslots then the rotation will last 300 cycles. The refresh controller will trigger a refresh every 100 cycles. Up to 47 timeslots can be allocated to the rotation ignoring refresh. Three timeslots deleted from the 50 timeslot rotation will allow for the latency of a refresh every 100 15 cycles. 20.11.3 Ensuring sufficient DNC and PCU access PCU command reads from DRAM are exceptional events and should complete in as short a time as possible. Similarly, we must ensure there is sufficient free bandwidth for DNC accesses e.g. when clusters of dead nozzles occur. In Table DNC is allocated 3 times average bandwidth. 20 PCU and DNC can also be allocated to the level 1 round-robin allocation for unused timeslots so that unused timeslot bandwidth is preferentially available to them. 20.11.4 Basing timeslot allocation on peak bandwidths Since the embedded DRAM provides sufficient bandwidth to use 1:1 compression rates for the CDU and LBD, it is possible to simplify the main timeslot allocation by basing the allocation on 25 peak bandwidths. As combined bi-level and tag bandwidth at 1:1 scaling is only 5 bits/cycle, we will usually only consider the contone scale factor as the variable in determining timeslot allocations. If slot allocation is based on peak bandwidth requirements then DRAM access will be guaranteed to all SoPEC requesters. If we do not allocate slots for peak bandwidth requirements then we can 30 also allow for the peaks deterministically by adding some cycles to the print line time.
WO 2004/050369 PCT/AU2003/001616 282 20.11.5 Adjacent timeslot restrictions 20.11.5.1 Non-CPU write adjacent timeslot restrictions Non-CPU write requestors should not be assigned adjacent timeslots as described in Section 20.7.2.3. This is because adjacent timeslots assigned to non-CPU requestors would require two 5 sets of 256-bit write buffers and multiplexors to connect two write requestors simultaneously to the DIU. Only one 256-bit write buffer and multiplexor is implemented. Recall from section 20.7.2.3 on page 267 that if adjacent non-CPU writes are attempted, that the second write of any such pair will be disregarded and re-allocated under the unused read scheme. 20.11.5.2 Same DIU requestor adjacent timeslot restrictions 10 All DIU requesters have state-machines which request and transfer the read or write data before requesting again. From Figure 90 read requests have a minimum separation of 9 cycles. From Figure 92 write requests have a minimum separation of 7 cycles. Therefore adjacent timeslots should not be assigned to a particular DIU requester because the requester will not be able to make use of all these slots. 15 In the case that a CPU access precedes a non-CPU access timeslots last 6 cycles so write and read requesters can only make use of every second timeslot. In the case that timeslots are not preceded by CPU accesses timeslots last 4 cycles so the same write requester can use every second timeslot but the same read requestor can use only every third timeslot. Some DIU requestors may introduce additional pipeline delays before they can request again. Therefore 20 timeslots should be separated by more than the minimum to allow a margin. 20.11.6 Line margin The SFU must output 1 bit/cycle to the HCU. Since HCUNumDots may not be a multiple of 256 bits the last 256-bit DRAM word on the line can contain extra zeros. In this case, the SFU may not be able to provide 1 bit/cycle to the HCU. This could lead to a stall by the SFU. This stall could 25 then propagate if the margins being used by the HCU are not sufficient to hide it. The maximum stall can be estimated by the calculation: DRAM service period - X scale factor * dots used from last DRAM read for HCU line. Similarly, if the line length is not a multiple of 256-bits then e.g. the LLU could read data from DRAM which contains padded zeros. This could lead to a stall. This stall could then propagate if 30 the page margins cannot hide it. A single addition of 256 cycles to the line time will suffice for all DIU requesters to mask these stalls. 20.12 EXAMPLE OUTLINE DIU PROGRAMMING Table 121. Timeslot allocation based on peak bandwidth 35 Block Name Direction Peak Bandwidth MainTimeslots which must be allocated supplied (bits/cycle) SCB R WO 2004/050369 PCT/AU2003/001616 283 0.734' 1 CDU R 0.9 (SF = 6), 1 (SF = 6) 2 (SF = 4) 2 (SF = 4) W 1.8 (SF = 6),'j 2 (SF = 6) 4 (SF = 4) 4 (SF = 4) CFU R 5.4 (SF = 6), 6 (SF = 6) 8(SF =4) 8(SF=4) LBD R 1 1 SFU R 2 2 W 1 1 TE(TD) R 1.02 1 TE(TFS) R 0.093 0 HCU R 0.074 0 DNC R 2.4 3 DWU W 6 6 LLU R 8 8 PCU R 1 1 TOTAL 33 (SF=6) 38 (SF=4) Table 121 shows an allocation of main timeslots based on the peak bandwidths of Table The bandwidth required for each unit is calculated allowing extra cycles for read and write circuit latency for each access requiring a bandwidth of more than I bit/cycle. Fractional bandwidth is supplied via unused read slots. 5 The timeslot rotation is 256 cycles. Timeslots are deleted from the rotation to allow for circuit latencies for accesses of up to I bit per cycle i.e. I timeslot per rotation. Example 1: Scale-factor = 6 Program the MainTimeslot configuration register (Table ) for peak required bandwidths of SoPEC Units according to the scale factor. 10 Program the read round-robin allocation to share unused read slots. Allocate PCU, DNC, HCU and TFS to level 1 read round-robin. * Assume scale-factor of 6 and peak bandwidths from Table Assign all DIU requestors except TE(TFS) and HCU to multiples of I timeslot, as indicated in Table , where each timeslot is 1 bit/cycle. This requires 33 timeslots. 15 * No timeslots are explicitly allocated for the fractional bandwidth requirements of TE(TFS) and HCU accesses. Instead, these units are serviced via unused read slots. 7 The SCB figure of 0.734 bits/cycle applies to multi-SoPEC systems. For single-SoPEC systems, the figure is 0.050 bits/cycle. Bandwidth for CDU(W) is peak value. Because of 1.5 buffering in DRAM, peak CDU(W) b/w equals 2 x average CDU(W) b/w. For CDU(R), peak b/w = average CDU(R) b/w.
WO 2004/050369 PCT/AU2003/001616 284 * Allow 3 timeslots to allow for 3 refreshes in the rotation. * Therefore, 36 scheduled slots are used in the rotation for main timeslots and refreshes, some or all of which may be able to have a CPU pre-access, provided they fit in the rotation window. 5 e Each of the 2 CDU(W) accesses requires 9 cycles. Per access, this implies an overhead of 1 slot (12 cycles instead of 6) in pre-access mode, or 1.25 slots (9 cycles instead of 4) for no pre-access. The cumulative overhead of the two accesses is either 2 slots (pre-access) or 3 slots (no pre-access). * Assuming all blocks require a service guarantee of no more than a single stall across 256 10 bits, allow 10 cycles for read latency, which also takes care of 9-cycle write latency. This can be accounted for by reserving 2 six-cycle slots (CPU pre-access) or 3 four-cycle slots (no pre-access). * Assume a 256 cycle timeslot rotation. * CDU(W) and read latency reduce the number of available cycles in a rotation to: 256 - 2x6 15 2x6 = 232 cycles (CPU pre-access) or 256 - 3x4 - 3x4 = 232 cycles (no pre-access). * As a result, 232 cycles available for 36 accesses implies each access can take 232 / 36 = 6.44 cycles maximum. So, all accesses can have a pre-access. * Therefore the CPU achieves a pre-access ratio of 36 / 36 = 100% of slots in the rotation. Example 2: Scale-factor = 4 20 Program the MainTimeslot configuration register (Table ) for peak required bandwidths of SoPEC Units according to the scale factor. Program the read round-robin allocation to share unused read slots. Allocate PCU, DNC, HCU and TFS to level 1 read round-robin. * Assume scale-factor of 4 and peak bandwidths from Table . * Assign all DIU requestors except TE(TFS) and HCU multiples of 1 timeslot, as indicated in 25 Table , where each timeslot is 1 bit/cycle. This requires 38 timeslots. * No timeslots are explicitly allocated for the fractional bandwidth requirements of TE(TFS) and HCU accesses. Instead, these units are serviced via unused read slots. " Allow 3 timeslots to allow for 3 refreshes in the rotation. * Therefore, 41 scheduled slots are used in the rotation for main timeslots and refreshes, 30 some or all of which can have a CPU pre-access, provided they fit in the rotation window. * Each of the 4 CDU(W) accesses requires 9 cycles. Per access, this implies an overhead of I slot (12 cycles instead of 6) for pre-access mode, or 1.25 slots (9 cycles instead of 4) for no pre-access. The cumulative overhead of the four accesses is either 4 slots (pre-access) or 5 slots (no pre-access). 35 0 Assuming all blocks require a service guarantee of no more than a single stall across 256 bits, allow 10 cycles for read latency, which also takes care of 9-cycle write latency. This can be accounted for by reserving 2 six-cycle slots (CPU pre-access) or 3 four-cycle slots (no pre-access).
WO 2004/050369 PCT/AU2003/001616 285 e Assume a 256 cycle timeslot rotation. * CDU(W) and read latency reduce the number of available cycles in a rotation to: 256 - 4x6 2x6 = 220 cycles (CPU pre-access) or 256 - 5x4 - 3x4 = 224 cycles (no pre-access). * As a result, between 220 and 224 cycles are available for 41 accesses, which implies each 5 access can take between 220 / 41 = 5.36 cycles and 224 / 41 = 5.46 cycles. * Work out how many slots can have a pre-access: For the lower number of 220 cycles, this implies (41 - n)*6 + n*4 <= 220, where n = number of slots with no pre-access cycle. Solving the equation gives n >= 13. Check answer: 28*6 + 13*4 = 220. " So 28 slots out of the 41 in the rotation can have CPU pre-accesses. 10 * The CPU thus achieves a pre-access ratio of 28 / 41 = 68.3% of slots in the rotation. 20.12.1 Slot Distributions and Stall Calculations for Individual Blocks The following sections show how the slots for blocks with a service requirement greater than 1 bit/cycle should be distributed. Calculations are included to check that such blocks will not suffer more than one stall per rotation. 15 20.12.1.1 SFU This has 2 bits/cycle on read but this is two separate channels of 1 bit/cycle sharing the same DIU interface so it is effectively 2 channels each of I bit/cycle so allowing the same margins as the LBD will work. 20.12.1.2 DWU 20 The DWU has 12 double buffers in each of the 6 colour planes, odd and even. These buffers are filled by the DNC and will request DIU access when double buffers fill. The DNC supplies 6 bits to the DWU every cycle (6 odd in one cycle, 6 even in the next cycle). So the service deadline is 512 cycles, given 6 accesses per 256-cycle rotation. 20.12.1.3 CFU 25 Here the requirement is that the DIU stall should be less than the time taken for the CFU to consume one third of its triple buffer. The total DIU stall = refresh latency + extra CDU(W) latency + read circuit latency = 3 + 5 (for 4 cycle timeslots) + 10 = 18 cycles. The CFU can consume its data at 8 bits/cycle at SF = 4. Therefore 256 bits of data will last 32 cycles so the triple buffer is safe. In fact we only need an extra 144 bits of buffering or 3 x 64 bits. But it is safer to have the 30 full extra 256 bits or 4 x 64 bits of buffering. 20.12.1.4 LLU The LLU has 2 channels, each of which could request at 6 bits/1 06 MHz channel or 4 bits/1 60MHz cycle, giving a total of 8 bits/1 60MHz cycle. The service deadline for each channel is 256 x 106 MHz cycles, i.e. all 6 colours must be transferred in 256 cycles to feed the printhead. 35 This equates to 384 x 160 MHz cycles. Over a span of 384 cycles, there will be 6 CDU(W) accesses, 4 refreshes and one read latency encountered at most. Assuming CPU pre-accesses for these occurrences, this means the number of available cycles is given by 384 - 6x6 - 4x6 - 10 = 314 cycles.
WO 2004/050369 PCT/AU2003/001616 286 For a CPU pre-access slot rate of 50%, 314 cycles implies 31 CPU and 63 non-CPU accesses (31 x 6 + 32 x 4 = 314). For 12 LLU accesses interspersed amongst these 63 non-CPU slots, implies an LLU allocation rate of approximately one slot in 5. If the CPU pre-access is 100% across all slots, then 314 cycles gives 52 slots each to CPU and 5 non-CPU accesses, (52 x 6 = 312 cycles). Twelve accesses spread over 52 slots, implies a 1-in-4 slot allocation to the LLU. The same LLU slot allocation rate (1 slot in 5, or 1 in 4) can be applied to programming slots across a 256-cycle rotation window. The window size does not affect the occurrence of LLU slots, so the 384-cycle service requirement will be fulfilled. 10 20.12.1.5 DNC This has a 2.4 bits/cycle bandwidth requirement. Each access will see the DIU stall of 18 cycles. 2.4 bits/ cycle corresponds to an access every 106 cycles within a 256 cycle rotation. So to allow for DIU latency we need an access every 106 -18 or 88 cycles. This is a bandwidth of 2.9 bits/cycle, requiring 3 timeslots in the rotation. 15 20.12.1.6CDU The JPEG decoder produces 8 bits/cycle. Peak CDUR[ead] bandwidth is 4 bits/cycle (SF=4), peak CDUW[rite] bandwidth is 4 bits/cycle (SF=4). both with 1.5 DRAM buffering. The CDU(R) does a DIU read every 64 cycles at scale factor 4 with 1.5 DRAM buffering. The delay in being serviced by the DIU could be read circuit latency (10) + refresh (3) + extra CDU(W) 20 cycles (6) = 19 cycles. The JPEG decoder can consume each 256 bits of DIU-supplied data at 8 bits/cycle, i.e. in 32 cycles. If the DIU is 19 cycles late (due to latency) in supplying the read data then the JPEG decoder will have finished processing the read data 32 + 19 = 49 cycles after the DIU access. This is 64 - 49 = 15 cycles in advance of the next read. This 15 cycles is the upper limit on how much the DIU read service can further be delayed, without causing a stall. Given this 25 margin, a stall on the read side will not occur. On the write side, for scale factor 4, the access pattern is a DIU writes every 64 cycles with 1.5 DRAM buffereing. The JPEG decoder runs at 8 bits cycle and consumes 256 bits in 32 cycles. The CDU will not stall if the JPEG decode time (32) + DIU stall (19) < 64, which is true. 20.13 CPU DRAM ACCESS PERFORMANCE 30 The CPU's share of the timeslots can be specified in terms of guaranteed bandwidth and average bandwidth allocations. The CPU's access rate to memory depends on * the CPU read access latency i.e. the time between the CPU making a request to the DIU and receiving the read data back from the DIU. 35 . how often it can get access to DIU timeslots. Table estimated the CPU read latency as 6 cycles. How often the CPU can get access to DIU timeslots depends on the access type. This is summarised in Table 122. Table 122. CPU DRAM access performance 40 WO 2004/050369 PCT/AU2003/001616 287 Access Type Nominal CPU DRAM Notes Timeslot access rate Duration CPU Pre- 6 cycles Lower bound (guaranteed CPU can access every access bandwidth) is timeslot. 160 MHz / 6 = 26.27 MHz Fractional or 6 cycles Lower bound (guaranteed CPU accesses precede a CPU bandwidth) is fraction N of timeslots Pre-access (160 MHz * N / P) where N = C/T. C = CPUPreAccessTimeslots T = CPUTotalTimeslots P = (6*C + 4*(T-C)) / T In both CPU Pre-access and Fractional CPU Pre-access modes, if the CPU is not requesting the timeslots will have a duration of 3 or 4 cycles depending on whether the current access and preceding access are both to the shared read bus. This will mean that the timeslot rotation will run faster and more bandwidth is available. 5 If the CPU runs out of its instruction cache then instruction fetch performance is only limited by the on-chip bus protocol. If data resides in the data cache then 160 MHz performance is achieved. Accessing memory mapped registers, PSS or ROM with a 3 cycle bus protocol (address cycle + data cycle) gives 53 MHz performance. Due to the action of CPU caching, some bandwidth limiting of the CPU in Fractional CPU Pre 10 access mode is expected to have little or no impact on the overall CPU performance. 20.14 IMPLEMENTATION The DRAM Interface Unit (DIU) is partitioned into 2 logical blocks to facilitate design and verification. a. The DRAM Arbitration Unit (DAU) which interfaces with the SoPEC DIU requesters. 15 b. The DRAM Controller Unit (DCU) which accesses the embedded DRAM. The basic principle in design of the DIU is to ensure that the eDRAM is accessed at its maximum rate while keeping the CPU read access latency as low as possible. The DCU is designed to interface with single bank 20 Mbit IBM Cu-1I embedded DRAM performing random accesses every 3 cycles. Page mode burst of 4 write accesses, associated 20 with the CDU, are also supported. The DAU is designed to support interleaved accesses allowing the DRAM to be accessed every 3 cycles where back-to-back accesses do not occur over the shared 64-bit read data bus. 20.14.1 DIU Partition 20.14.2 Definition of DCU 10 25 Table 123. DCU interface WO 2004/050369 PCT/AU2003/001616 288 Port Name Pins 1/O Description Clocks and Resets pclk 1 in SoPEC Functional clock daudcuresetn 1 In Active-low, synchronous reset in pclk domain. Incorporates DAU hard and soft resets. Inputs from DAU daudcumsn2stall I In Signal indicating from DAU Arbitration Logic which when asserted stalls DCU in MSN2 state. dau dcuadr[21:5] 17 In Signal indicating the address for the DRAM access. This is a 256-bit aligned DRAM address. daudcurwn 1 In Signal indicating the direction for the DRAM access (1=read, O=write). daudcucduwpage 1 In Signal indicating if access is a CDU write page mode access (1 =CDU page mode, 0=not CDU page mode). dau dcu refresh 1 In Signal indicating that a refresh command is to be issued. If asserted dau dcu adr, daudcurwn and dau_dcu cduwpage are ignored. dau dcu wdata 256 In 256-bit write data to DCU daudcuwmask 32 In Byte encoded write data mask for 256-bit dau dcu wdata to DCU Polarity: A "1" in a bit field of dau dcu wmask means that the corresponding byte in the 256-bit dau dcu wdata is written to DRAM. Outputs to DAU dcudauadv 1 Out Signal indicating to DAU to supply next command to DCU dcudauwadv 1 Out Signal indicating to DAU to initiate next non CPU write dcudaurefreshcompl 1 Out Signal indicating that the DCU has completed ete a refresh. dcu dau rdata 256 Out 256-bit read data from DCU. dcudaurvalid 1 Out Signal indicating valid read data on dcu dau rdata. 20.14.3 DRAM access types WO 2004/050369 PCT/AU2003/001616 289 The DRAM access types used in SoPEC are summarised in Table 124. For a refresh operation the DRAM generates the address internally. Table 124. SoPEC DRAM access types Type Access Read Random 256-bit read Write Random 256-bit write with byte write masking Page mode write for burst of 4 256-bit words with byte write masking Refresh Single refresh 5 20.14.4 Constructing the 20 Mbit DRAM from two 10 Mbit instances The 20 Mbit DRAM is constructed from two 10 Mbit instances. The address ranges of the two instances are shown in Table 125 . Table 125. Address ranges of the two 10 Mbit instances in the 20 Mbit DRAM 10 Instance Address Hex 256-bit Binary 256-bit word address word address Instance First word in lower 10 Mbit 00000 0 0000 0000 0000 0000 Instance Last word in lower 10 Mbit 09FFF 0 1001 1111 1111 1111 Instance First word in upper 10 Mbit DAOOO 0 1010 0000 0000 0000 Instance Last word in upper 10 Mbit 13FFF 1 0011 1111 1111 1111 There are separate macro select signals, instO MSN and instlMSN, for each instance and separate dataout busses instODO and instlDO, which are multiplexed in the DCU. Apart from these signals both instances share the DRAM output pins of the DCU. 15 The DRAM Arbitration Unit (DAU) generates a 17 bit address, dau dcu adr[21:5], sufficient to address all 256-bit words in the 20 Mbit DRAM. The upper 5 bits are used to select between the two memory instances by gating their MSN pins. If instance is selected then the lower 16-bits are translated to map into the 10 Mbit range of that instance. The multiplexing and address translation rules are shown in Table 126. 20 In the case that the DAU issues a refresh, indicated by dau dcu refresh, then both macros are selected. The other control signals Table 126. Instance selection and address translation daudcurefresh DAU Address Instance inst0_MSN inst1_MSN Address translation bits selected daudcuadr[21:17 0 <01010 Instance0 MSN 1 A[15:0] = WO 2004/050369 PCT/AU2003/001616 290 daudcuadr[20:5] >= 01010 Instancel 1 MSN A[15:0] = daudcuadr[21:5] - hA000 1 - Instance0 MSN MSN and Instance daudcuadr[21:5], daudcurwn and dau-dcucduwpage are ignored. The instance selection and address translation logic is shown in Figure 102. The address translation and instance decode logic also increments the address presented to the 5 DRAM in the case of a page mode write. Pseudo code is given below. if rising edge(daudcuvalid) then //capture the address from the DAU next cmdadr[21:53 = dau dcu adr[21:5] 10 elsif pagemodeadrinc == 1 then //increment the address next cmdadr[21:5] = cmdadr[21:5] + 1 else next cmdadr[21:5 = cmdadr[21:5] 15 if risingedge(daudcuvalid) then //capture the address from the DAU adr var[21:5]:= dau dcu adr[21:5] else 20 adr var[21:5]:= cmdadr[21:53 if adr var[21:17] < 01010 then //choose instanceC instance sel = 0 25 A[15:0] = adr var[20:5] else //choose instance instance sel = 1 A[15:01 = adr var[21:5] - hAO00 30 Pseudo code for the select logic, SELO, for DRAM Instance0 is given below. instanceco selected or refresh if instance sel == 0 OR dau-dcu-refresh == 1 then WO 2004/050369 PCT/AU2003/001616 291 instO MSN = MSN else instO MSN = 1 Pseudo code for the select logic, SEL1, for DRAM Instancel is given below. 5 //instancel selected or refresh if instance sel == 1 OR dau dcu refresh == 1 then inst1 MSN = MSN else inst1 MSN = 1 10 During a random read, the read data is returned, on dcudaurdata, after time Tacc, the random access time, which varies between 3 and 8 ns (see Table ). To avoid any metastability issues the read data must be captured by a flip-flop which is enabled 2 pc/k cycles or 12.5 ns after the DRAM access has been started. The DCU generates the enable signal dcu daurvalid to capture dcu dau rdata. 15 The byte write mask daudcu wmask[31:0] must be expanded to the bit write mask bitwritemask[255:0] needed by the DRAM. 20.14.5 DAU-DCU interface description The DCU asserts dcudauadv in the MSN2 state to indicate to the DAU to supply the next command. dcudauadv causes the DAU to perform arbitration in the MSN2 cycle. The resulting 20 command is available to the DCU in the following cycle, the RST state. The timing is shown in Figure 103. The command to the DRAM must be valid in the RSTand MSN1 states, or at least meet the hold time requirement to the MSN falling edge at the start of the MSN1 state. Note that the DAU issues a valid arbitration result following every dcudauadv pulse. If no unit is requesting DRAM access, then a fall-back refresh request will be issued. When daudcurefresh 25 is asserted the operation is a refresh and daudcuadr, dau_dcurwn and daudcucduwpage are ignored. The DCU generates a second signal, dcudauwadv, which is asserted in the RST state. This indicates to the DAU that it can perform arbitration in advance for non-CPU writes. The reason for performing arbitration in advance for non-CPU writes is explained in 30 Command Multiplexor Sub-block Table 136. Command Multiplexor Sub-block 10 Definition Port name Pins 110 Description Clocks and Resets pclk 1 In System Clock prst-n 1 In System reset, synchronous active low DIU Read Interface to SoPEC Units <unit>_diuradr[21:5] 17 In Read address to DIU 17 bits wide (256-bit aligned word). diu_<unit>_rack 1 Out Acknowledge from DIU that read request has been accepted and new read address can be placed on WO 2004/050369 PCT/AU2003/001616 292 <unit>_diu radr DIU Write Interface to SoPEC Units <unit>_diu wadr[21:5) 17 In Write address to DIU except CPU, SCB, CDU 17 bits wide (256-bit aligned word) cpu diu wadr[21:4]] 22 In CPU Write address to DIU (128-bit aligned address.) cpu-diuwmask 16 In Byte enables for CPU write. cdudiu wadr[21:3] 19 In CDU Write address to DIU 19 bits wide (64-bit aligned word) Addresses cannot cross a 256-bit word DRAM boundary. diu_<unit>_wack 1 Out Acknowledge from DIU that write request has been accepted and new write address can be placed on <unit>_diuwadr Outputs to CPU Interface and Arbitration Logic sub-block rearbitrate 1 Out Signalling telling the arbitration logic to choose the next arbitration winner. rearbitratewadv 1 Out Signal telling the arbitration logic to choose the next arbitration winner for non-CPU writes 2 timeslots in advance Debug Outputs to CPU Configuration and Arbitration Logic Sub-block write sel 5 Out Signal indicating the SoPEC Unit for which the current write transaction is occurring. Encoding is described in Table . write-complete 1 Out Signal indicating that write transaction to SoPEC Unit indi cated by write_sel is complete. Inputs from CPU Interface and Arbitration Logic sub-block arbgnt I In Signal lasting I cycle which indicates arbitration has occurred and arb sel is valid. arb_sel 5 In Signal indicating which requesting SoPEC Unit has won arbitration. Encoding is described in Table . dirsel 2 In Signal indicating which sense of access associated with arb sel 00: issue non-CPU write 01: read winner 10: write winner 11: refresh winner Inputs from Read Write Multiplexor Sub-block writedata_valid 2 In Signal indicating that valid write data is available for the WO 2004/050369 PCT/AU2003/001616 293 current command. 00=not valid 01=CPU write data valid 1 0=non-CPU write data valid 11 =both CPU and non-CPU write data valid data 256 In 256-bit non-CPU write data cpu data 32 In 32-bit CPU write data Outputs to Read Write Multiplexor Sub-block ritedataaccept 2 Out Signal indicating the Command Multiplexor has accepted the write data from the write multiplexor 00=not valid 01 =accepts CPU write data 1 O=accepts non-CPU write data 11 =not valid Inputs from DCU dcu dau adv 1 In Signal indicating to DAU to supply next command to DCU dcudauwadv 1 In Signal indicating to DAU to initiate next non-CPU write Outputs to DCU daudcu adr[21:5] 17 Out Signal indicating the address for the DRAM access. This is a 256-bit aligned DRAM address. daudcurwn 1 Out Signal indicating the direction for the DRAM access (1 =read, 0=write). daudcu-cduwpage 1 Out Signal indicating if access is a CDU write page mode access (1 =CDU page mode, O=not CDU page mode). daudcurefresh 1 Out Signal indicating that a refresh command is to be issued. If asserted daudcuadr, daudcurwn and daudcu_cduwpage are ignored. dau dcu wdata 256 Out 256-bit write data to DCU daudcu_wmask 32 Out Byte encoded write data mask for 256-bit daudcuwdata to DCU The DCU state-machine can stall in the MSN2 state when the signal daudcumsn2stall is asserted by the DAU Arbitration Logic, The states of the DCU state-machine are summarised in Table 127. 5 Table 127. States of the DCU state-machine State Description RST Restore state MSN1 Macro select state 1 WO 2004/050369 PCT/AU2003/001616 294 MSN2 Macro select state 2 20.14.6 DCU state machines The IBM DRAM has a simple SRAM like interface. The DRAM is accessed as a single bank. The state machine to access the DRAM is shown in Figure 104. 5 The signal pagemode adrinc is exported from the DCU as dcu_daucduwaccept. dcudaucduwaccept tells the DAU to supply the next write data to the DRAM 20.14.7 CU-11 DRAM timing diagrams The IBM Cu-11 embedded DRAM datasheet is referenced as [16]. Table 128 shows the timing parameters which must be obeyed for the IBM embedded DRAM. 10 Table 128. 1.5 V Cu-11 DRAM a.c. parameters Symbol Parameter Min Max Units Tset Input setup to MSN/PGN 1 - ns Thid Input hold to MSN/PGN 2 - ns Tace Random access time 3 8 ns Tact MSN active time 8 100k ns Tres MSN restore time 4 - ns Toye Random R/W cycle time 12 - ns Trre Refresh cycle time 12 - ns Taccp Page mode access time 1 3.9 ns Tpa PGN active time 1.6 - ns Tpr PGN restore time 1.6 - ns Tyc PGN cycle time 4 - ns Tmprd MSN to PGN restore delay 6 - ns Tactp MSN active for page mode 12 - ns Tref Refresh period - 3.2 ms Tpamr Page active to MSN restore 4 - ns The IBM DRAM is asynchronous. In SoPEC it interfaces to signals clocked on pc/k. The following timing diagrams show how the timing parameters in Table 129 are satisfied in SoPEC. 20.14.8 Definition of DAU 10 15 Table 129. DAU interface Port Name Pins 1/O Description Clocks and Resets pclk 1 In SoPEC Functional clock prst-n 1 In Active-low, synchronous reset in pclk domain dau dcu reset n 1 Out Active-low, synchronous reset in pc/k domain. This reset signal, exported to the DCU, incorporates the WO 2004/050369 PCT/AU2003/001616 295 locally captured DAU version of hard reset (prst n) and he soft reset configuration register bit "Reset'. CPU Interface cpu.adr 22 In CPU address bus for both DRAM and configuration register access. 9 bits (bits 10:2) are required to decode the configuration register address space. 22 bits can address the DRAM at byte level. DRAM addresses cannot cross a 256-bit word DRAM boundary. cpu-dataout 32 In Shared write data bus from the CPU for DRAM and configuration data diucpu data 32 Out Configuration, status and debug read data bus to the CPU diucpudebugvalid I Out Signal indicating the data on the diucpudata bus is valid debug data. cpurwn 1 In Common read/not-write signal from the CPU cpu acode 2 In CPU access code signals. cpu-acode[0] - Program (0) / Data (1) access cpu-acodel] - User (0) / Supervisor (1) access he DAU will only allow supervisor mode accesses to data space. cpu-diusel 1 In Block select from the CPU. When cpu diesel is high both cpu adr and cpu dataout are valid diu-cpu-rdy 1 Out Ready signal to the CPU. When diu cpurdy is high it indicates the last cycle of the access. For a write cycle this means cpu dataout has been registered by the block and for a read cycle this means the data on diu cpu data is valid. diucpuberr 1 Out Bus error signal to the CPU indicating an invalid access. DIU Read Interface to SoPEC Units <unit>_diu rreq 1 In SoPEC unit requests DRAM read. A read request must be accompanied by a valid read address. <unit>_diuradr[21:5] 17 In Read address to DIU 17 bits wide (256-bit aligned word). Note : "<unit>" refers to non-CPU requesters only. CPU addresses are provided via "cpu-adr". diu <unit>_rack 1 Out cknowledge from DIU that read request has been WO 2004/050369 PCT/AU2003/001616 296 accepted and new read address can be placed on <unit> diu radr diudata 64 Out Data from DIU to SoPEC Units except CPU. First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word third 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word dram cpu data 256 Out 256-bit data from DRAM to CPU. diu_<unit>_rvalid 1 Out Signal from DIU telling SoPEC Unit that valid read data is on the diu data bus DIU Write Interface to SoPEC Units <unit>_diuwreq 1 In SoPEC unit requests DRAM write. A write request must be accompanied by a valid write address. Note : "<unit>" refers to non-CPU requesters only. <unit>_diu_wadr[21:5] 17 In Write address to DIU except CPU, CDU 17 bits wide (256-bit aligned word) Note: "<unit>" refers to non-CPU requesters, excluding the CDU. scbdiu-wmask[7:0] 8 In Byte write enables applicable to a given 64-bit quarter word transferred from the SCB. Note that different mask values are used with each quarter-word. Requirement for the USB host core. diucpu writerdy 1 Out Flag indicating that the CPU posted write buffer is empty. cpu-diuwdatavalid 1 In Write enable for the CPU posted write buffer. Also confirms that the CPU write data, address and mask are valid. cpudiu_wdata 128 In CPU write data which is loaded into the posted write buffer. cpu diu wadr[21:4] 18 In 128-bit aligned CPU write address. cpu-diuwmask[l 5:0] 16 In Byte enables for 128-bit CPU posted write. cdudiu wadr[21:3] 19 In CDU Write address to DIU 19 bits wide (64-bit aligned word) Addresses cannot cross a 256-bit word DRAM boundary. diu_<unit>_wack 1 Out Acknowledge from DIU that write request has been accepted and new write address can be placed on <unit> diu wadr <unit>_.diudata[63:0] 64 In Data from SoPEC Unit to DIU except CPU.
WO 2004/050369 PCT/AU2003/001616 297 First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word Third 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word Note : "<unit>" refers to non-CPU requesters only. <unit>_diu wvalid 1 In Signal from SoPEC Unit indicating that data on <unit>_diu data is valid. Note : "<unit>" refers to non-CPU requesters only. Outputs to DCU dau dcu msn2stall 1 Out Signal indicating from DAU Arbitration Logic which when de-asserted stalls DCU in MSN2 state. daudcu adr[21:5] 17 Out Signal indicating the address for the DRAM access. This is a 256-bit aligned DRAM address. dau dcu rwn 1 Out Signal indicating the direction for the DRAM access (1 =read, 0=write). daudcu-cduwpage I Out Signal indicating if access is a CDU write page mode access (1=CDU page mode, O=not CDU page mode). dau dcu refresh 1 Out Signal indicating that a refresh command is to be issued. If asserted daudcucmdadr, dau dcurwn and daudcucduwpage are ignored. daudcuwdata 256 Out 256-bit write data to DCU daudcuwmask 32 Out Byte-encoded write data mask for 256-bit dau dcu wdata to DCU Polarity: A 1" in a bit field of daudcuwmask means that the corresponding byte in the 256-bit dau dcu wdata is written to DRAM. Inputs from DCU dcudauadv 1 In Signal indicating to DAU to supply next command to DCU dcu dau wadv 1 In Signal indicating to DAU to initiate next non-CPU write dcudaurefreshcomplete 1 In Signal indicating that the DCU has completed a refresh. dcu dau rdata 256 In 256-bit read data from DCU. dcu dau rvalid 1 In Signal indicating valid read data on dcudau rdata. The CPU subsystem bus interface is described in more detail in Section 11.4.3. The DAU block will only allow supervisor-mode accesses to update its configuration registers (i.e. cpuacode[1:0] = b1 1). All other accesses will result in diucpuberr being asserted. 5 20.14.9 DAU Configuration Registers WO 2004/050369 PCT/AU2003/001616 298 Table 130. DAU configuration registers Address Register #bits Reset Description (DIU base +) Reset Ox00 Reset 1 Ox1 A write to this register causes a reset of the DIU. This register can be read to indicate the reset state: 0 - reset in progress 1 - reset not in progress Refresh 0x04 RefreshPeriod 9 0x063 Refresh controller. When set to 0 refresh is off, otherwise the value indicates the number of cycles, less one, between each refresh. [Note that for a system clock frequency of 160MHz, a value exceeding 0x63 (indicating a 100-cycle refresh period) should not be programmed, or the DRAM will malfunction.] Timeslot allocation and control 0x08 NumMainTimeslots 6 Ox01 Number of main timeslots (1-64) less one OxOC CPUPreAccessTime 4 Ox0 (CPUPreAccessTimeslots + 1) main s lots slots out of a total of (CPUTotalTimeslots + 1) are pre ceded by a CPU access. Ox10 CPUTotalTimeslots 4 Ox0 (CPUPreAccessTimeslots + 1) main slots out of a total of (CPUTotalTimeslots + 1) are pre ceded by a CPU access. Ox100-Ox1FC MainTimeslot[63:0) 64x4 [63:1][3:0] Programmable main timeslots (up to = Ox0 64 main timeslots). [0][3:0] = OxE 0x200 ReadRoundRobinLe 12 Ox000 For each read requester plus refresh vel 0 = level of round-robin WO 2004/050369 PCT/AU2003/001616 299 1 = level2 of round-robin The bit order is defined in Table Ox204 EnableCPURound I Ox1 Allows the CPU to particpate in the Robin unused read round-robin scheme. If disabled, the shared CPU/refresh round-robin position is dedicated solely to refresh. Ox208 RotationSync I OxI Writing 0, followed by 1 to this bit allows the timeslot rotation to advance on a cycle basis which can be determined by the CPU. Ox2OC minNonCPUReadAd 12 0x800 12 MSBs of lowest DRAM address r which may be read by non-CPU requesters. Ox210 minDWUWriteAdr 12 0x800 12 MSBs of lowest DRAM address which may be written to by the DWU. Ox214 minNonCPUWriteAd 12 0x800 12 MSBs of lowest DRAM address r which may be written to by non-CPU requesters other than the DWU. Debug 0x300 DebugSelect[1 1:2] 10 0x304 Debug address select. Indicates the address of the register to report on the diucpu_data bus when it is not otherwise being used. When this signal carries debug information the signal diucpudebug valid will be asserted. Debug: arbitration and performance Ox304 ArbitrationHistory 22 - Bit 0 = arb gnt Bit 1 = arb executed Bit 6:2 = arb-sel[4:01 Bit 12:7 = timeslot-number[5:0] Bit 15:13 = accessjtype[2:0] Bit 16 = back2back non cpuwrite Bit 17 = sticky_back2back noncpu write (Sticky version of same, cleared on reset.) Bit 18 = rotation_sync WO 2004/050369 PCT/AU2003/001616 300 Bit 20:19 = rotation-state Bit 21 = stickyinvalid_non_cpuadr See Section 20.14.9.2 DIU Debug for a description of the fields. Read only register. Ox308 DIUPerformance 31 - Bit 0 = cpu-diu-rreq Bit I = scbdiurreq Bit 2 = cdudiurreq Bit 3 = cfudiurreq Bit 4 = lbddiurreq Bit 5 = sfudiurreq Bit 6 = tddiurreq Bit 7 = tfs-diurreq Bit 8 = hcudiurreq Bit 9 = dncdiurreq Bit 10 = Iludiurreq Bit 11 = pcu-diu-rreq Bit 12 = cpu diu-wreq Bit 13 = scb_diu_wreq Bit 14 = cdudiu_wreq Bit 15 = sfudiuwreq Bit 16 = dwudiu_wreq Bit 17 = refresh_req Bit 22:18 = read_sel[4:0] Bit 23 = readcomplete Bit 28:24 = write_sel[4:0] Bit 29 = writecomplete Bit 30 = dcu daurefreshcomplete See Section 20.14.9.2 DIU Debug for a description of the fields. Read only register. Debug DIU read requesters interface signals Ox3OC CPUReadInterface 25 - Bit 0 = cpu-diu-rreq Bit 22:1 = cpuadr[21:01 Bit 23 = diu cpu rack Bit 24 = diu.cpu-rvalid Read only register. Ox310 SCBReadlnterface 20 Bit 0 = scb_diu_rreq Bit 17:1 = scb_diu radr[21:5] Bit 18 = diu scb rack WO 2004/050369 PCT/AU2003/001616 301 Bit 19 = diu scb rvalid Read only register. Ox314 CDURead Interface 20 - Bit 0 = cdudiurreq Bit 17:1 = cdu diu-radr[21:5] Bit 18 = diu cdu rack Bit 19 = diu cdu rvalid Read only register. Ox318 CFUReadInterface 20 - Bit 0 = cfudiurreq Bit 17:1 = cfudiu-radr[21:5] Bit 18 = diu cfu rack Bit 19 = diu cfu rvalid Read only register. Ox3lC LBDReadlnterface 20 - Bit 0 = Ibddiurreq Bit 17:1 = lbddiu-radr[21:5] Bit 18 = diu Ibd rack Bit 19 = diuIbd rvalid Read only register. Ox320 SFUReadInterface 20 - Bit 0 = sfu_diurreq Bit 17:1 = sfudiu-radr[21:5] Bit 18 = diu sfu rack Bit 19 = diu sfu rvalid Read only register. Ox324 TDReadInterface 20 - Bit 0 = tddiu_rreq Bit 17:1 = tddiu-radr[21:5] Bit 18 = diu td rack Bit 19 = diu td rvalid Read only register. Ox328 TFSReadlnterface 20 - Bit 0 = tfsdiurreq Bit 17:1 = Ifsdiu radr[21:5] Bit 18 = diutfsrack Bit 19 = diu tfs rvalid Read only register. 0x32C HCURead Interface 20 - Bit 0 = hcudiurreq Bit 17:1 = hcudiu radr[21:5] Bit 18 = diu hcu rack Bit 19 = diu hcu rvalid Read only register. Ox330 DNCReadInterface 20 - Bit 0 = dncdiurreq Bit 17:1 = dncdiu-radr[21:5] WO 2004/050369 PCT/AU2003/001616 302 Bit 18 = diu dnc rack Bit 19 = diu dnc rvalid Read only register. Ox334 LLU ReadInterface 20 - Bit 0 = lludiu_rreq Bit 17:1 = Iluu diu-radr[21:51 Bit 18 = diu llu rack Bit 19 = diullu rvalid Read only register. Ox338 PCUReadInterface 20 - Bit 0 = pcu-diu-rreq Bit 17:1 = pcu diu radr[21:5 Bit 18 = diupcu rack Bit 19 = diupcu rvalid Read only register. Debug DIU write requesters interface signals 0x33C CPUWritelnterface 27 - Bit 0 = cpudiu-wreq Bit 22:1 = cpuadr[21:0] Bit 24:23 = cpudiu wmask[1:0] Bit 25 = diu-cpu-wack Bit 26 = cpu diu-wvalid Read only register. Ox340 SCBWritelnterface 20 - Bit 0 = scbdiuwreq Bit 17:1 = scbdiu-wadr[21:5] Bit 18 = diu scb-wack Bit 19 = scb diu-wvalid Read only register. Ox344 CDUWritelnterface 22 - Bit 0 = cdudiu_wreq Bit 19:1 = cdudiuwadr[21:3] Bit 20 = diu cdu wack Bit 21 = cdudiu wvalid Read only register. Ox348 SFUWritelnterface 20 - Bit 0 = sfudiuwreq Bit 17:1 = sfudiu-wadr[21:5] Bit 18 = diu sfu-wack Bit 19 = sfu diu wvalid Read only register. Ox34C DWUWriteInterface 20 Bit 0 = dwudiu_wreq Bit 17:1 = dwudiu-wadr[21:5] Bit 18 = diu dwu-wack Bit 19 = dwu diu wvalid WO 2004/050369 PCT/AU2003/001616 303 Read only register. Debug DAU-DCU interface signals 0x350 DAU-DCUlnterface 25 - Bit 16:0 = daudcu-adr[21:5] Bit 17 = dau dcu rwn Bit 18 = daudcu-cduwpage Bit 19 = dau dcu refresh Bit 20 = dau dcu msn2stall Bit 21 = dcu dau adv Bit 22 = dcu dau wadv Bit 23 = dcudaurefreshcomplete Bit 24 = dcu dau rvalid Read only register. Each main timeslot can be assigned a SoPEC DIU requestor according to Table 131. Table 131. SoPEC DIU requester encoding for main timeslots. Name Index (binary) Index (HEX) Write SCB(W) b0_0000 Ox00 CDU(W) bOO01 OxI SFU(W) bOO10 0x2 DWU b0011 0x3 Read SCB(R) b0100 0x4 CDU(R) b01 0x5 CFU bOl10 0x6 LBD bO11 0x7 SFU(R) b1000 Ox8 TE(TD) b1001 0x9 TE(TFS) b1010 OxA HCU b1011 OxB DNC b1100 OxC LLU b1101 OxD PCU b1110 OxE ReadRoundRobinLevel and ReadRoundRobinEnable registers are encoded in the bit order 5 defined in Table 132. Table 132. Read round-robin registers bit order Name Bit index SCB(R) 0 WO 2004/050369 PCT/AU2003/001616 304 CDU(R) 1 CFU 2 LBD 3 SFU(R) 4 TE(TD) 5 TE(TFS) 6 HCU 7 DNC 8 LLU 9 PCU 10 CPU )11 Refresh 20.14.9.1 Configuration register reset state The RefreshPeriod configuration register has a reset value of Ox063 which ensures that a refresh will occur every 100 cycles and the contents of the DRAM will remain valid. The CPUPreAccessTimesiots and CPUTotalTimeslots configuration registers both have a reset 5 value of OxO. Matching values in these two registers means that every slot has a CPU pre-acess. NumMainTimeslots is reset to Ox1, so there are just 2 main timeslots in the rotation initially. These slots alternate between SCB writes and PCU reads, as defined by the reset value of MainTimesot[63:0], thus respecting at reset time the general rule that adjacent non-CPU writes are not permitted. 10 The first access issued by the DIU after reset will be a refresh. 20.14.9.2 DIU Debug External visibility of the DIU must be provided for debug purposes. To facilitate this debug registers are added to the DIU address space. The DIU CPU system data bus diu cpudata[31:0] returns configuration and status register 15 information to the CPU. When a configuration or status register is not being read by the CPU debug data is returned on diucpudata[31:0] instead. An accompanying active high diu_cpu debug valid signal is used to indicate when the data bus contains valid debug data. The DIU features a DebugSelect register that controls a local multiplexor to determine which register is output on diu cpu_data[31:0]. 20 Three kinds of debug information are gathered: a. The order and access type of DIU requesters winning arbitration. This information can be obtained by observing the signals in the ArbitrationHistory debug register at DIU Base+0x304 described in Table 133. Table 133. ArbitrationHistory debug register description, DIUbase+0x304 25 Field name Bits Description arbgnt 1 Signal lasting I cycle which is asserted in the cycle following a main WO 2004/050369 PCT/AU2003/001616 305 arbitration or pre-arbitration. arbexecuted 1 Signal lasting I cycle which indicates that an arbitration result has actually been executed. Is used to differentiate between *pre*-arbitration and *main* arbitration, both of which cause arb_gnt to be asserted. If arbexecuted and arb gnt are both high, then a main (executed) arbitration is indicated. arbsel 5 Signal indicating which requesting SoPEC Unit has won arbitration. Encoding is described in Table . Refresh winning arbitration is indicated by access-type. timeslotnumber 6 Signal indicating which main timeslot is either currently being serviced, or about to be serviced. The latter case applies where a main slot is pre empted by a CPU pre-access or a scheduled refresh. accesstype 3 Signal indicating the origin of the winning arbitration 000 = Standard CPU pre-access. 001 = Scheduled refresh. 010 = Standard non-CPU timeslot. 011 = CPU access via unused read/write slot, re-allocated by round robin. 100 = Non-CPU write via unused write slot, re-allocated at pre arbitration. 101 = Non-CPU read via unused read/write slot, re-allocated by round robin. 110 = Refresh via unused read/write slot, re-allocated by round robin. 111 = CPU / Refresh access due to RotationSync = 0. back2backnonc 1 Instantaneous indicator of attempted illegal back-to-back non-CPU pu write write. (Recall from section 20.7.2.3 on page 212 that the second write of any such pair is disregarded and re-allocated via the unused read round-robin scheme.) stickyback2back_1 Sticky version of same, cleared on reset. non cpu-write rotationsync 1 Current value of the RotationSync configuration bit. rotationstate 2 These bits indicate the current status of pre-arbitation and main timeslot rotation, as a result of the RotationSync setting. 00 = Pre-arb enabled, rotation enabled. 01 = Pre-arb disabled, rotation enabled. 10 = Pre-arb disabled, rotation disabled. 11 = Pre-arb enabled, rotation disabled. 00 is the normal functional setting when RotationSync is 1.
WO 2004/050369 PCT/AU2003/001616 306 01 indicates that pre-arbitration has halted at the end of its rotation because of RotationSync having been cleared. However the main arbitration has yet to finish its current rotation. 10 indicates that both pre-arb and the main rotation have halted, due to RotationSync being 0 and that only CPU accesses and refreshes are allowed. 11 indicates that RotationSync has just been changed from 0 to I and that pre-arbitration is being given a head start to look ahead for non CPU writes, in advance of the main rotation starting up again. stickyinvalid non 1 Sticky bit to indicate an attempted non-CPU access with an invalid cpuadr address. Cleared by reset or by an explicit write by the CPU. Table 134. arbsel, readsel and writesel encoding Name Index (binary) Index (HEX) Write SCB(W) b0_0000 0x00 CDU(W) b0_0001 bx01 SFU(W) b0_0010 0x02 DWU b0_0011 0x03 Read SCB(R) b0_0100 0x04 CDU(R) b0_0101 0x05 CFU b0_0110 0x06 LBD b0 0111 0x07 SFU(R) b0_1000 Ox08 TE(TD) b0_1001 0x09 TE(TFS) b0_1010 OxOA HCU b0_1011 OxOB DNC b0_1100 OxOC LLU b0_1101 OxOD PCU b0_1110 OxOE Refresh Refresh b0_1111 OxOF CPU CPU(R) b1_0000 [0x10 CPU(W) b1_0001 [x1l WO 2004/050369 PCT/AU2003/001616 307 The encoding for arbsel is described in Table 134. b. The time between a DIU requester requesting an access and completing the access. This information can be obtained by observing the signals in the DIUPerformance debug register 5 at DIU_Base+0x308 described in Table 135. The encoding for readsel and writesel is described in Table . The data collected from D/UPerformance can be post-processed to count the number of cycles between a unit requesting DIU access and the access being completed. Table 135. DiUPerformance debug register description, DIU_base+0x308 10 Field name Bits Description <unit>_diu rreq 12 Signal indicating that SoPEC unit requests DRAM read. <unit> diu wreq 5 Signal indicating that SoPEC unit requests DRAM write. refresh req 1 Signal indicating that refresh has requested a DIU access. read sel[4:0] 5 Signal indicating the SoPEC Unit for which the current read transaction is occurring. Encoding is described in Table . read-complete 1 Signal indicating that read transaction to SoPEC Unit indicated by readsel is complete i.e. that the last read data has been output by the DIU. write sel[4:0] 5 Signal indicating the SoPEC Unit for which the current write transaction is occurring. Encoding is described in Table . write-complete 1 Signal indicating that write transaction to SoPEC Unit indicated by write_sel is complete i.e. that the last write data has been transferred to the DIU. dcu_refreshcomplete 1 Signal indicating that refresh has completed. c.Interface signals to DIU requestors and DAU-DCU interface. All interface signals with the exception of data busses at the interfaces between the DAU and DCU and DIU write and read requestors can be monitored in debug mode by observing debug registers DIU_Base+0x314 to DIU_Base+0x354. 15 20.14.10 DRAM Arbitration Unit (DAU) The DAU is shown in Figure 101. The DAU is composed of the following sub-blocks a. CPU Configuration and Arbitration Logic sub-block. b. Command Multiplexor sub-block. 20 c. Read and Write Data Multiplexor sub-block. The function of the DAU is to supply DRAM commands to the DCU. " The DCU requests a command from the DAU by asserting dcudauadv. * The DAU Command Multiplexor requests the Arbitration Logic sub-block to arbitrate the next DRAM access. The Command Multiplexor passes dcudauadv as the rearbitrate 25 signal to the Arbitration Logic sub-block.
WO 2004/050369 PCT/AU2003/001616 308 " If the RotationSync bit has been cleared, then the arbitration logic grants exclusive access to the CPU and scheduled refreshes. If the bit has been set, regular arbitration occurs. A detailed description of RotationSync is given in section 20.14.12.2.1 on page 325. " Until the Arbitration Logic has a valid result it stalls the DCU by asserting 5 daudcumsn2stal. The Arbitration Logic then returns the selected arbitration winner to the Command Multiplexor which issues the command to the DRAM. The Arbitration Logic could stall for example if it selected a shared read bus access but the Read Multiplexor indicated it was busy by de-asserting readcmdrdy[1j. " In the case of a read command the read data from the DRAM is multiplexed back to the 10 read requestor by the Read Multiplexor. In the case of a write operation the Write Multiplexor multiplexes the write data from the selected DIU write requestor to the DCU before the write command can occur. If the write data is not available then the Command Multiplexor will keep daudcuvalid de-asserted. This will stall the DCU until the write command is ready to be issued. 15 * Arbitration for non-CPU writes occurs in advance. The DCU provides a signal dcudauwadv which the Command Multiplexor issues to the Arbitrate Logic as rearbitratewadv. If arbitration is blocked by the Write Multiplexor being busy, as indicated by writecmdrdy[1] being de-asserted, then the Arbitration Logic will stall the DCU by asserting daudcumsn2stall until the Write Multiplexor is ready. 20 20.14.10.1 Read Accesses The timing of a non-CPU DIU read access are shown in Figure 109. Note rearbitrate is asserted in the MSN2 state of the previous access. Note the fixed timing relationship between the read acknowledgment and the first rvalid for all non-CPU reads. This means that the second and any later reads in a back-to-back non-CPU 25 sequence have their acknowledgments asserted one cycle later, i.e. in the "MSN1" DCU state. The timing of a CPU DIU read access is shown in Figure 110. Note rearbitrate is asserted in the MSN2 state of the previous access. Some points can be noted from Figure 109 and Figure 110. DIU requests: 30 * For non-CPU accesses the <unit>_diu rreq signals are registered before the arbitration can occur. * For CPU accesses the cpu diurreq signal is not registered to reduce CPU DIU access latency. Arbitration occurs when the dcu_dauadv signal from the DCU is asserted. The DRAM address 35 for the arbitration winner is available in the next cycle, the RST state of the DCU. The DRAM access starts in the MSNI state of the DCU and completes in the RST state of the DCU. Read data is available: * In the MSN2 cycle where it is output unregistered to the CPU WO 2004/050369 PCT/AU2003/001616 309 * In the MSN2 cycle and registered in the DAU before being output in the next cycle to all other read requestors in order to ease timing. The DIU protocol is in fact: e Pipelined i.e. the following transaction is initiated while the previous transfer is in 5 progress. * Split transaction i.e. the transaction is split into independent address and data transfers. Some general points should be noted in the case of CPU accesses: * Since the CPU request is not registered in the DIU before arbitration, then the CPU must generate the request, route it to the DAU and complete arbitration all in 1 cycle. To facilitate 10 this CPU access is arbitrated late in the arbitration cycle (see Section 20.14.12.2). * Since the CPU read data is not registered in the DAU and CPU read data is available 8 ns after the start of the access then 4.5 ns are available for routing and any shallow logic before the CPU read data is captured by the CPU (see Section 20.14.4). The phases of CPU DIU read access are shown in Figure 111. This matches the timing shown in 15 Table 135. 20.14.10.2 Write Accesses CPU writes are posted into a 1-deep write buffer in the DIU and written to DRAM as shown below in Figure 112. The sequence of events is as follows 20 e [1] The DIU signals that its buffer for CPU posted writes is empty (and has been for some time in the case shown). a [2] The CPU asserts "cpu diu-wdatavalid" to enable a write to the DIU buffer and presents valid address, data and write mask. The CPU considers the write posted and thus complete in the cycle following [2] in the diagram below. 25 9 [3] The DIU stores the address/datalmask in its buffer and indicates to the arbitration logic that a posted write wishes to participate in any upcoming arbitration. 0 [4] Provided the CPU still has a pre-access entitlement left, or is next in line for a round robin award, a slot is arbitrated in favour of the posted write. Note that posted CPU writes have higher arbitration priority than simultaneous CPU reads. 30 * [5] The DRAM write occurs. * [6] The earliest that "diu cpu writerdy" can be re-asserted in the "MSN1" state of the DRAM write. In the same cycle, having seen the re-assertion, the CPU can asynchronously turn around "cpu diuwdatavalid" and enable a subsequent posted write, should it wish to do so. The timing of a non-CPU/non-CDU DIU write access is shown below in Figure 113. 35 Compared to a read access, write data is only available from the requester 4 cycles after the address. An extra cycle is used to ensure that data is first registered in the DAU, before being despatched to DRAM. As a result, writes are pre-arbitrated 5 cycles in advance of the main arbitration decision to actually write the data to memory. The diagram above shows the following sequence of events WO 2004/050369 PCT/AU2003/001616 310 * [1] A non-CPU block signals a write request. e [2] A registered version of this is available to the DAU arbitration logic. * [3] Write pre-arbitration occurs in favour of the requester. e [4] A write acknowledgment is returned by the DIU. 5 e [5] The pre-arbitration will only be upheld if the requester supplies 4 consecutive write data quarter-words, qualified by an asserted wvalid flag. e [6] Provided this has happened, the main arbitration logic is in a position at [6] to reconfirm the pre-arbitration decision. Note however that such reconfirmation may have to wait a further one or two DRAM accesses, if the write is pre-empted by a CPU pre-access and/or 10 a scheduled refresh. e [7] This is the earliest that the write to DRAM can occur. * Note that neither the arbitration at [8] nor the pre-arbitration at [9] can award its respective slot to a non-CPU write, due to the ban on back-to-back accesses. The timing of a CDU DIU write access is shown overleaf in Figure 114. 15 This is simular to a regular non-CPU write access, but uses page mode to carry out 4 consecutive DRAM writes to contiguous addresses. As a consequence, subsequent accesses are delayed by 6 cycles, as shown in the diagram. Note that a new write can be pre-arbitrated at [10] in Figure 114. 20.14.11 Command Multiplexor Sub-block 20 Table 136. Command Multiplexor Sub-block 10 Definition Port name Pins 1/O Description Clocks and Resets pclk 1 In System Clock prst-n 1 in System reset, synchronous active low DIU Read Interface to SoPEC Units <unit>_diuradr[21:5] 17 In Read address to DIU 17 bits wide (256-bit aligned word). diu_<unit>_rack 1 Out Acknowledge from DIU that read request has been accepted and new read address can be placed on <unit> diu radr DIU Write Interface to SoPEC Units <unit>_diuwadr[21:5] 17 In Write address to DIU except CPU, SCB, CDU 17 bits wide (256-bit aligned word) cpu diu-wadr[21:4]] 22 In CPU Write address to DIU (128-bit aligned address.) cpudiu_wmask 16 In Byte enables for CPU write. cdudiu wadr[21:3] 19 In CDU Write address to DIU WO 2004/050369 PCT/AU2003/001616 311 19 bits wide (64-bit aligned word) Addresses cannot cross a 256-bit word DRAM boundary. diu_<unit>_wack 1 Out Acknowledge from DIU that write request has been accepted and new write address can be placed on <unit> diuwadr Outputs to CPU Interface and Arbitration Logic sub-block rearbitrate 1 Out Signalling telling the arbitration logic to choose the next arbitration winner. re arbitrate wadv 1 Out Signal telling the arbitration logic to choose the next arbitration winner for non-CPU writes 2 timeslots in advance Debug Outputs to CPU Configuration and Arbitration Logic Sub-block writesel 5 Out Signal indicating the SoPEC Unit for which the current write transaction is occurring. Encoding is described in Table . write-complete 1 Out Signal indicating that write transaction to SoPEC Unit indi cated by write_sel is complete. Inputs from CPU Interface and Arbitration Logic sub-block arbgnt I In Signal lasting 1 cycle which indicates arbitration has occurred and arb sel is valid. arbsel 5 In Signal indicating which requesting SoPEC Unit has won arbitration. Encoding is described in Table . dirsel 2 In Signal indicating which sense of access associated with arb sel 00: issue non-CPU write 01: read winner 10: write winner 11: refresh winner Inputs from Read Write Multiplexor Sub-block write data valid 2 In Signal indicating that valid write data is available for the current command. 00=not valid 01 =CPU write data valid 10=non-CPU write data valid 11 =both CPU and non-CPU write data valid data 256 In 256-bit non-CPU write data cpu wdata 32 In 32-bit CPU write data Outputs to Read Write Multiplexor Sub-block write data accept 2 Out Signal indicating the Command Multiplexor has accepted WO 2004/050369 PCT/AU2003/001616 312 the write data from the write multiplexor 00=not valid 01 =accepts CPU write data 10=accepts non-CPU write data 11 =not valid Inputs from DCU dcu dau adv 1 In Signal indicating to DAU to supply next command to DCU dcudauwadv 1 In Signal indicating to DAU to initiate next non-CPU write Outputs to DCU daudcu-adr[21:5] 17 Out Signal indicating the address for the DRAM access. This is a 256-bit aligned DRAM address. dau dcu rwn 1 Out Signal indicating the direction for the DRAM access (1 =read, O=write). daudcu-cduwpage 1 Out Signal indicating if access is a CDU write page mode access (1 =CDU page mode, 0=not CDU page mode). dau dcu refresh 1 Out Signal indicating that a refresh command is to be issued. If asserted dau dcu adr, daudcurwn and dau_dcu_cduwpage are ignored. dau dcu wdata 256 Out 256-bit write data to DCU daudcu_wmask 32 Out Byte encoded write data mask for 256-bit daudcuwdata to DCU 20.14.11.1 Command Multiplexor Sub-block Description The Command Multiplexor sub-block issues read, write or refresh commands to the DCU, according to the SoPEC Unit selected for DRAM access by the Arbitration Logic. The Command Multiplexor signals the Arbitration Logic to perform arbitration to select the next SoPEC Unit for 5 DRAM access. It does this by asserting the rearbitrate signal. rearbitrate is asserted when the DCU indicates on dcu dau adv that it needs the next command. The Command Multiplexor is shown in Figure 115. Initially, the issuing of commands is described. Then the additional complexity of handling non CPU write commands arbitrated in advance is introduced. 10 DAU-DCU interface See Section 20.14.5 for a description of the DAU-DCU interface. Generating re-arbitrate The condition for asserting rearbitrate is that the DCU is looking for another command from the DAU. This is indicated by dcudauadv being asserted. 15 re arbitrate = dcudauadv Interface to SoPEC DIU requestors WO 2004/050369 PCT/AU2003/001616 313 When the Command Multiplexor initiates arbitration by asserting rearbitrate to the Arbitration Logic sub-block, the arbitration winner is indicated by the arb sel(4:0J and dir sef[1:0] signals returned from the Arbitration Logic. The validity of these signals is indicated by arb gnt. The encoding of arb sei[4:0] is shown in Table 5 The value of arb sel[4:0] is used to control the steering multiplexor to select the DIU address of the winning arbitration requestor. The arb gnt signal is decoded as an acknowledge, diu_<unit> *ack back to the winning DIU requestor. The timing of these operations is shown in Figure 116. adr[21:0 is the output-of the steering multiplexor controlled by arbse/[4:0. The steering multiplexor can acknowledge DIU requesters in successive cycles. 10 Command Issuing Logic The address presented by the winning SoPEC requestor from the steering multiplexor is presented to the command issuing logic together with arb sel[4:0J and dir sel[1:0]. The command issuing logic translates the winning command into the signals required by the DCU. 15 adr_[21:01, arb sel[4:0] and dir sel1:0] comes from the steering multiplexor. dau dcu adr[21:5] = adr[21:51 dau dcu rwn = (dir sel[1:0] == read) dau_dcu_cduwpage = (arb sel[4:0] == CDU write) 20 dau dcu refresh = (dirsel[1:OJ== refresh) dau dcu valid indicates that a valid command is available to the DCU. For a write command, dau_dcu_valid will not be asserted until there is also valid write data present. This is indicated by the signal writedatavalid[1:0] from the Read Write Data Multiplexor 25 sub-block. For a write command, the data issued to the DCU on daudcuwdata[255:0] is multiplexed from cpuwdata[31:0J and wdata[255:0] depending on whether the write is a CPU or non-CPU write. The write data from the Write Multiplexor for the CDU is available on wdata[63:0]. This data must be issued to the DCU on daudcuwdata[255:0]. wdata[63:0] is copied to each 64-bit word of 30 daudcu wdata[255:0]. dau dcu wdata[255:01 = OxOOOOOOO if (arbseL(4:0J==CPU write) then daudcuwdata[31:0] = cpu-wdata[31:0] 35 elsif (arbse2[40==CDU write)) then dau dcu wdata[63:0] = wdata[63:0] dau dcu wdata[127:64] = wdata[63:0] dau dcu wdata[191:128] = wdata[63:0] dau dcu wdata[255:192] = wdata[63:0] 40 else WO 2004/050369 PCT/AU2003/001616 314 dau dcu wdata(255:0] = wdata[255:0] CPU write masking The CPU write data bus is only 128 bits wide. cpudiu wmask[15:0] indicates how many bytes of 5 that 128 bits should be written. The associated address cpudiu wadr[21:4] is a 128-bit aligned address. The actual DRAM write must be a 256-bit access. The command multiplexor issues the 256-bit DRAM address to the DCU on dau dcu adr[21:5]. cpu diu wadr[4] and cpudiu.wmask[15:0] are used jointly to construct a byte write mask daiu_ dcuwmask[31:0]for this 256-bit write access. 10 CDU write masking The CPU performs four 64-bit word writes to 4 contiguous 256-bit DRAM addresses with the first address specified by cdu diu wadr[21:3]. The write address cdu diu wadr[21:5] is 256-bit aligned with bits cdu-diuwadr[4:3] allowing the 64-bit word to be selected. If these 4 DRAM words lie in the same DRAM row then an efficient access will be obtained. 15 The command multiplexor logic must issue 4 successive accesses to 256-bit DRAM addresses cdu_diuwadr[21:5],+1,+2,+3. daudcu wmask[31:0] indicates which 8 bytes (64-bits) of the 256-bit word are to be written. daudcu wmask[31:0] is calculated using cdu_diu_wadr[4:3] i.e. bits 8*cdudiu wadr[4:3] to 8*(cdu diuwadr[4:3]+1)-1 of daudcuwmask[31:0]are asserted. 20 Arbitrating non-CPU writes in advance In the case of a non-CPU write commands, the write data must be transferred from the SoPEC requester before the write can occur. Arbitration should occur early to allow for any delay for the write data to be transferred to the DRAM. Figure 113 indicates that write data transfer over 64-bit busses will take a further 4 cycles after the 25 address is transferred. The arbitration must therefore occur 4 cycles in advance of arbitration for read accesses, Figure 109 and Figure 110, or for CPU writes Figure 112. Arbitration of CDU write accesses, Figure 114, should take place 1 cycle in advance of arbitration for read and CPU write accesses. To simplify implementation CDU write accesses are arbitrated 4 cycles in advance, similar to other non-CPU writes. 30 The Command Multiplexor generates another version of rearbitrate called rearbitratewadv based on the signal dcudau wadv from the DCU. In the 3 cycle DRAM access dcudau_adv and therefore re arbitrate are asserted in the MSN2 state of the DCU state-machine. dcu dau wadv and therefore rearbitrate_wadv will therefore be asserted in the following RST state, see Figure 117. This matches the timing required for non-CPU writes shown in Figure 113 and Figure 114. 35 rearbitrate wadv causes the Arbitration Logic to perform an arbitration for non CPU in advance. re arbitrate = dcudauadv 40 re arbitrate wadv = dcudauwadv WO 2004/050369 PCT/AU2003/001616 315 If the winner of this arbitration is a non-CPU write then arb gnt is asserted and the arbitration winner is output on arb sel[4:0] and dir sel[1:0]. Otherwise arbgnt is not asserted. Since non-CPU write commands are arbitrated early, the non-CPU command is not issued to the 5 DCU immediately but instead written into an advance command register. if (arb sel(4:0 == non-CPU write) then advancecmd'register[3:0] = arbsel[4:0] advancecmd-register[5:4] = dirsel[1:0] 10 advancecmdregister[27:6] = adr[21:0] If a DCU command is in progress then the arbitration in advance of a non-CPU write command will overwrite the steering multiplexor input to the command issuing logic. The arbitration in advance happens in the DCU MSN1 state. The new command is available at the steering 15 multiplexor in the MSN2 state. The command in progress will have been latched in the DRAM by MSN falling at the start of the MSNI state. Issuing non-CPU write commands The arb.se/[4:0] and dir sel[1:0] values generated by the Arbitration Logic reflect the out of order 20 arbitration sequence. This out of order arbitration sequence is exported to the Read Write Data Multiplexor sub-block. This is so that write data in available in time for the actual write operation to DRAM. Otherwise a latency would be introduced every time a write command is selected. However, the Command Multiplexor must execute the command stream in-order. 25 In-order command execution is achieved by waiting until rearbitrate has advanced to the non CPU write timeslot from which rearbitratewadv has previously issued a non-CPU write written to the advance command register. If rearbitratewadv arbitrates a non-CPU write in advance then within the Arbitration Logic the timeslot is marked to indicate whether a write was issued. 30 When rearbitrate advances to a write timeslot in the Arbitration Logic then one of two actions can occur depending on whether the slot was marked by rearbitratewadv to indicate whether a write was issued or not. * Non-CPU write arbitrated by rearbitrate_wadv If the timeslot has been marked as having issued a write then the arbitration logic responds to 35 re_arbitrate by issuing arbJsel[4:O], dir sel[1:0] and asserting arbgnt as for a normal arbitration but selecting a non-CPU write access. Normally, re_arbitrate does not issue non-CPU write accesses. Non-CPU writes are arbitrated by rearbitrate_wadv. dir sel[1:0] == 00 indicates a non CPU write issued by rearbitrate. The command multiplexor does not write the command into the advance command register as it 40 has already been placed there earlier by rearbitratewadv. Instead, the already present write WO 2004/050369 PCT/AU2003/001616 316 command in the advance command register is issued when writedatavald[1] = 1. Note, that the value of arb sel[4:0] issued by rearbitrate could specify a different write than that in the advance command register since time has advanced. It is always the command in the advance command register that is issued. The steering multiplexor in this case must not issue an acknowledge back 5 to SoPEC requester indicated by the value of arb sel[4:0]. if (dir sel[1:0J == 00) then command_issuinglogic[27:01 advance_cmd register [27:0J 10 else command_issuinglogic [27:0) ]= steeringmultiplexor [27: 0] ack = arbgnt AND NOT (dirsel[1:0] == 00) 15 . Non-CPU write not arbitrated by rearbitratewadv If the timeslot has been marked as not having issued a write, the rearbitrate will use the un-used read timeslot selection to replace the un-used write timeslot with a read timeslot according to Section 20.10.6.2 Unused read timeslots allocation. 20 The mechanism for write timeslot arbitration selects non-CPU writes in advance. But the selected non-CPU write is stored in the Command Multiplexor and issued when the write data is available. This means that even if this timeslot is overwritten by the CPU reprogramming the timeslot before the write command is actually issued to the DRAM, the originally arbitrated non-CPU write will always be correctly issued. 25 Accepting write commands When a write command is issued then write data accept[1:0] is asserted. This tells the Write Multiplexor that the current write data has been accepted by the DRAM and the write multiplexor can receive write data 30 from the next arbitration winner if it is a write. writedata accept[1:0] differentiates between CPU and non-CPU writes. A write command is known to have been issued when re arbitrate wadv to decide on the next command is detected. In the case of CDU writes the DCU will generate a signal dcudau_cduwaccept which tells the Command Multiplexor to issue a writedata accept[1]. This will result in the Write Multiplexor 35 supplying the next CDU write data to the DRAM. writedata_accept [0] = RISING EDGE (rearbitratewadv) AND command issuing logic ( dir sel [1 ==1) WO 2004/050369 PCT/AU2003/001616 317 AND commandis suinglogic (arbsel[4:0]==CPU) writedataaccept[1] = (RISING EDGE(rearbitratewadv) 5 AND commandissuinglogic (dirsel [1] ==1) AND command issuing__logic (arbsel [4 : 01 ==nonCPU)) OR 10 dcu_dau_cduwaccept==i Debug logic output to CPU Configuration and Arbitration Logic sub-block write_sel[4:0] reflects the value of arbse/[4:0] at the command issuing logic. The signal write_complete is asserted when every any bit of writedata-accept[1:0] is asserted. 15 write-complete writedataaccept [0] OR writedata accept [0] write_se[4:0] and write complete are CPU readable from the DIUPerformance and 20 WritePerformance status registers. When write-complete is asserted writesel[4:0] will indicate which write access the DAU has issued. 20.14.12 CPU Configuration and Arbitration Logic Sub-block Table 137. CPU Configuration and Arbitration Logic Sub-block 10 Definition Port name Pins 1/O Description Clocks and Resets Pclk I In Sytem Clock prst-n I In System reset, synchronous active low CPU Interface data and control signals cpu adr[1 0:2] 9 In 9 bits (bits 10:2) are required to decode the configuration register address space. cpu-dataout 32 In Shared write data bus from the CPU for DRAM and configuration data diu-cpu_data 32 Out Configuration, status and debug read data bus to the CPU diucpu debugvalid I Out Signal indicating the data on the diucpudata bus is valid debug data. cpurwn 1 In Common read/not-write signal from the CPU cpu acode 2 in CPU access code signals.
WO 2004/050369 PCT/AU2003/001616 318 cpuacode[0] - Program (0) / Data (1) access cpuacode[1] - User (0) 1 Supervisor (1) access The DAU will only allow supervisor mode accesses to data space. cpu-diusel I In Block select from the CPU. When cpu diesel is high both cpu adr and cpu_dataout are valid diu-cpurdy 1 Out Ready signal to the CPU. When diu cpurdy is high it indicates the last cycle of the access. For a write cycle this means cpudataout has been registered by the block and for a read cycle this means the data on diu cpu data is valid. diu cpuberr 1 Out Bus error signal to the CPU indicating an invalid access. DIU Read Interface to SoPEC Units <unit> diurreq 11 In ]SoPEC unit requests DRAM read. DIU Write Interface to SoPEC Units diucpuwriterdy 1 In Indicator that CPU posted write buffer is empty. <unit>_diu wreq 4 In Non- CPU SoPEC unit requests DRAM write. Inputs from Command Multiplexor sub-block rearbitrate I In Signal telling the arbitration logic to choose the next arbitration winner. re arbitrate wadv 1 In Signal telling the arbitration logic to choose the next arbitration winner for non-CPU writes 2 timeslots in advance Outputs to DCU dau dcu msn2stall I Out Signal indicating from DAU Arbitration Logic which when asserted stalls DCU in MSN2 state. Inputs from Read and Write Multiplexor sub-block readcmd-rdy 2 In Signal indicating that read multiplexor is ready for next read read command. 00=not ready 01 =ready for CPU read 1 0=ready for non-CPU read 11 =ready for both CPU and non-CPU reads writecmd-rdy 2 In Signal indicating that write multiplexor is ready for next write command. 00=not ready 01 =ready for CPU write 1 O=ready for non-CPU write WO 2004/050369 PCT/AU2003/001616 319 11=ready for both CPU and non-CPU write Outputs to other DAU sub-block s arbgnt 1 In Signal lasting 1 cycle which indicates arbitration has occurred and arb se/ is valid. arbsel 5 In Signal indicating which requesting SoPEC Unit has won arbitration. Encoding is described in Table . dirsel 2 In Signal indicating which sense of access associated ith arb se/ 00: issue non-CPU write 01: read winner 10: write winner 11: refresh winner Debug Inputs from Read-Write Multiplexor sub-block readsel 5 In Signal indicating the SoPEC Unit for which the current read transaction is occurring. Encoding is described in Table . readcomplete 1 In Signal indicating that read transaction to SoPEC Unit indicated by read set is complete. Debug Inputs from Command Multiplexor sub-block writesel 5 In Signal indicating the SoPEC Unit for which the current write transaction is occurring. Encoding is described in Table , write complete 1 In Signal indicating that write transaction to SoPEC Unit indicated by write se/ is complete. Debug Inputs from DCU dcudaurefreshcomplete 1 In ignal indicating that the DCU has completed a refresh. Debug Inputs from DAU 10 various n In various DAU 10 signals which can be monitored in derbug mode mod The CPU Interface and Arbitration Logic sub-block is shown in Figure 118. 20.14.12.1 CPU Interface and Configuration Registers Description The CPU Interface and Configuration Registers sub-block provides for the CPU to access DAU 5 specific registers by reading or writing to the DAU address space. The CPU subsystem bus interface is described in more detail in Section 11.4.3. The DAU block will only allow supervisor mode accesses to data space (i.e. cpu acode[1:0] = b1 1). All other accesses will result in diu cpu berr being asserted. The configuration registers described in Section 20.14.9 10 Table 130. DAU configuration registers WO 2004/050369 PCT/AU2003/001616 320 Address Register #bits Reset Description (DIU-base +) Reset Ox00 Reset I OxI A write to this register causes a reset of the DIU. This register can be read to indicate the reset state: 0 - reset in progress I - reset not in progress Refresh Ox04 RefreshPeriod 9 0x063 Refresh controller. When set to 0 refresh is off, otherwise the value indicates the number of cycles, less one, between each refresh. [Note that for a system clock frequency of 160MHz, a value exceeding 0x63 (indicating a 100-cycle refresh period) should not be programmed, or the DRAM will malfunction.] Timeslot allocation and control 0x08 NumMainTimeslots 6 Ox01 Number of main timeslots (1-64) less one OxOC CPUPreAccessTime 4 Ox0 (CPUPreAccessTimes/ots + 1) main s lots slots out of a total of (CPUTotalTimeslots + 1) are pre ceded by a CPU access. Ox1 0 CPUTotalTimeslots 4 Ox0 (CPUPreAccessTimeslots + 1) main slots out of a total of (CPUTotalTimeslots + 1) are pre ceded by a CPU access. Ox10O-Ox1FC MainTimeslot[63:0] 64x4 [63:1][3:0] Programmable main timeslots (up to = Ox0 64 main timeslots). [0][3:0] = OxE 0x200 ReadRoundRobinLe 12 Ox000 For each read requester plus refresh vel 0 = level of round-robin 1 = level2 of round-robin WO 2004/050369 PCT/AU2003/001616 321 The bit order is defined in Table Ox204 EnableCPURound 1 Ox1 Allows the CPU to particpate in the Robin unused read round-robin scheme. If disabled, the shared CPU/refresh round-robin position is dedicated solely to refresh. Ox208 RotationSync 1 OxI Writing 0, followed by 1 to this bit allows the timeslot rotation to advance on a cycle basis which can be determined by the CPU. Ox2OC minNonCPUReadAd 12 0x800 12 MSBs of lowest DRAM address r which may be read by non-CPU requesters. 0x210 minDWUWriteAdr 12 0x800 12 MSBs of lowest DRAM address which may be written to by the DWU. Ox214 minNonCPUWriteAd 12 0x800 12 MSBs of lowest DRAM address r which may be written to by non-CPU requesters other than the DWU. Debug 0x300 DebugSelect[1 1:2] 10 0x304 Debug address select. Indicates the address of the register to report on the diu_cpudata bus when it is not otherwise being used. When this signal carries debug information the signal diu_cpu debug valid will be asserted. Debug: arbitration and performance Ox304 ArbitrationHistory 22 - Bit 0 = arbgnt Bit I = arb executed Bit 6:2 = arb-sel[4:0] Bit 12:7 = timeslot-number[5:0] Bit 15:13 = accesstype[2:0] Bit 16 = back2back non cpuwrite Bit 17 = sticky_back2back noncpuwrite (Sticky version of same, cleared on reset.) Bit 18 = rotation_sync Bit 20:19 = rotation-state WO 2004/050369 PCT/AU2003/001616 322 Bit 21 = stickyinvalidnoncpu adr See Section 20.14.9.2 DIU Debug for a description of the fields. Read only register. Ox308 DIUPerformance 31 - Bit 0 = cpu-diu-rreq Bit 1 = scbdiu_rreq Bit 2 = cdudiurreq Bit 3 = cfudiurreq Bit 4 = lbd_diu_rreq Bit 5 = sfudiu rreq Bit 6 = tddiurreq Bit 7 = tfsdiurreq Bit 8 = hcudiu_rreq Bit 9 = dncdiurreq Bit 10 = Iludiurreq Bit 11 = pcu-diu-rreq Bit 12 = cpu-diu-wreq Bit 13 = scbdiu_wreq Bit 14 = cdudiu_wreq Bit 15 = sfu_diu_wreq Bit 16 = dwu-diu-wreq Bit 17 = refresh_req Bit 22:18 = readse[4:0] Bit 23 = readcomplete Bit 28:24 = write_sel[4:0] Bit 29 = writecomplete Bit 30 = dcudaurefreshcomplete See Section 20.14.9.2 DIU Debug for a description of the fields. Read only register. Debug DIU read requesters interface signals Ox30C CPUReadInterface 25 - Bit 0 = cpu-diu-rreq Bit 22:1 = cpuadr[21:0] Bit 23 = diu cpurack Bit 24 = diu-cpu-rvalid Read only register. Ox310 SCBReadInterface 20 Bit 0 = scbdiurreq Bit 17:1 = scbdiu-radr[21:5] Bit 18 = diu scb rack Bit 19 = diu scb rvalid WO 2004/050369 PCT/AU2003/001616 323 Read only register. Ox314 CDUReadInterface 20 - Bit 0 = cdudiu_rreq Bit 17:1 = cdudiu radr[21:5] Bit 18 = diu cdu rack Bit 19 = diu cdu rvalid Read only register. Ox318 CFUReadInterface 20 - Bit 0 = cfudiu_rreq Bit 17:1 = cfudiu-radr[21:5] Bit 18 = diu cfu rack Bit 19 = diu cfu rvalid Read only register. Ox3lC LBDReadlnterface 20 - Bit 0 = lbd diurreq Bit 17:1 = lbddiu-radr[21:5] Bit 18 = diuIbd rack Bit 19 = diu lbd rvalid Read only register. Ox320 SFUReadlnterface 20 Bit 0 = sfudiurreq Bit 17:1 = sfudiu-radr[21:5] Bit 18 = diu sfu rack Bit 19 = diu sfu rvalid Read only register. Ox324 TDReadinterface 20 Bit 0 = tddiurreq Bit 17:1 = tddiu_radr[21:5] Bit 18 = diu td rack Bit 19 = diu td rvalid Read only register. Ox328 TFSReadinterface 20 Bit 0 = tfsdiu_rreq Bit 17:1 = tfsdiu-radr[21:5] Bit 18 = diu tfs rack Bit 19 = diu tfs rvalid Read only register, Ox32C HCUReadInterface 20 Bit 0 = hcudiurreq Bit 17:1 = hcudiuradr[21:5] Bit 18 = diu hcu rack Bit 19 = diu hcu rvalid Read only register. Ox330 DNCReadInterface 20 Bit 0 = dncdiurreq Bit 17:1 = dnc_diu-radr[21:5] Bit 18 = diu dnc rack WO 2004/050369 PCT/AU2003/001616 324 Bit 19 = diu dnc rvalid Read only register. Ox334 LLUReadInterface 20 - Bit 0 = llu_diurreq Bit 17:1 = Iluudiu radr[21:5] Bit 18 = diuIlu rack Bit 19 = diulIlu rvalid Read only register. Ox338 PCUReadInterface 20 - Bit 0 = pcu-diujrreq Bit 17:1 = pcudiu radr[21:51 Bit 18 = diupcu rack Bit 19 = diupcu rvalid Read only register. Debug DIU write requesters interface signals 0x33C CPUWritelnterface 27 - Bit 0 = cpu diu-wreq Bit 22:1 = cpu_adr[21:0] Bit 24:23 = cpudiu wmask[1:0] Bit 25 = diu-cpuwack Bit 26 = cpu-diu-wvalid Read only register. Ox340 SCBWritelnterface 20 - Bit 0 = scb_diu_wreq Bit 17:1 = scbdiu wadr[21:5] Bit 18 = diu scb wack Bit 19 = scb diu wvalid Read only register. Ox344 CDUWriteinterface 22 - Bit 0 = cdu_diu_wreq Bit 19:1 = cdudiu wadr[21:3] Bit 20 = diu cdu wack Bit 21 = cdudiu wvalid Read only register. Ox348 SFUWritelnterface 20 - Bit 0 = sfu diu_wreq Bit 17:1 = sfu _diu-wadr[21:5] Bit 18 = diu sfu wack Bit 19 = sfu diu wvalid Read only register. Ox34C DWUWritelnterface 20 - Bit 0 = dwu_diuwreq Bit 17:1 = dwu_diu-wadr[21:5] Bit 18 = diu dwu-wack Bit 19 = dwu diu wvalid Read only register.
WO 2004/050369 PCT/AU2003/001616 325 Debug DAU-DCU interface signals 0x350 DAU-DCUlnterface 25 - Bit 16:0 = daudcu adr[21:5] Bit 17 = daudcurwn Bit 18 = daudcu-cduwpage Bit 19 = dau dcu refresh Bit 20 = dau dcu msn2stall Bit 21 = dcu dau adv Bit 22 = dcu dau wadv Bit 23 = dcudau refreshcomplete Bit 24 = dcu dau rvalid Read only register. are implemented here. 20.14.12.2 Arbitration Logic Description Arbitration is triggered by the signal re arbitrate from the Command Multiplexor sub-block with the signal arbgnt indicating that arbitration has occurred and the arbitration winner is indicated by 5 arbsel[4:0]. The encoding of arb sel[4:0] is shown in Table . The signal dir sel[1:0J indicates if the arbitration winner is a read, write or refresh. Arbitration should complete within one clock cycle so arbgnt is normally asserted the clock cycle after rearbitrate and stays high for 1 clock cycle. arbsel[4:0] and dir sel[1:0] remain persistent until arbitration occurs again. The arbitration timing is shown in Figure 119. 10 20.14.12.2.1 Rotation Synchronisation A configuration bit, RotationSync, is used to initialise advancement through the timeslot rotation, in order that the CPU will know, on a cycle basis, which timeslot is being arbitrated. This is essential for debug purposes, so that exact arbitration sequences can be reproduced. In general, if RotationSync is set, slots continue to be arbitrated in the regular order specified by 15 the timeslot rotation. When the bit is cleared, the current rotation continues until the slot pointers for pre- and main arbitration reach zero. The arbitration logic then grants DRAM access exclusively to the CPU and refreshes. When the CPU again writes to RotationSync to cause a 0-to-1 transition of the bit, the rdy acknowledgment back to the CPU for this write will be exactly coincident with the RST cycle of the 20 initial refresh which heralds the enabling of a new rotation. This refresh, along with the second access which can be either a CPU pre-access or a refresh, (depending on the CPU's request inputs), form a 2-access "preamble" before the first non-CPU requester in the new rotation can be serviced. This preamble is necessary to give the write pre-arbitration the necessary head start on the main arbitration, so that write data can be loaded in time. See Figure 105 below. The same 25 preamble procedure is followed when emerging from reset. The alignment of rdy with the commencement of the rotation ensures that the CPU is always able to calculate at any point how far a rotation has progressed. RotationSync has a reset value of I to ensure that the default power-up rotation can take place.
WO 2004/050369 PCT/AU2003/001616 326 Note that any CPU writes to the DIU's other configuration registers should only be made when RotationSync is cleared. This ensures that accesses by non-CPU requesters to DRAM are not affected by partial configuration updates which have yet to be completed. 20.14.12.2.2 Motivation for Rotation Synchronisation 5 The motivation for this feature is that communications with SoPEC from external sources are synchronised to the internal clock of our position within a DIU full timeslot rotation. This means that if an external source told SOPEC to start a print 3 separate times, it would likely be at three different points within a full DIU rotation. This difference means that the DIU arbitration for each of the runs would be different, which would manifest itself externally as anomalous or inconsistent 10 print performance. The lack of reproducibility is the problem here. However, if in response to the external source saying to start the print, we caused the internal to pass through a known state at a fixed time offset to other internal actions, this would result in reproducible prints. So, the plan is that the software would do a rotation synchronise action, then writes "Go" into various PEP units to cause the prints. This means the DIU state will be the 15 identical with respect to the PEP units state between separate runs. 20.14.12.2.3 Wind-down Protocol when Rotation Synchronisation is Initiated When a zero is written to "RotationSync", this initiates a "wind-down protocol" in the DIU, in which any rotation already begun must be fully completed. The protocol implements the following sequence: 20 * The pre-arbitration logic must reach the end of whatever rotation it is on and stop pre arbitrating. * Only when this has happened, does the main arbitration consider doing likewise with its current rotation. Note that the main arbitration lags the pre-arbitration by at least 2 DRAM accesses, subject to variation by CPU pre-accesses and/or scheduled refreshes, so that the 25 two arbitration processes are sometimes on different rotations. 0 Once the main arbitration has reached the end of its rotation, rotation synchronisation is considered to be fully activated. Arbitration then proceeds as outlined in the next section. 20.14.12.2.4 Arbitration during Rotation Synchronisation Note that when RotationSync is '0' and, assuming the terminating rotation has completely drained 30 out, then DRAM arbitration is granted according to the following fixed priority order Scheduled Refresh -> CPU(W) -> CPU(R) -> Default Refresh. CPU pre-access counters play no part in arbitration during this period. It is only subsequently, when emerging from rotation sync, that they are reloaded with the values of CPUPreAccessTimeslots and CPUTotalTimeslots and normal service resumes. 35 20.14.12.2.5 Timeslot-based arbitration Timeslot-based arbitration works by having a pointer point to the current timeslot. This is shown in Figure 95 repeated here as Figure 121. When re-arbitration is signaled the arbitration winner is the current timeslot and the pointer advances to the next timeslot. Each timeslot denotes a single access. The duration of the timeslot depends on the access.
WO 2004/050369 PCT/AU2003/001616 327 If the SoPEC Unit assigned to the current timeslot is not requesting then the unused timeslot arbitration mechanism outlined in Section 20.10.6 is used to select the arbitration winner. Note that this unused slot re-allocation is guaranteed to produce a result, because of the inclusion of refresh in the round-robin scheme. 5 Pseudo-code to represent arbitration is given below: if re arbitrate 1 then arb_gnt = 1 10 if current timeslot requesting then choose(arb sel, dir sel) at current timeslot else // un-used timeslot scheme choose winner according to un-used 15 timeslot allocation of Section 20.10.6 arb_gnt = 0 20.14.12.3 Arbitrating non-CPU writes in advance In the case of a non-CPU write commands, the write data must be transferred from the SoPEC requester before the write can occur. Arbitration should occur early to allow for any delay for the 20 write data to be transferred to the DRAM. Figure 113 indicates that write data transfer over 64-bit busses will take a further 4 cycles after the address is transferred. The arbitration must therefore occur 4 cycles in advance of arbitration for read accesses, Figure 109 and Figure 110, or for CPU writes Figure 112. Arbitration of CDU write accesses, Figure 114, should take place 1 cycle in advance of arbitration for read and CPU write 25 accesses. To simplify implementation CDU write accesses are arbitrated 4 cycles in advance, similar to other non-CPU writes. The Command Multiplexor generates a second arbitration signal rearbitratewadv which initiates the arbitration in advance of non-CPU write accesses. The timeslot scheme is then modified to have 2 separate pointers: 30 . rearbitrate can arbitrate read, refresh and CPU read and write accesses according to the position of the current timeslot pointer. * rearbitratewadv can arbitrate only non-CPU write accesses according to the position of the write lookahead pointer. Pseudo-code to represent arbitration is given below: 35 //re arbitrate if (rearbitrate == 1) AND (current timeslot pointer!= non CPU write) then arbgnt = 1 40 if current timesiot requesting then WO 2004/050369 PCT/AU2003/001616 328 choose (arbsel, dirsel) at current timeslot else // un-used read timeslot scheme choose winner according to un-used read timeslot allocation of Section 20.10.6.2 5 If the SoPEC Unit assigned to the current timeslot is not requesting then the unused read timeslot arbitration mechanism outlined in Section 20.10.6.2 is used to select the arbitration winner. //rearbitrate_wadv if (re arbitrate wadv == 1) AND (write lookahead timeslot 10 pointer == non-CPU write) then if write lookahead timeslot requesting then choose(arb sel, dir sel) at write lookahead timeslot arbgnt = 1 elsif un-used write timeslot scheme has a requestor 15 choose winner according to un-used write timeslot allocation of Section 20.10.6.1 arbgnt = 1 else //no arbitration winner 20 arbgnt = 0 rearbitrate is generated in the MSN2 state of the DCU state-machine, whereas rearbitratewadv is generated in the RST state. See Figure 103. The write lookahead pointer points two timeslots in advance of the current timeslot pointer. 25 Therefore rearbitratewadv causes the Arbitration Logic to perform an arbitration for non-CPU two timeslots in advance. As noted in Table , each timeslot lasts at least 3 cycles. Therefor rearbitratewadv arbitrates at least 4 cycles in advance. At initialisation, the write lookahead pointer points to the first timeslot. The current timeslot pointer is invalid until the write lookahead pointer advances to the third timeslot when the current timeslot 30 pointer will point to the first timeslot. Then both pointers advance in tandem. Some accesses can be preceded by a CPU access as in Table . These CPU accesses are not allocated timeslots. If this is the case the timeslot will last 3 (CPU access) + 3 (non-CPU access) = 6 cycles. In that case, a second write lookahead pointer, the CPU pre-access write lookahead pointer, is selected which points only one timeslot in advance. rearbitratewadv will still arbitrate 35 4 cycles in advance. 20.14.12.3.1 Issuing non-CPU write commands Although the Arbitration Logic will arbitrate non-CPU writes in advance, the Command Multiplexor must issue all accesses in the timeslot order. This is achieved as follows: If rearbitrate_ wadv arbitrates a non-CPU write in advance then within the Arbitration Logic the 40 timeslot is marked to indicate whether a write was issued.
WO 2004/050369 PCT/AU2003/001616 329 //re arbitrate wadv if (re arbitrate wadv == 1) AND (write lookahead timeslot pointer == non-CPU write) then 5 if write lookahead timeslot requesting then choose(arbsel, dirsel) at write lookahead timeslot arbgnt = 1 MARK timeslot = 1 elsif un-used write timeslot scheme has a requestor 10 choose winner according to un-used write timeslot allocation of Section 20.10.6.1 arb-gnt = 1 MARK timeslot = 1 else 15 //no pre-arbitration winner arb-gnt = 0 MARK timeslot = 0 When rearbitrate advances to a write timeslot in the Arbitration Logic then one of two actions can occur depending on whether the slot was marked by re_arbitratewadv to indicate whether a write 20 was issued or not. * Non-CPU write arbitrated by rearbitrate_wadv If the timeslot has been marked as having issued a write then the arbitration logic responds to re_arbitrate by issuing arb se[4:0], dirsel[1:0] and asserting arb gnt as for a normal arbitration but selecting a non-CPU write access. Normally, rearbitrate does not issue non-CPU write 25 accesses. Non-CPU writes are arbitrated by rearbitrate_wadv. dir sel[1:0] == 00 indicates a non CPU write issued by rearbitrate. * Non-CPU write not arbitrated by rearbitratewadv If the timeslot has been marked as not having issued a write, the rearbitrate will use the un-used 30 read timeslot selection to replace the un-used write timeslot with a read timeslot according to Section 20.10.6.2 Unused read timeslots allocation. //re_arbitrate except for non-CPU writes if (rearbitrate == 1) AND (current timeslot pointer!= non 35 CPU write) then arb-gnt = 1 if current timeslot requesting then choose(arb sel, dir sel) at current timeslot else // un-used read timeslot scheme WO 2004/050369 PCT/AU2003/001616 330 choose winner according to un-used read timeslot allocation of Section 20.10.6.2 arbgnt = 1 5 //non-CPU write MARKED as issued elsif (re arbitrate == 1) AND (current timeslot pointer == non-CPU write) AND (MARK timeslot == 1) then //indicate to Command Multiplexor that non-CPU write 10 has been arbitrated in //advance arb-gnt = 1 dir sel[1:0] == 00 15 //non-CPU write not MARKED as issued elsif (rearbitrate == 1) AND (current timeslot pointer == non-CPU write) AND (MARK timeslot == 0) then choose winner according to un-used read timeslot 20 allocation of Section 20.10.6.2 arb-gnt = 1 20.14.12.4 Flow control If read commands are to win arbitration, the Read Multiplexor must be ready to accept the read 25 data from the DRAM. This is indicated by the readcmd rdy[1:0] signal. read cmd rdy[1:0] supplies flow control from the Read Multiplexor. readcmd-rdy[O]==1 //Read multiplexor ready for CPU read 30 read_cmdrdy[1]==1 //Read multiplexor ready for non-CPU read The Read Multiplexor will normally always accept CPU reads, see Section 20.14.13.1, so readcmdrdy[Of=1 should always apply. 35 Similarly, if write commands are to win arbitration, the Write Multiplexor must be ready to accept the write data from the winning SoPEC requestor. This is indicated by the writecmd_rdy[1:0] signal. writecmd rdy[1:0} supplies flow control from the Write Multiplexor. write cmd rdy[0]==l //Write multiplexor ready for CPU 40 write WO 2004/050369 PCT/AU2003/001616 331 writecmdrdy[1]==1 //Write multiplexor ready for non CPU write The Write Multiplexor will normally always accept CPU writes, see Section 20.14.13.2, so 5 write_cmdrdy[0]==1 should always apply. Non-CPU read flow control If rearbitrate selects an access then the signal daujdcumsn2stais asserted until the Read Write Multiplexor is ready. 10 arbgnt is not asserted until the Read Write Multiplexor is ready. This mechanism will stall the DCU access to the DRAM until the Read Write Multiplexor is ready to accept the next data from the DRAM in the case of a read. //other access flow control 15 dau dcu msn2stall = (((re arbitrate selects CPU read) AND read cmd rdy[0]==0) OR (re arbitrate selects non-CPU read) AND readcmdrdy [1] ==0)) arb-gnt not asserted until daudcumsn2stall de-asserts 20 20.14.12.5 Arbitration Hierarchy CPU and refresh are not included in the timeslot allocations defined in the DAU configuration registers of Table . The hierarchy of arbitration under normal operation is 25 a. CPU access b. Refresh access c. Timeslot access. This is shown in Figure 124. The first DRAM access issued after reset must be a refresh. As shown in Figure 118, the DIU request signals <unit>_diu rreq, <unit>_diu wreq are registered 30 at the input of the arbitration block to ease timing. The exceptions are the refresh req signal, which is generated locally in the sub-block and cpudiurreq. The CPU read request signal is not registered so as to keep CPU DIU read access latency to a minimum. Since CPU writes are posted, cpudiuwreq is registered so that the DAU can process the write at a later juncture. The arbitration logic is coded to perform arbitration of non-CPU requests first and then to gate the 35 result with the CPU requests. In this way the CPU can make the requests available late in the arbitration cycle. Note that when RotationSync is set to '0', a modified hierarchy of arbitration is used. This is outlined in section 20.14.12.2.3 on page 280. 20.14.12.6 Timeslot access WO 2004/050369 PCT/AU2003/001616 332 The basic timeslot arbitration is based on the Main Timeslot configuration registers. Arbitration works by the timeslot pointed to by either the current or write lookahead pointer winning arbitration. The pointers then advance to the next timeslot. This was shown in Figure 90. Each main timeslot pointer gets advanced each time it is accessed regardless of whether the slot 5 is used. 20.14.12.7 Unused timeslot allocation If an assigned slot is not used (because its corresponding SoPEC Unit is not requesting) then it is reassigned according to the scheme described in Section 20.10.6. Only used non-CPU accesses are reallocated. CDU write accesses cannot be included in the 10 unused timeslot allocation for write as CDU accesses take 6 cycles. The write accesses which the CDU write could otherwise replace require only 3 or 4 cycles. Unused write accesses are re-allocated according to the fixed priority scheme of Table . Unused read timeslots are re-allocated according to the two-level round-robin scheme described in Section 20.10.6.2. 15 A pointer points to the most recently re-allocated unit in each of the round-robin levels. If the unit immediately succedling the pointer is requesting, then this unit wins the arbitration and the pointer is advanced to reflect the new winner. If this is not the case, then the subsequent units (wrapping back eventually to the pointed unit) in the level 1 round-robin are examined. When a requesting unit is found this unit wins the arbitration and the pointer is adjusted. If no unit is requesting then 20 the pointer does not advance and the second level of round-robin is examined in a similar fashion. In the following pseudo-code the bit indices are for the ReadRoundRobinLevel configuration register described in Table //choose the winning arbitration level 25 level = 0 level2 = 0 for i = 0 to 11 if unit (i) requesting AND ReadRoundRobinLevel (i) = 0 then 30 level = 1 if unit (i) requesting AND ReadRoundRobinLevel (i) = 1 then level = 1 35 Round-robin arbitration is effectively a priority assignment with the units assigned a priority according to the round-robin order of Table but starting at the unit currently pointed to. //levelptr is pointer of selected round robin level priority is array 0 to 11 // index 0 is SCBR(O) etc. 40 from Table WO 2004/050369 PCT/AU2003/001616 333 //assign decreasing priorities from the current pointer; maximum priority is 11 for i = 1 to 12 5 priority(levelptr + i) = 12 - i i++ The arbitration winner is the one with the highest priority provided it is requesting and its ReadRoundRobinLevel bit points to the chosen level. The Ievelptr is advanced to the arbitration 10 winner. The priority comparison can be done in the hierarchical manner shown in Figure 125. 20.14.12.8 How Non-CPU Address Restrictions Affect Arbitration Recall from Table "DAU configuration registers," on page288, " DAU configuration registers," on page 298 that there are minimum valid DRAM addresses for non-CPU accesses, defined by 15 minNonCPUReadAdr, minDWUWriteAdr and minNonCPUWriteAdr. Similarly, a non-CPU requester may not try to access a location above the high memory mark. To ensure compliance with these address restrictions, the following DIU response occurs for any incorrectly addressed non-CPU writes : * Issue a write acknowledgment at pre-arbitration time, to prevent the write requester from 20 hanging. * Disregard the incoming write data and write valids and void the pre-arbitration. * Subsequently re-allocate the write slot at main arbitration time via the round robin. For any incorrectly addressed non-CPU reads, the response is : * Arbitrate the slot in favour of the scheduled, misbehaving requester. 25 Issue the read acknowledgement and rvalids to keep the requester from hanging. a Intercept the read data coming from the DCU and send back all zeros instead. If an invalidly addressed non-CPU access is attempted, then a sticky bit, sticky invalidnoncpuadr, is set in the ArbitrationHistory configuration register. See Table n page293 on page 304 for details. 30 20.14.12.9 Refresh Controller Description The refresh controller implements the functionality described in detail in Section 20.10.5. Refresh is not included in the timeslot allocations. CPU and refresh have priority over other accesses. If the refresh controller is requesting i.e. refresh req is asserted, then the refresh request will win any arbitration initiated by rearbitrate. 35 When the refresh has won the arbitration refresh req is de-asserted. The refresh counter is reset to RefreshPeriod[8:0] i.e. the number of cycles between each refresh. Every time this counter decrements to 0, a refresh is issued by asserting refresh req. The counter immediately reloads with the value in RefreshPeriod[8:0] and continues its countdown. It does not wait for an acknowledgment, since the priority of a refresh request supersedes that of any 40 pending non-CPU access and it will be serviced immediately. In this way, a refresh request is WO 2004/050369 PCT/AU2003/001616 334 guaranteed to occur every (RefreshPeriod[8:0] + 1) cycles. A given refresh request may incur some incidental delay in being serviced, due to alignment with DRAM accesses and the possibility of a higher-priority CPU pre-access. Refresh is also included in the unused read and write timeslot allocation, having second option on 5 awards to a round-robin position shared with the CPU. A refresh issued as a result of an unused timeslot allocation also causes the refresh counter to reload with the value in RefreshPeriod[8:0]. The first access issued by the DAU after reset must be a refresh. This assures that refreshes for all DRAM words fall within the required~3.2ms window. 10 //issue a refresh request if counter reaches 0 or at reset or for re-allocated slot if RefreshPeriod != 0 AND (refresh cnt == 0 OR diu soft reset n == 0 OR prstn ==0 OR 15 unused timeslot allocation == 1) then refresh req = 1 //de-assert refresh request when refresh acked else if refresh ack == 1 then refresh req = 0 20 //refresh counter if refreshcnt == 0 OR diusoftresetn == 0 OR prstn ==0 OR unused timeslot allocation == 1 then 25 refresh cnt = RefreshPeriod else refresh cnt = refresh cnt - 1 30 Refresh can preceded by a CPU access in the same way as any other access. This is controlled by the CPUPreAccessTimeslots and CPUTotalTimeslots configuration registers. Refresh will therefore not affect CPU performance. A sequence of accesses including refresh might therefore be CPU, refresh, CPU, actual timeslot. 20.14.12.10 CPU Timeslot Controller Description 35 CPU accesses have priority over all other accesses.CPU access is not included in the timeslot allocations. CPU access is controlled by the CPUPreAccessTimeslots and CPUTotalTimeslots configuration registers. To avoid the CPU having to wait for its next timeslot it is desirable to have a mechanism for ensuring that the CPU always gets the next available timeslot without incurring any latency on the 40 non-CPU timeslots.
WO 2004/050369 PCT/AU2003/001616 335 This is be done by defining each timeslot as consisting of a CPU access preceding a non-CPU access. Two counters of 4-bits each are defined allowing the CPU to get a maximum of (CPUPreAccessTimeslots + 1) pre-accesses out of a total of (CPUTotalTimeslots + 1) main slots. A timesiot counter starts at CPUTotalTimeslots and decrements every timeslot, while another 5 counter starts at CPUPreAccessTimeslots and decrements every timeslot in which the CPU uses its access. If the pre-access entitlement is used up before (CPUTota/Timeslots +1) slots, no further CPU accesses are allowed. When the CPUTotalTimeslots counter reaches zero both counters are reset to their respective initial values. When CPUPreAccessTimeslots is set to zero then only one pre-access will occur during every 10 (CPUTotalTimeslots + 1) slots. 20.14.12.10.1 Conserving CPU Pre-Accesses In section 20.10.6.2.1 on page 278, it is described how the CPU can be allowed participate in the unused read round-robin scheme. When enabled by the configuration bit Enable CPURoundRobin, the CPU shares a joint position in the round robin with refresh. In this 15 case, the CPU has priority, ahead of refresh, in availing of any unused slot awarded to this position. Such CPU round-robin accesses do not count towards depleting the CPU's quota of pre accesses, specified by CPUPreAccessTimesots. Note that in order to conserve these pre accesses, the arbitration logic, when faced with the choice of servicing a CPU request either by a 20 pre-access or by an immediately following unused read slot which the CPU is poised to win, will opt for the latter. 20.14.13 Read and Write Data Multiplexor sub-block Table 138. Read and Write Multiplexor Sub-block IO Definition Port name Pins 1/O Description Clocks and Resets Pclk 1 In System Clock prstn 1 In I System reset, synchronous active low DIU Read Interface to SoPEC Units diudata 64 Out Data from DIU to SoPEC Units except CPU. First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word Third 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word dram cpu data 256 Out 256-bit data from DRAM to CPU. diu_<unit>_rvalid 1 Out Signal from DIU telling SoPEC Unit that valid read data is on the diu data bus DIU Write Interface to SoPEC Units <unit>_diudata 64 In Data from SoPEC Unit to DIU except CPU.
WO 2004/050369 PCT/AU2003/001616 336 First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word Third 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word cpudiuwdatat 128 In Write data from CPU to DIU. <unit>_diu wvalid 1 in Signal from SoPEC Unit indicating that data on <unit>_diudata is valid. Note that "unit" refers to non-CPU requesters only. cpu-diuwdatavalid 1 In Write enable for the CPU posted write buffer. Also confirms the validity of cpu-diuwdata. diucpu-writerdy 1 Out Indicator that the CPU posted write buffer is empty. Inputs from CPU Configuration and Arbitration Logic Sub-block arb_gnt 1 In Signal lasting 1 cycle which indicates arbitration has occurred and arb sel is valid. arbsel 5 In Signal indicating which requesting SoPEC Unit has won arbitration. Encoding is described in Table dirsel 2 In Signal indicating which sense of access associated with arb sel 00: issue non-CPU write 01: read winner 10: write winner 11: refresh winner Outputs to Command Multiplexor Sub-block write datavalid 2 Out Signal indicating that valid write data is available for the current command. 00=not valid 01 =CPU write data valid 10=non-CPU write data valid 11 =both CPU and non-CPU write data valid data 256 Out 256-bit non-CPU write data cpu-wdata 32 Out 32-bit CPU write data Inputs from Command Multiplexor Sub-block writedataaccept 2 In Signal indicating the Command Multiplexor has accepted the write data from the write multiplexor 00=not valid 01=accepts CPU write data I 0=accepts non-CPU write data 11 =not valid Inputs from DCU WO 2004/050369 PCT/AU2003/001616 337 dcu dau rdata 256 fIn 256-bit read data from DCU. dcu dau rvalid 1 In Signal indicating valid read data on dcu dau rdata. Outputs to CPU Configuration and Arbitration Logic Sub-block read cmd rdy 2 Out Signal indicating that read multiplexor is ready for next read read command. 00=not ready 01=ready for CPU read I O=ready for non-CPU read 11 =ready for both CPU and non-CPU reads write cmd-rdy 2 Out Signal indicating that write multiplexor is ready for next write command. 00=not ready 01 =ready for CPU write 1 O=ready for non-CPU write 11 =ready for both CPU and non-CPU writes Debug Outputs to CPU Configuration and Arbitration Logic Sub-block readsel 5 Out Signal indicating the SoPEC Unit for which the current read transaction is occurring. Encoding is described in Table . read-complete 1 Out Signal indicating that read transaction to SoPEC Unit indicated I I_ Ijby readsel is complete. 20.14.13.1 Read Multiplexor logic description The Read Multiplexor has 2 read channels a separate read bus for the CPU, dram-cpudata[255:0]. 5 . and a shared read bus for the rest of SoPEC, diu-data[63:0]. The validity of data on the data busses is indicated by signals diu <unit>_rvalid. Timing waveforms for non-CPU and CPU DIU read accesses are shown in Figure 90 and Figure 91, respectively. The Read Multiplexor timing is shown in Figure 127. Figure 127 shows both CPU and non-CPU 10 reads. Both CPU and non-CPU channels are independent i.e. data can be output on the CPU read bus while non-CPU data is being transmitted in 4 cycles over the shared 64-bit read bus. CPU read data, dramcpu data[255:0], is available in the same cycle as output from the DCU. CPU read data needs to be registered immediately on entering the CPU by a flip-flop enabled by the diu cpurvalid signal. 15 To ease timing, non-CPU read data from the DCU is first registered in the Read Multiplexor by capturing it in the shared read data buffer of Figure 126 enabled by the dcudaurvalid signal. The data is then partitioned in 64-bit words on diu_data[63:0]. 20.14.13.1.1 Non-CPU Read Data Coherency Note that for data coherency reasons, a non-CPU read will always result in read data being 20 returned to the requester which includes the after-effects of any pending (i.e. pre-arbitrated, but WO 2004/050369 PCT/AU2003/001616 338 not yet executed) non-CPU write to the same address, which is currently cached in the non-CPU write buffer. This is shown graphically in Figure n page319 on page Error! Bookmark not defined.. Should the pending write be partially masked, then the read data returned must take account of 5 that mask. Pending, masked writes by the CDU and SCB, as well as all unmasked non-CPU writes are fully supported. Since CPU writes are dealt with on a dedicated write channel, no attempt is made to implement coherency between posted, unexecuted CPU writes and non-CPU reads to the same address. 20.14.13.1.2 Read multiplexor command queue 10 When the Arbitration Logic sub-block issues a read command the associated value of arbse[4:0], which indicates which SoPEC Unit has won arbitration, is written into a buffer, the read command queue. writeen = arb-gnt AND dirsel[1:01=="01" 15 if write en==1 then WRITE arb sel into read command queue The encoding of arb se/[4:0] is given in Table .dirse[1:0]=="01" indicates that the operation is a read. The read command queue is shown in Figure 128. 20 The command queue could contain values of arb_se[4:0]for 3 reads at a time. * In the scenario of Figure 127 the command queue can contain 2 values of arb_sel[4:0] i.e. for the simultaneous CDU and CPU accesses. * In the scenario of Figure 130, the command queue can contain 3 values of arbse[4:0] i.e. at the time of the second dcu dau rvalid pulse the command queue will contain an 25 arb-sel[4:0] for the arbitration performed in that cycle, and the two previous arbsel[4:0] values associated with the data for the first two dcudaurvalid pulses, the data associated with the first dcudaurvalid pulse not having been fully transfered over the shared read data bus. The read command queue is specified as 4 deep so it is never expected to fill. 30 The top of the command queue is a signal read type[4:0] which indicates the destination of the current read data. The encoding of read type[4:0] is given in Table 20.14.13.1.3 CPU reads Read data for the CPU goes straight out on dram-cpu data[255:0] and dcu daurvalid is output on diucpurvald. 35 cpuread complete(O) is asserted when a CPU read at the top of the read command queue occurs. cpu_readcompete(O) causes the read command queue to be popped. cpuread complete(0) = (readtype [4:01 == CPU read) AND (dcu dau rvalid == 1) 40 WO 2004/050369 PCT/AU2003/001616 339 If the current read command queue location points to a non-CPU access and the second read command queue location points to a CPU access then the next dcudau_rvalid pulse received is associated with a CPU access. This is the scenario illustrated in Figure 127. The dcudau rvalid pulse from the DCU must be output to the CPU as diu cpurvalid. This is achieved by using 5 cpuread complete(1) to multiplex dcu daurvalid to diu cpurvalid. cpu_read complete(1) is also used to pop the second from top read command queue location from the read command queue. cpuread completely) = (readtype == non-CPU read) 10 AND SECOND (read type == CPU read) AND (dcu dau rvalid == 1) 20.14.13.1.4 Multiplexing dcudaurvalid readtype[4:0] and cpu read complete(1) multiplexes the data valid signal, dcudau_rvalid, from 15 the DCU, between the CPU and the shared read bus logic. diu cpurvad is the read valid signal going to the CPU. noncpu_rvalid is the read valid signal used by the Read Multiplexor control logic to generate read valid signals for non-CPU reads. if read type[4:0] == CPU-read then 20 //select CPU diu_cpurvalid:= 1 noncpurvalid:= 0 if (read type[4:0]== non-CPU-read) AND SECOND(readtype[4:0]== CPU-read) 25 AND dcu dau rvalid == I then //select CPU diu_cpu_rvalid:= 1 noncpurvalid:= 0 else 30 //select shared read bus logic diucpu rvalid:= 0 noncpurvalid:= 1 20.14.13.1.5 Non-CPU reads 35 Read data for the shared read bus is registered in the shared read data buffer using noncpu_rvalid. The shared read buffer has 5 locations of 64 bits with separate read pointer, read ptr[2:0], and write pointer, writeptr[2:0]. if noncpu rvalid == 1 and (4 spaces in shared read 40 buffer) then WO 2004/050369 PCT/AU2003/001616 340 sharedreaddatabuffer [write_ptr] dcudaudata[63:0] sharedread databuffer[writeptr+1] dcu dau data[127:64] 5 shared read data buffer writeptr+2] dcu dau data[191:128] shared readdata buffer[writeptr+3] dcu dau data[255:192] The data written into the shared read buffer must be output to the correct SoPEC DIU read 10 requestor according to the value of readtype[4:0] at the top of the command queue. The data is output 64 bits at a time on diu data[63:0] according to a multiplexor controlled by read ptr[2:0]. diu data[63:0] = shared readdata buffer[readptr] 15 Figure 126 shows how readtype[4:O] also selects which shared read bus requesters diu_<unit>_rvalid signal is connected to sharedrvald. Since the data from the DCU is registered in the Read Multiplexor then sharedrvalid is a delayed version of noncpu rvald. When the read valid, diu_<unit>_rvalid, for the command associated with read type[4:0] has been asserted for 4 cycles then a signal sharedreadcomplete is asserted. This indicates that the read 20 has completed. sharedreadcomplete causes the value of read type[4:0] in the read command queue to be popped. A state machine for shared read bus access is shown in Figure 129. This show the generation of shared rvalid, sharedreadcomplete and the shared read data buffer read pointer, readptr[2:0], being incremented. 25 Some points to note from Figure 129 are: * sharedrvalid is asserted the cycle after dcudaurvalid associated with a shared read bus access. This matches the cycle delay in capturing dau dcu data[255:O] in the shared read data buffer. shared rvalid remains asserted in the case of back to back shared read bus accesses. 30 e sharedread complete is asserted in the last sharedrvalid cycle of a non-CPU access. sharedread complete causes the shared read data queue to be popped. 20.14.13.1.6 Read command queue read pointer logic The read command queue read pointer logic works as follows. 35 if sharedreadcomplete == 1 OR cpuread complete(0) == 1 then POP top of read command queue if cpuread_complete(1) == 1 then POP second read command queue location 40 20.14.13.1.7 Debug signals WO 2004/050369 PCT/AU2003/001616 341 sharedreadcomplete and cpu read complete together define read complete which indicates to the debug logic that a read has completed. The source of the read is indicated on readsel[4:0]. read-complete = sharedreadcomplete OR 5 cpuread complete (0) OR cpuread_complete(1) if cpu_read_complete(l) == 1 then readsel:= SECOND(read type) else 10 read sel:= read-type 20.14.13.1.8 Flow control There are separate indications that the Read Multiplexor is able to accept CPU and shared read bus commands from the Arbitration Logic. These are indicated by read cmdrdy[1:0]. 15 The Arbitration Logic can always issue CPU reads except if the read command queue fills. The read command queue should be large enough that this should never occur. //Read Multiplexor ready for Arbitration Logic to issue CPU reads 20 read_cmdrdy[o] == read command queue not full For the shared read data, the Read Multiplexor deasserts the shared read bus readcmdrdy[1] indication until a space is available in the read command queue. The read command queue should be large enough that this should never occur. readcmcLrdy[1] is also deasserted to provide flow control back to the Arbitration Logic to keep 25 the shared read data bus just full. //Read Multiplexor not ready for Arbitration Logic to issue non-CPU reads readcmd-rdy[l] = (read command queue not full) AND 30 (flow-control = 0) The flow control condition is that DCU read data from the second of two back-to-back shared read bus accesses becomes available. This causes readcmd rdy[1] to de-assert for 1 cycle, resulting in a repeated MSN2 DCU state. The timing is shown in Figure 130. 35 flowcontrol = (readtype[4:03 == non-CPU read) AND SECOND(readtype[4:0] == non CPU read) AND (current DCU state == MSN2) 40 AND (previous DCU state == MSN1).
WO 2004/050369 PCT/AU2003/001616 342 Figure 130 shows a series of back to back transfers over the shared read data bus. The exact timing of the implementation must not introduce any additional latency on shared read bus read transfers i.e. arbitration must be re-enabled just in time to keep back to back shared read bus data 5 full. The following sequence of events is illustrated in Figure 130: e Data from the first DRAM access is written into the shared read data buffer. * Data from the second access is available 3 cycles later, but its transfer into the shared read buffer is delayed by a cycle, due to the MSN2 stall condition. (During this delay, read data 10 for access 2 is maintained at the output of the DRAM.) A similar 1-cycle delay is introduced for every subsequent read access until the back-to-back sequence comes to an end. * Note that arbitration always occurs during the last MSN2 state of any access. So, for the second and later of any back-to-back non-CPU reads, arbitration is delayed by one cycle, i.e. it occurs every fourth cycle instead of the standard every third. 15 This mechanism provides flow control back to the Arbitration Logic sub-block. Using this mechanism means that the access rate will be limited to which ever takes longer - DRAM access or transfer of read data over the shared read data bus. CPU reads are always be accepted by the Read Multiplexor. 20.14.13.2 Write Multiplexor logic description 20 The Write Multiplexor supplies write data to the DCU. There are two separate write channels, one for CPU data on cpudiuwdata[127:O], one for non CPU data on non cpuwdata[255:0]. A signal write -data valid[1:0] indicates to the Command Multiplexor that the data is valid. The Command Multiplexor then asserts a signal writedata accept[1:0] indicating that the data has been captured by the DRAM and the 25 appropriate channel in the Write Multiplexor can accept the next write data. Timing waveforms for write accesses are shown in Figure 92 to Figure 94, respectively. There are 3 types of write accesses: 0 CPU accesses CPU write data on cpu diuwdata[127:0] is output on cpu wdata[127:0].Since CPU writes are 30 posted, a local buffer is used to store the write data, address and mask until the CPU wins arbitration. This buffer is one position deep. writedata valid[O], which is synonymous with !diu_cpuwrite__rdy, remains asserted until the Command Multiplexor indicates it has been written to the DRAM by asserting writedataaccept[0]. The CPU write buffer can then accept new posted writes. 35 For non-CPU writes, the Write Multiplexor multiplexes the write data from the DIU write requester to the write data buffer and the <unit>_diu wvalid signal to the write multiplexor control logic. * CDU accesses 64-bits of write data each for a masked write to a separate 256-bit word are transferred to the Write Multiplexor over 4 cycles.
WO 2004/050369 PCT/AU2003/001616 343 When a CDU write is selected the first 64-bits of write data on cdu_diuwdata[63:0] are multiplexed to non cpuwdata[63:0]. write_data.valid[1] is asserted to indicate a non-CPU access when cdu diu wvalid is asserted. The data is also written into the first location in the write data buffer. This is so that the data can continue to be output on 5 noncpu_wdata[63:0] and writedata-valid[1] remains asserted until the Command Multiplexor indicates it has been written to the DRAM by asserting write_data_accept[1]. Data continues to be accepted from the CDU and is written into the other locations in the write data buffer. Successive writedata accept[l] pulses cause the successive 64-bit data words to be output on wdata[63:0] together with writedata valid[1]. The last 10 writedataaccept[1] means the write buffer is empty and new write data can be accepted. . Other write accesses. 256-bits of write data are transferred to the Write Multiplexor over 4 successive cycles. When a write is selected the first 64-bits of write data on <unit>_diu_wdata[63:0] are written 15 into the write data buffer. The next 64-bits of data are written to the buffer in successive cycles. Once the last 64-bit word is available on <unit> diu wdata[63:0] the entire word is output on noncpuLwdata[255:0J, write_datavalid [1] is asserted to indicate a non-CPU access, and the last 64-bit word is written into the last location in the write data buffer. Data continues to be output on non-cpuwdata[255:0] and writedatavalid[1] remains asserted 20 until the Command Multiplexor indicates it has been written to the DRAM by asserting writedataaccept[l]. New write data can then be written into the write buffer. CPU write multiplexor control logic When the Command Multiplexor has issued the CPU write it asserts writedata-accept[]. writedata accept[0] causes the write multiplexor to assert writecmdrdy[O]. 25 The signal write_cmd rdy[0] tells the Arbitration Logic sub-block that it can issue another CPU write command i.e. the CPU write data buffer is empty. Non-CPU write multiplexor control logic The signal writecmdrdy[1] tells the Arbitration Logic sub-block that the Write Multiplexor is ready to accept another non-CPU write command. When write_cmdrdy[1] is asserted the 30 Arbitration Logic can issue a write command to the Write Multiplexor. It does this by writing the value of arb sel[4:0] which indicates which SoPEC Unit has won arbitration into a write command register, write cmd[3:0]. writeen = arb-gnt AND dirsel[1]==1 AND arbsel = non 35 CPU if write en==l then write cmd = arb sel The encoding of arb sel[4:0] is given in Table .dirsei[1j==1 indicates that the operation is a write. arb sel[4:0] is only written to the write command register if the write is a non-CPU write.
WO 2004/050369 PCT/AU2003/001616 344 A rule was introduced in Section 20.7.2.3 Interleaving read and write accesses to the effect that non-CPU write accesses would not be allocated adjacent timeslots. This means that a single write command register is required. The write command register, write cmd[3:0], indicates the source of the write data. write cmd[3:0] 5 multiplexes the write data <unit>_diuwdata, and the data valid signal, <unit>_diuwvalid, from the selected write requestor to the write data buffer. Note, that CPU write data is not included in the multiplex as the CPU has its own write channel. The <unit>_diuwvalid are counted to generate the signal word sel[1:0] which decides which 64-bit word of the write data buffer to store the data from <unit>_diuwdata. 10 //when the Command Multiplexor accepts the write data if writedataaccept[l] = 1 then //reset the word select signal word sel[1:0]=00 15 //when wvalid is asserted if wvalid = 1 then //increment the word select signal if word sel[1:0] == 11 then word sel[1:0] == 00 20 else word sel[1:01 == word sel[1:0] + 1 wvalid is the <unit>_diu_wvatid signal multiplexed by write cmd[3:0]. wordsei[1:0] is reset when the Command Multiplexor accepts the write data. This is to ensure that word sel[1:0] is always starts at 00 for the first wvalid pulse of a 4 cycle write data transfer. 25 The write command register is able to accept the next write when the Command Multiplexor accepts the write data by asserting write data accept[1]. Only the last writedata accept[l] pulse associated with a CDU access (there are 4) will cause the write command register to be ready to accept the next write data. Flow control back to the Command Multiplexor 30 writecmd rdy[] is asserted when the CPU data buffer is empty. write_cmdrdy[1] is asserted when both the write command register and the write data buffer is empty. PEP SUBSYSTEM 21 PEP Controller Unit (PCU) 35 21.1 OVERVIEW The PCU has three functions: * The first is to act as a bus bridge between the CPU-bus and the PCU-bus for reading and writing PEP configuration registers.
WO 2004/050369 PCT/AU2003/001616 345 * The second is to support page banding by allowing the PEP blocks to be reprogrammed between bands by retrieving commands from DRAM instead of being programmed directly by the CPU. * The third is to send register debug information to the RDU, within the CPU subsystem, 5 when the PCU is in Debug Mode. 21.2 INTERFACES BETWEEN PCU AND OTHER UNITS 21.3 Bus BRIDGE The PCU is a bus-bridge between the CPU-bus and the PCU-bus. The PCU is a slave on the CPU-bus but is the only master on the PCU-bus. See Figure page39 on page Error! Bookmark 10 not defined.. 21.3.1 CPU accessing PEP All the blocks in the PEP can be addressed by the CPU via the PCU. The MMU in the CPU subsystem will decode a PCU select signal, cpu pcu sel, for all the PCU mapped addresses (see section 11.4.3 on page 96). Using cpuadr bits 15-12 the PCU will decode individual block selects 15 for each of the blocks within the PEP. The PEP blocks then decode the remaining address bits needed to address their PCU-bus mapped registers. Note: the CPU is only permitted to perform supervisor-mode data-type accesses of the PEP, i.e. cpuacode = 11. If the PCU is selected by the CPU and any other code is present on the cpuacode bus the access is ignored by the PCU and the pcu cputberr signal is strobed, 20 CPU commands have priority over DRAM commands. When the PCU is executing each set of four commands retrieved from DRAM the CPU can access PCU-bus registers. In the case that DRAM commands are being executed and the CPU resets the CmdSource to zero, the contents of the DRAM CmdFifo is invalidated and no further commands from the fifo are executed. The CmdPending and NextBandCmdEnable work registers are also cleared. 25 When a DRAM command writes to the CmdAdr register it means the next DRAM access will occur at the address written to CmdAdr. Therefore if the JUMP instruction is the first command in a group of four, the other three commands get executed and then the PCU will issue a read request to DRAM at the address specified by the JUMP instruction. If the JUMP instruction is the second command then the following two commands will be executed before the PCU requests 30 from the new DRAM address specified by the JUMP instruction etc.Therefore the PCU will always execute the remaining commands in each four command group before carrying out the JUMP instruction. 21.4 PAGE BANDING The PCU can be programmed to associate microcode in DRAM with each finishedband signal. 35 When a finishedband signal is asserted the PCU will read commands from DRAM and execute these commands. These commands are each 64-bits (see Section 21.8.5) and consist of 32-bit address bits and 32 data bits and allow PCU mapped registers to be programmed directly by the
PCU.
WO 2004/050369 PCT/AU2003/001616 346 If more than one finishedband signal is received at the same time, or others are received while microcode is already executing, the PCU will hold the commands as pending, and will execute them at the first opportunity. Each microcode program associated with cdufinishedband, Ibdfinishedband and 5 tefinishedband would simply restart the appropriate unit with new addresses - a total of about 4 or 5 microcode instructions. As well, or alternatively, pcu_finishedband can be used to set up all of the units and therefore involves many more instructions. This minimizes the time that a unit is idle in between bands. The pcu finishedband control signal is issued once the specified combination of CDU, LBD and TE (programmed in BandSelectMask) have finished their processing for a band. 10 21.5 INTERRUPTS, ADDRESS LEGALTY AND SECURITY Interrupts are generated when the various page expansion units have finished a particular band of data from DRAM. The cdu _finishedband, Ibd-finishedband and tefinishedband signals are combined in the PCU into a single interrupt pcu finishedband which is exported by the PCU to the interrupt controller. 15 The PCU mapped registers should only be accessible from Supervisor Data Mode. The area of DRAM where PCU commands are stored should be a Supervisor Mode only DRAM area, although this is not enforced by the PCU. When the PCU is executing commands from DRAM, any block-address decoded from a command which is not part of the PEP block-address map will cause the PCU to ignore the 20 command and strobe the pcujicuaddressinvalid interrupt signal. The CPU can then interrogate the PCU to find the source of the illegal command. The MMU will ensure that the CPU cannot address an invalid PEP subsystem block. When the PCU is executing commands from DRAM, any address decoded from a command which is not part of the PEP address map will cause the PCU to: 25 e Cease execution of current command and flush all remaining commands already retrieved from DRAM. * Clear CmdPending work-register. * Clear NextBandCmdEnable registers. * Set CmdSource to zero. 30 In addition to cancelling all current and pending DRAM accesses the PCU strobes the pcu-icu addressinvalid interrupt signal. The CPU can then interrogate the PCU to find the source of the illegal command. 21.6 DEBUG MODE When the need to monitor the (possibly changing) value in any PEP configuration register the 35 PCU may be placed in Debug Mode. This is done via the CPU setting certain Debug Address register within the PCU. Once in Debug Mode the PCU continually reads the target PEP configuration register and sends the read value to the RDU. Debug Mode has the lowest priority of all PCU functions: if the CPU wishes to perform an access or there are DRAM commands to be executed they will interrupt the Debug access, and the PCU will resume Debug access once a 40 CPU or DRAM command has completed.
WO 2004/050369 PCT/AU2003/001616 347 21.7 IMPLEMENTATION 21.7.1 Definitions of IO Table 139. PCU Port List Port Name Pins I/O Description Clocks and Resets PcIk 1 In SoPEC functional clock prst-n 1 In Active-low, synchronous reset in pclk domain End of Band Functionality cdufinishedband 1 In Finished band signal from CDU lbdfinishedband I In Finished band signal from LBD te_finishedband 1 In Finished band signal from TE pcu-finishedband 1 Out Asserted once the specified combination of CDU, LBD, and TE have finished their processing for a band. PCU address error pcuicuaddressinvalid 1 Out Strobed if PCU decodes a non PEP address from commands retrieved from DRAM or CPU. CPU Subsystem Interface Signals cpu adr[15:2] 14 In CPU address bus. 14 bits are required to decode the address space for the PEP. cpu dataout[31:0] 32 In Shared write data bus from the CPU pcucpudata[31:0] 32 Out Read data bus to the CPU . cpurwn 1 In Common read/not-write signal from the CPU cpuacode[1:0] 2 In CPU Access Code signals. These decode as follows: 00 - User program access 01 - User data access 10 - Supervisor program access 11 - Supervisor data access cpupcu-sel 1 In Block select from the CPU. When cpu pcu se/ is high both cpu_adr and cpu_dataout are valid pcu-cpu-rdy 1 Out Ready signal to the CPU. When pcucpurdy is high it indicates the last cycle of the access. For a write cycle this means cpu dataout has been registered by the block and for a read cycle this means the data on ocucpudata is valid. pcu-cpuberr 1 Out Bus error signal to the CPU indicating an invalid access. pcu cpu debug_valid 1 Out Debug Data valid on pcucpu data bus. Active high.
WO 2004/050369 PCT/AU2003/001616 348 PCU Interface to PEP blocks pcu-adr[l1:2] 10 Out PCU address bus. The 10 least significant bits of cpu._adr [15:2] allow 1024 32-bit word addressable locations per PEP block. Only the number of bits required to decode the address space are exported to each block. pcu-dataout[31:0] 32 Out Shared write data bus from the PCU <unit>_pcudatain[31:0] 32 In Read data bus from each PEP subblock to the PCU pcu-rwn I Out Common readfnot-write signal from the PCU pcu_<unit>_sel 1 Out Block select for each PEP block from the PCU. Decoded from the 4 most significant bits of cpu_adr[15:2]. When pcu <unit>_sel is high both rcuadr and pcu dataout are valid <unit>_pcu rdy 1 In Ready from each PEP block signal to the PCU. When <unit>_pcu_rdy is high it indicates the last cycle of the access. For a write cycle this means ocudataout has been registered by the block and for a read cycle this means the data on <unit>_pcu datain is valid. DIU Read Interface signals pcu diu rreq 1 Out PCU requests DRAM read. A read request must be accompanied by a valid read address. pcu-diu-radr[21:5] 17 Out Read address to DIU 17 bits wide (256-bit aligned word). diupcurack I In Acknowledge from DIU that read request has been accepted and new read address can be placed on cudiuradr diudata[63:0] 64 In Data from DIU to PCU. First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word Third 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word diu_pcu-rvalid 1 In Signal from DIU telling PCU that valid read data is on the diu data bus 21.7.2 Configuration Registers Table 140. PCU Configuration Registers Address register #bits reset description PCU base+ WO 2004/050369 PCT/AU2003/001616 349 Control registers 0x00 Reset 1 0x1 A write to this register causes a reset of the PCU. This register can be read to indicate the reset state: 0 - reset in progress 1 - reset not in progress 0x04 CmdAdr[21: 17 OxO0 000 The address of the next set of commands to 5] retrieve from DRAM. (256-bit When this register is written to, either by the aligned CPU or DRAM command, 1 is also written to DRAM CmdSource to cause the execution of the address) commands at the specified address. Ox08 BandSelect 3 Ox0 Selects which input finishedBand flags are to Mask[2:0] be watched to generate the combined ocu_finishedband signal. BitO - Ibd finishedband Bit1 - cdufinishedband Bit2 - te finishedband OxOC, Oxl0,NextBandC 4x17 OxOO 000 The address to transfer to CmdAdr as soon Ox14, Ox18 mdAdr[3:0][ as possible after the next finishedBand[n] 21:5] signal has been received as long as (256-bit NextBandCmdEnable[n] is set. aligned A write from the PCU to NextBandCmdAdr[n] DRAM with a non-zero value also sets address) NextBandCmdEnab/e[n]. A write from the PCU to NextBandCmdAdr[n] with a 0 value clears NextBandCmdEnable[n]. OxIC NextCmdAd 17 OxO 000 The address to transfer to CmdAdr when the r[21:5] CPU pending bit (CmdPending[4]) get serviced. A write from the PCU to NextCmdAdr[n] with a non-zero value also sets CmdPendng[4]. A write from the PCU to NextCmdAdr[n] with a 0 value clears CmdPendng[4] 0x20 CmdSource 1 Ox0 0 - commands are taken from the CPU 1 - commands are taken from the CPU as well as DRAM at CmdAdr. Ox24 DebugSelec 14 xO00 00 Debug address select. Indicates the address WO 2004/050369 PCT/AU2003/001616 350 t[15:2] of the register to report on the pcu qpu data bus when it is not otherwise being used, and the PEP bus is not being used Bits [15:12] select the unit (see Table Bits [11:2] select the register within the unit Work registers (read only) 0x28 lnvalidAddre 19 0 DRAM Address of current 64-bit command ss[21:3] attempting to execute. (64-bit Read only register. aligned DRAM) Ox2C CmdPendin 5 Ox00 For each bit n, where n is 0 to 3 g 0 -no commands pending for NextBandCmdAdr[n] I -commands pending for NextBandCmdAdr[n] For bit 4 0 -no commands pending for NextCmdAdr[n] 1 -commands pending for NextCmdAdr[n] Read only register. Ox34 FinishedSo 3 Ox0 The appropriate bit is set whenever the corre Far sponding input finishedBand flag is set and the corresponding bit in the BandSelectMask bit is also set. If all FinishedSoFar bits are set wherever BandSelect bits are also set, all FinishedSoFar bits are cleared and the output ocu-finishedband signal is given. Read only register. Ox38 NextBandC 4 Ox0 This register can be written to indirectly (i.e. mdEnable the bits are set or cleared via writes to NextBandCmdAdr[n]) For each bit: 0 - do nothing at the next finishedBand[n] signal. 1 - Execute instructions at NextBandCmdAdr[n] as soon as possible after receipt of the next finishedBand[nJ signal.
WO 2004/050369 PCT/AU2003/001616 351 BitO - Ibd finishedband Bit1 - cdufinishedband Bit2 - te finishedband Bit3 - pcu-finishedband Read only register. 21.8 DETAILED DESCRIPTION 21.8.1 PEP Blocks Register Map All PEP accesses are 32-bit register accesses. From Table 140 it can be seen that four bits only are necessary to address each of the sub 5 blocks within the PEP part of SoPEC. Up to 14 bits may be used to address any configurable 32 bit register within PEP. This gives scope for 1024 configurable registers per sub-block. This address will come either from the CPU or from a command stored in DRAM. The bus is assembled as follows: e adr[15:12] = sub-block address 10 e adr[n:2] = 32-bit register address within sub-block, only the number of bits required to decode the registers within each sub-block are used. Table 141. PEP blocks Register Map Block Block Select Decode = cpuadr[I 5:121 PCU Ox0 CDU Ox1 CFU Ox2 LBD Ox3 SFU Ox4 TE 0x5 TFU Ox6 HCU Ox7 DNC 0x8 DWU Ox9 LLU OxA PHI OxB Reserved OxC to OxF 21.8.2 Internal PCU PEP protocol 15 The PCU performs PEP configuration register accesses via a select signal, pcu_<block>_sel. The read/ write sense of the access is communicated via the pcu rwn signal (1 = read, 0 = write). Write data is clocked out, and read data clocked in upon receipt of the appropriate select read/write-address combination.
WO 2004/050369 PCT/AU2003/001616 352 Figure 133 shows a write operation followed by a read operation. The read operation is shown with wait states while the PEP block returns the read data. For access to the PEP blocks a simple bus protocol is used. The PCU first determines which particular PEP block is being addressed so that the appropriate block select signal can be 5 generated. During a write access PCU write data is driven out with the address and block select signals in the first cycle of an access. The addressed PEP block responds by asserting its ready signal indicating that it has registered the write data and the access can complete. The write data bus is common to all PEP blocks. A read access is initiated by driving the address and select signals during the first cycle of an 10 access. The addressed PEP block responds by placing the read data on its bus and asserting its ready signal to indicate to the PCU that the read data is valid. Each block has a separate point-to point data bus for read accesses to avoid the need for a tri-stateable bus. Consecutive accesses to a PEP block must be separated by at least a single cycle, during which the select signal must be de-asserted. 15 21.8.3 PCU DRAM access requirements The PCU can execute register programming commands stored in DRAM. These commands can be executed at the start of a print run to initialize all the registers of PEP. The PCU can also execute instructions at the start of a page, and between bands. In the inter-band time, it is critical to have the PCU operate as fast as possible. Therefore in the inter-page and inter-band time the 20 PCU needs to get low latency access to DRAM. A typical band change requires on the order of 4 commands to restart each of the CDU, LBD, and TE, followed by a single command to terminate the DRAM command stream. This is on the order of 5 commands per restart component. The PCU does single 256 bit reads from DRAM. Each PCU command is 64 bits so each 256 bit 25 DRAM read can contain 4 PCU commands. The requested command is read from DRAM together with the next 3 contiguous 64-bits which are cached to avoid unnecessary DRAM reads. Writing zero to CmdSource causes the PCU to flush commands and terminate program access from DRAM for that command stream. The PCU requires a 256-bit buffer to the 4 PCU commands read by each 256-bit DRAM access. When the buffer is empty the PCU can request DRAM 30 access again. Adding a 256-bit double buffer would allow the next set of 4 commands to be fetched from DRAM while the current commands are being executed. 1024 commands of 64 bits requires 8 kB of DRAM storage. Programs stored in DRAM are referred to as PCU Program Code. 21.8.4 End of band unit 35 The state machine is responsible for watching the various input xxfinishedband signals, setting the FinishedSoFer flags, and outputting the pcu finishedband flags as specified by the BandSelect register. Each cycle, the end of band unit performs the following tasks: WO 2004/050369 PCT/AU2003/001616 353 pcu finishedband = (FinishedSoFar[0] == BandSelectMask[0]) AND (FinishedSoFar[1] == BandSelectMask [1]) AND 5 (FinishedSoEar[2] == BandSelectMask[2]) AND (BandSelectMask[01 OR BandSelectMask[l] OR BandSelectMask[2]) if (pcufinishedband == 1) then 10 FinishedSoFar[0] = 0 FinishedSoFar[1] = 0 FinishedSoFar[2] = 0 else FinishedSoFar[0] (FinishedSoFar[0] OR 15 lbd finishedband) AND BandSelectMask[0] FinishedSoFar[1] = (FinishedSoFar[l] OR cdu finishedband) AND BandSelectMask[1] FinishedSoFar[2] = (FinishedSoFar[2] OR te finishedband) AND BandSelectMask[2] 20 Note that it is the responsibility of the microcode at the start of printing a page to ensure that all 3 FinishedSoFar bits are cleared. It is not necessary to clear them between bands since this happens automatically, if a bit of BandSelectMask is cleared, then the corresponding bit of FinishedSoFar has no impact 25 on the generation of pcu-finishedband. 21.8.5 Executing commands from DRAM Registers in PEP can be programmed by means of simple 64-bit commands fetched from DRAM. The format of the commands is given in Table 142. Register locations can have a data value of up to 32 bits. Commands are PEP register write commands only. 30 Table 142. Register write commands in PEP command bits 63-32 bits 31-16 bits 15-2 bits 1-0 Register write data zero 32-bit word zero address Due attention must be paid to the endianness of the processor. The LEON processor is a big endian processor (bit 7 is the most significant bit). 21.8.6 General Operation WO 2004/050369 PCT/AU2003/001616 354 Upon a Reset condition, CmdSource is cleared (to 0), which means that all commands are initially sourced only from the CPU bus interface. Registers and can then be written to or read from one location at a time via the CPU bus interface. If CmdSource is 1, commands are sourced from the DRAM at CmdAdr and from the CPU bus. 5 Writing an address to CmdAdr automatically sets CmdSource to 1, and causes a command stream to be retrieved from DRAM. The PCU will execute commands from the CPU or from the DRAM command stream, giving higher priority to the CPU always. If CmdSource is 0 the DRAM requestor examines the CmdPending bits to determine if a new DRAM command stream is pending. If any of CmdPending bits are set, then the appropriate 10 NextBandCmdAdr or NextCmdAdr is copied to CmdAdr (causing CmdSource to get set to 1) and a new command DRAM stream is retrieved from DRAM and executed by the PCU. If there are multiple pending commands the DRAM requestor will service the lowest number pending bit first. Note that a new DRAM command stream only gets retrieved when the current command stream is empty. 15 If there are no DRAM commands pending, and no CPU commands the PCU defaults to an idle state. When idle the PCU address bus defaults to the DebugSelect register value (bits 11 to 2 in particular) and the default unit PCU data bus is reflected to the CPU data bus. The default unit is determined by the DebugSeiect register bits 15 to 12. In conjunction with this, upon receipt of a finishedBand[n] signal, NextBandCmdEnabe[n] is 20 copied to CmdPending[n] and NextBandCmdEnable[n] is cleared. Note, each of the LBD, CDU, and TE (where present) may be re-programmed individually between bands by appropriately setting NextBandCmdAdr[2-0] respectively. However, execution of inter-band commands may be postponed until all blocks specified in the BandSe/ectMask register have pulsed their finishedband signal. This may be accomplished by only setting NextBandCmdAdr[3] (indirectly causing 25 NextBandCmdEnable[3] to be set) in which case it is the pcu finishedband signal which causes NextBandCmdEnable[3] to be copied to CmdPending[3]. To conveniently update multiple registers, for example at the start of printing a page, a series of Write Register commands can be stored in DRAM. When the start address of the first Write Register command is written to the CmdAdr register (via the CPU), the CmdSource register is 30 automatically set to 1 to actually start the execution at CmdAdr. Alternatively the CPU can write to NextCmdAdr causing the CmdPending[4] bit to get set, which will then get serviced by the DRAM requestor in the pending bit arbitration order. The final instruction in the command block stored in DRAM must be a register write of 0 to CmdSource so that no more commands are read from DRAM. Subsequent commands will come 35 from pending programs or can be sent via the CPU bus interface. 21.8.6.1 Debug Mode Debug mode is implemented by reusing the normal CPU and DRAM access decode logic. When in the Arbitrate state (see state machine A below), the PEP address bus is defaulted to the value in the DebugSelect register. The top bits of the DebugSelect register are used to decode a select 40 to a PEP unit and the remaining bits are reflected on the PEP address bus. The selected units WO 2004/050369 PCT/AU2003/001616 355 read data bus is reflected on the pcu cpu_data bus to the RDU in the CPU. The pcucpudebugvalid signal indicates to the RDU that the data on the pcu cpu data bus is valid debug data. Normal CPU and DRAM command access will require the PEP bus, and as such will cause the 5 debug data to be invalid during the access, this is indicated to the RDU by setting pcu cpudebug valid to zero. The decode logic is: // Default Debug decode if state == Arbitrate then 10 if (cpupcu sel == 1 AND cpuacode /= SUPERVISOR DATA MODE) then pcucpudebugvalid = 0 // bus error condition pcucpudata = 0 15 else <unit> = decode (DebugSelect [15 :12]) if (<unit> == PCU ) then pcu cpu data = Internal PCU register else 20 pcu cpudata = <unit>_pcu datain[31:0] pcuadr[11:2] = DebugSelect[11:2] pcucpudebugvalid = 1 AFTER 4 clock cycles else pcucpudebug_valid = 0 25 21.8.7 State Machines DRAM command fetching and general command execution is accomplished using two state machines. State machine A evaluates whether a CPU or DRAM command is being executed, and proceeds to execute the command(s). Since the CPU has priority over the DRAM it is permitted to interrupt the execution of a stream of DRAM commands. 30 Machine B decides which address should be used for DRAM access, fetches commands from DRAM and fills a command fifo which A executes. The reason for separating the two functions is to facilitate the execution of CPU or Debug commands while state machine B is performing DRAM reads and filling the command fifo. In the case where state machine A is ready to execute commands (in its Arbitrate state) and it sees both a full DRAM command fifo and an active 35 cpu_pcu_sel then the DRAM commands are executed last. 21.8.7.1 State Machine A: Arbitration and execution of commands The state-machine enters the Reset state when there is an active strobe on either the reset pin, prstn, or the PCU's soft-reset register. All registers in the PCU are zeroed, unless otherwise specified, on the next rising clock edge. The PCU self-deasserts the soft reset in the pclk cycle 40 after it has been asserted.
WO 2004/050369 PCT/AU2003/001616 356 The state changes from Reset to Arbitrate when prst n == I and PCUsoftreset == 1. The state-machine waits in the Arbitrate state until it detects a request for CPU access to the PEP units (cpu pcu-seI== 1 and cpu acode == 11) or a request to execute DRAM commands CmdSource == 1, and DRAM commands are available, CmdFifoFul==1. Note if (cpujpcusel= 5 1 and cpu acode != 11) the CPU is attempting an illegal access. The PCU ignores this command and strobes the cpupcu berr for one cycle. While in the Arbitrate state the machine assigns the DebugSelect register to the PCU unit decode logic and the remaining bits to the PEP address bus. When in this state the debug data returned from the selected PEP unit is reflected on the CPU bus (pcu cpudata bus) and the 10 pcucpudebug valid=1. If a CPU access request is detected (cpupcu se! == 1 and cpuacode == 11) then the machine proceeds to the CpuAccess state. In the CpuAccess state the cpu address is decoded and used to determine the PEP unit to select. The remaining address bits are passed through to the PEP address bus. The machine remains in the CpuAccess state until a valid ready from the selected 15 PEP unit is received. When received the machine returns to the arbitrate state, and the ready signal to the CPU is pulsed. // decode the logic pcu_<unit>_sel = decode(cpuadr[15:12]) pcu adr[11:2] = cpu adr[11:2] 20 The CPU is prevented from generating an invalid PEP unit address (prevented in the MMU) and so CPU accesses cannot generate an invalid address error. If the state machine detects a request to execute DRAM commands (CmdSource == 1), it will wait in the Arbitrate state until commands have been loaded into the command FIFO from DRAM (all controlled by state machine B). When the DRAM commands are available (cmdfifo full == 1) the 25 state machine will proceed to the DRAMAccess state. When in the DRAMAccess state the commands are executed from the cmd fifo. A command in the cmdfifo consists of 64-bits (or which the FIFO holds 4). The decoding of the 64-bits to commands is given in Table . For each command the decode is // DRAM command decode 30 pcu_<unit>_sei = decode( cmd fifo[cm count] [15:12] pcu adr[11:2] = cmd fifo[cmd count] [11:2] pcudataout = cmdfifo[cmdcount] [63:32] When the selected PEP unit returns a ready signal (<unit>_pcurdy==1) indicating the command has completed, the state machine will return to the Arbitrate state. If more commands exists 35 (cmd count !=O) the transition will decrement the command count. When in the DRAMAccess state, if when decoding the DRAM command address bus (cmd fifolcmd count][15:12]), the address selects a reserved address, the state machine proceeds to the AdrError state, and then back to the Arbitrate state. An address error interrupt will be generated and the DRAM command FIFOs will be cleared.
WO 2004/050369 PCT/AU2003/001616 357 A CPU access can pre-empt any pending DRAM commands. After each command is completed the state machine returns to the Arbitrate state. If a CPU access is required and DRAM command stream is executing the CPU access always takes priority. If a CPU or DRAM command sets the CmdSource to 0, all subsequent DRAM commands in the command FIFO are cleared. If the CPU 5 sets the CmdSource to 0 the CmdPending and NextBandCmdEnable work registers are also cleared. 21.8.7.2 State Machine B: Fetching DRAM commands A system reset (prst n==0) or a software reset (pcu softresetn==O) will cause the state machine to reset to the Reset state. The state machine remains in the Reset until both reset conditions are 10 removed. When removed the machine proceeds to the Wait state. The state machine waits in the Wait state until it determines that commands are needed from DRAM. Two possible conditions exist that require DRAM access. Either the PCU is processing commands which must be fetched from DRAM (cmd source==1), and the command FIFO is empty (cmd fifofulI==0), or the cmdsource==0 and the command FIFO is empty and there are 15 some commands pending (cmdpending !=0). In either of these conditions the machine proceeds to the Ack state and issues a read request to DRAM (pcu diurreq==1), it calculates the address to read from dependent on the transition condition. In the command pending transition condition, the highest priority NextBandCmdAdr (or NextCmdAdr) that is pending is used for the read address (pcu diu radr) and is also copied to the CmdAdr register. If multiple pending bits are set 20 the lowest pending bits are serviced first. In the normal PCU processing transition the pcu diuradr is the CmdAdr register. When an acknowledge is received from the DRAM the state machine goes to the FiliFifo state. In the FifiFifo state the machine waits for the DRAM to respond to the read request and transfer data words. On receipt of the first word of data diu_pcu_rvalid==1, the machine stores the 64-bit data 25 word in the command FIFO (cmd fifo[3]) and transitions to the Data 1, Data2, Data3 states each time waiting for a diu pcu rvalid==1 and storing the transferred data word to cmd fifo[2], cmd_fifo[1] and cmd fifo[0] respectively. When the transfer is complete the machine returns to the Wait state, setting the cmdcount to 3, the cmd_fifo_full is set to 1 and the CmdAdr is incremented. 30 If the CPU sets the CmdSource register low while the PCU is in the middle of a DRAM access, the statemachine returns to the Wait state and the DRAM access is aborted. 21.8.7.3 PCUICUAddressInvalid Interrupt When the PCU is executing commands from DRAM, addresses decoded from commands which are not PCU mapped addresses (4-bits only) will result in the current command being ignored and 35 the pcuicuaddressinvalid interrupt signal is strobed. When an invalid command occurs all remaining commands already retrieved from DRAM are flushed from the CmdFifo, and the CmdPending, NextBandCmdEnable and CmdSource registers are cleared to zero. The CPU can then interrogate the PCU to find the source of the illegal DRAM command via the InvalidAddress register. 40 The CPU is prevented by the MMU from generating an invalid address command.
WO 2004/050369 PCT/AU2003/001616 358 22 Contone Decoder Unit (CDU) 22.1 OVERVIEW The Contone Decoder Unit (CDU) is responsible for performing the optional decompression of the contone data layer. 5 The input to the CDU is up to 4 planes of compressed contone data in JPEG interleaved format. This will typically be 3 planes, representing a CMY contone image, or 4 planes representing a CMYK contone image. The CDU must support a page of A4 length (11.7 inches) and Letter width (8.5 inches) at a resolution of 267 ppi in 4 colors and a print speed of 1 side per 2 seconds. The CDU and the other page expansion units support the notion of page banding. A compressed 10 page is divided into one or more bands, with a number of bands stored in memory. As a band of the page is consumed for printing a new band can be downloaded. The new band may be for the current page or the next page. Band-finish interrupts have been provided to notify the CPU of free buffer space. The compressed contone data is read from the on-chip DRAM. The output of the CDU is the 15 decompressed contone data, separated into planes. The decompressed contone image is written to a circular buffer in DRAM with an expected minimum size of 12 lines and a configurable maximum. The decompressed contone image is subsequently read a line at a time by the CFU, optionally color converted, scaled up to 1600 ppi and then passed on to the HCU for the next stage in the printing pipeline. The CDU also outputs a cdufinishedband control flag indicating 20 that the CDU has finished reading a band of compressed contone data in DRAM and that area of DRAM is now free. This flag is used by the PCU and is available as an interrupt to the CPU. 22.2 STORAGE REQUIREMENTS FOR DECOMPRESSED CONTONE DATA IN DRAM A single SoPEC must support a page of A4 length (11.7 inches) and Letter width (8.5 inches) at a resolution of 267 ppi in 4 colors and a print speed of I side per 2 seconds. The printheads 25 specified in the Bi-lithic Printhead Specification [2] have 13824 nozzles per color to provide full bleed printing for A4 and Letter. At 267 ppi, there are 2304 contone pixels 9 per line represented by 288 JPEG blocks per color. However each of these blocks actually stores data for 8 lines, siice a single JPEG block is 8 x 8 pixels. The CDU produces contone data for 8 lines in parallel, while the HCU processes data linearly across a line on a line by line basis. The contone data is decoded only once and then buffered 30 in DRAM. This means we require two sets of 8 buffer-lines - one set of 8 buffer lines is being consumed by the CFU while the other set of 8 buffer lines is being generated by the CDU. The buffer requirement can be reduced by using a 1.5 buffering scheme, where the CDU fills 8 lines while the CFU consumes 4 lines. The buffer space required is a minimum of 12 line stores per color, for a total space of 108 KBytes1 0 .A circular buffer scheme is employed whereby the CDU 35 may only begin to write a line of JPEG blocks (equals 8 lines of contone data) when there are 8-lines free in 9 Pixels may be 8, 16, 24 or 32 bits depending on the number of color planes (8-bits per color) 1012 lines x 4 colors x 2304 bytes (assumes 267 ppi, 4 color, full bleed A4/Letter) WO 2004/050369 PCT/AU2003/001616 359 the buffer. Once the full 8 lines have been written by the CDU, the CFU may now begin to read them on a line by line basis. This reduction in buffering comes with the cost of an increased peak bandwidth requirement for the CDU write access to DRAM. The CDU must be able to write the decompressed contone at 5 twice the rate at which the CFU reads the data. To allow for trade-offs to be made between peak bandwidth and amount of storage, the size of the circular buffer is configurable. For example, if the circular buffer is configured to be 16 lines it behaves like a double-buffer scheme where the peak bandwidth requirements of the CDU and CFU are equal. An increase over 16 lines allows the CDU to write ahead of the CFU and provides it with a margin to cope with very poor local 10 compression ratios in the image. SoPEC should also provide support for A3 printing and printing at resolutions above 267 ppi. This increases the storage requirement for the decompressed contone data (buffer) in DRAM. Table 143 gives the storage requirements for the decompressed contone data at some sample contone resolutions for different page sizes. It assumes 4 color planes of contone data and a 1.5 buffering 15 scheme. Table 143. Storage requirements for decompressed contone data (buffer) Page Contone resolution Scale Pixels per line Storage required size (ppi) factor" (kBytes) A4/Letter 267 6 2304 1o8a 400 4 3456 162 800 2 6912 324 A34 267 6 3248 152.25 400 4 4872 228.37 800 2 9744 456.75 a. Required for CFU to convert to final output at 1600 dpi 20 b. Bi-lithic printhead has 13824 nozzles per color providing full bleed printing for A4/Letter c. Bi-lithic printhead has 19488 nozzles per color providing full bleed printing for A3 d. 12 lines x 4 colors x 2304 bytes. 22.3 DECOMPRESSION PERFORMANCE REQUIREMENTS The JPEG decoder core can produce a single color pixel every system clock (pc/k) cycle, making 25 it capable of decoding at a peak output rate of 8 bits/cycle. SoPEC processes 1 dot (bi-level in 6 colors) per system clock cycle to achieve a print speed of 1 side per 2 seconds for full bleed A4/Letter printing. The CFU replicates pixels a scale factor (SF) number of times in both the horizontal and vertical directions to convert the final output to 1600 ppi. Thus the CFU consumes a 4 color pixel (32 bits) every SFx SF cycles. The 1.5 buffering scheme described in section 22.2 WO 2004/050369 PCT/AU2003/001616 360 on page 358 means that the CDU must write the data at twice this rate. With support for 4 colors at 267 ppi, the decompression output bandwidth requirement is 1.78 bits/cycle". The JPEG decoder is fed directly from the main memory via the DRAM interface. The amount of compression determines the input bandwidth requirements for the CDU. As the level of 5 compression increases, the bandwidth decreases, but the quality of the final output image can also decrease. Although the average compression ratio for contone data is expected to be 10:1, the average bandwidth allocated to the CDU allows for a local minimum compression ratio of 5:1 over a single line of JPEG blocks. This equates to a peak input bandwidth requirement of 0.36 bits/cycle for 4 colors at 267 ppi, full bleed A4/Letter printing at 1 side per 2 seconds. 10 Table 144 gives the decompression output bandwidth requirements for different resolutions of contone data to meet a print speed of I side per 2 seconds. Higher resolution requires higher bandwidth and larger storage for decompressed contone data in DRAM. A resolution of 400 ppi contone data in 4 colors requires 4 bits/cycle, which is practical using a 1.5 buffering scheme. However, a resolution of 800 ppi would require a double buffering scheme (16 lines) so the CDU only has 15 to match the CFU consumption rate. In this case the decompression output bandwidth requirement is 8 bits/cycle, the limiting factor being the output rate of the JPEG decoder core. Table 144. CDU performance requirements for full bleed A4/Letter printing at I side per 2 seconds. 20 Contone Scale Decompression output bandwidth resolution factor requirement (bits/cycle)a (ppi) 267 6 1.78 400 4 4 800 2 8 a. Assumes 4 color pixel contone data and a 12 line buffer. b. Scale factor 2 requires at least a 16 line buffer. 22.4 DATA FLOW Figure 136 shows the general data flow for contone data - compressed contone planes are read 25 from DRAM by the CDU, and the decompressed contone data is written to the 12-line circular buffer in DRAM. The line buffers are subsequently read by the CFU. The CDU allows the contone data to be passed directly on, which will be the case if the color represented by each color plane in the JPEG image is an available ink. For example, the four 112 x ( (4 colors x 8 bits) / (6 x 6 cycles) ) = 1.78 bits/cycle 122 x ( (4 colors x 8 bits) / (4 x 4 cycles) ) = 4 bits/cycle 13(4 colors x 8 bits) / (2 x 2 cycles) = 8 bits/cycle WO 2004/050369 PCT/AU2003/001616 361 colors may be C, M, Y, and K, directly represented by CMYK inks. The four colors may represent gold, metallic green etc. for multi-SoPEC printing with exact colors. However JPEG produces better compression ratios for a given visible quality when luminance and chrominance channels are separated. With CMYK, K can be considered to be luminance, but C, 5 M, and Y each contain luminance information, and so would need to be compressed with appropriate luminance tables. We therefore provide the means by which CMY can be passed to SoPEC as YCrCb. K does not need color conversion. When being JPEG compressed, CMY is typically converted to RGB, then to YCrCb and then finally JPEG compressed. At decompression, the YCrCb data is obtained and written to the decompressed contone store by the CDU. This is 10 read by the CFU where the YCrCb can then be optionally color converted to RGB, and finally back to CMY. The external RIP provides conversion from RGB to YCrCb, specifically to match the actual hardware implementation of the inverse transform within SoPEC, as per CCIR 601-2 [24] except that Y, Cr and Cb are normalized to occupy all 256 levels of an 8-bit binary encoding. 15 The CFU provides the translation to either RGB or CMY. RGB is included since it is a necessary step to produce CMY, and some printers increase their color gamut by including RGB inks as well as CMYK. 22.5 IMPLEMENTATION A block diagram of the CDU is shown in Figure 137. 20 All output signals from the CDU (cducfu_wradv8line, cdufinishedband, cduicujpegerror, and control signals to the DIU) must always be valid after reset. If the CDU is not currently decoding, cducfu_wradv8line, cdufinishedband and cduicujpegerror will always be 0. The read control unit is responsible for keeping the JPEG decoder's input FIFO full by reading compressed contone bytestream from external DRAM via the DIU, and produces the 25 cdu_finishedband signal. The write control unit accepts the output from the JPEG decoder a half JPEG block (32 bytes) at a time, writes it into a double-buffer, and writes the double buffered decompressed half blocks to DRAM via the DIU, interacting with the CFU in order to share DRAM buffers. 22.5.1 Definitions of 1/O 30 Table 145. CDU port list and description Port name Pins 1/O Description Clocks and reset Pclk 1 In System clock. Jclk 1 In Gated version of system clock used to clock the JPEG decoder core and logic at the output of the core. Allows for stalling of the JPEG core at a pixel sample boundary.
WO 2004/050369 PCT/AU2003/001616 362 jclk_enable 1 Out Gating signal for jclk. prst-n 1 In System reset, synchronous active low. jrstn I In Reset for jclk domain, synchronous active low. PCU interface pcu-cdusel 1 In Block select from the PCU. When pcu cdu sel is high both pcu adr and pcu dataout are valid. pcu-rwn 1 In Common read/not-write signal from the PCU. pcu-adr[7:2] 6 In PCU address bus. Only 6 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. cdu_pcu-rdy 1 Out Ready signal to the PCU. When cdujpcu rdy is high it indicates the last cycle of the access. For a write cycle this means pcudataout has been registered by the block and for a read cycle this means the data on cdu pcudatain is valid. cdu_pcu datain[31:0] 32 Out Read data bus to the PCU. DIU read interface cdudiu-rreq 1 Out CDU read request, active high. A read request must be accompanied by a valid read address. diu cdu rack 1 In Acknowledge from DIU, active high. Indicates that a read request has been accepted and the new read address can be placed on the address bus, cdudiu radr. cdudiu radr[21:5] 17 Out CDU read address. 17 bits wide (256-bit aligned word). diu cdu rvalid 1 In Read data valid, active high. Indicates that valid read data is now on the read data bus, diu_data. diudata[63:0] 64 In Read data from DRAM. DIU write interface cdudiu-wreq 1 Out CDU write request, active high. A write request must be accompanied by a valid write address and valid write data. diu cdu wack 1 In Acknowledge from DIU, active high. Indicates that a write request has been accepted and the new write address can be placed on the address bus, cdu du wadr. cdu diu-wadr[21:3] 19 Out CDU write address. 19 bits wide (64-bit aligned word). cdudiuwvalid I Out Write data valid, active high. Indicates that valid data WO 2004/050369 PCT/AU2003/001616 363 is now on the write data bus, cdu_.diu data. cdu diu-data[63:0] 64 Out rite data bus. CFU interface cfucdurdadvline 1 In Read line pulse, active high. Indicates that the CFU has finished reading a line of decompressed contone data to the circular buffer in DRAM and that line of the buffer is now free. cducfu_linestore-rdy 1 Out Indicates if the contone line store has 1 or more lines available to read by the CFU. TE and LBD interface cdustartofbandstore[21 17 Out Points to the 256-bit word that defines the start of the :5] memory area allocated for page bands. cduendof_bandstore[21:17 Out Points to the 256-bit word that defines the last 5] address of the memory area allocated for page bands. ICU interface cdufinishedband 1 Out CDU's finishedBand flag, active high. Interrupt to the CPU to indicate that the CDU has finished processing a band of compressed contone data in DRAM and that area of DRAM is now free.This signal goes to both the interrupt controller and the PCU. cdu_icujpegerror 1 Out Active high interrupt indicating an error has occurred in the JPEG decoding process and decompression has stopped. A reset of the CDU must be performed to clear this interrupt. 22.5.2 Configuration registers The configuration registers in the CDU are programmed via the PCU interface. Refer to section 21.8.2 on page 351 for the description of the protocol and timing diagrams for reading and writing registers in the CDU. Note that since addresses in SoPEC are byte aligned and the PCU only 5 supports 32-bit register reads and writes, the lower 2 bits of the PCU address bus are not required to decode the address space for the CDU. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of cdu jpcu detain. Since the CDU, LBD and TE all access the page band store, they share two registers that enable sequential memory accesses to the page band stores to be circular in nature. Table 146 lists 10 these two registers. Table 146. Registers shared between the CDU, LBD, and TE ddress Register name bits Value on description WO 2004/050369 PCT/AU2003/001616 364 (CDU-base+) reset Setup registers (remain constant during the processing of multiple bands) 0x80 StartOfBandStore[21:5] 17 OxO_0000 Points to the 256-bit word that defines the start of the memory area allocated for page bands. Circular address generation wraps to this start address. Ox84 EndOfBandStore[21:5] 17 Ox1_3FFF Points to the 256-bit word that defines the last address of the memory area allocated for page bands. If the current read address is from this address, then instead of adding 1 to the current address, the current address will be loaded from the Star tOfBandStore register. The software reset logic should include a circuit to ensure that both the pc/k and jc/k domains are reset regardless of the state of the jc/k enable when the reset is initiated. The CDU contains the following additional registers: 5 Table 147. CDU registers Address Register name Abits Value on Description (CDU_base+) reset Control registers Ox00 Reset I Ox1 A write to this register causes a reset of the CDU. This terminates all internal operations within the CS6150. All configuration data previously loaded into the core except for the tables is deleted. Ox04 Go 1 Ox0 Writing 1 to this register starts the CDU. Writing 0 to this register halts the CDU. When Go is deasserted the state machines go to their idle states but all counters and configuration registers keep their values. When Go is asserted all counters are reset, but configuration registers keep their values (i.e. they don't get reset).
WO 2004/050369 PCT/AU2003/001616 365 NextBandEnable is cleared when Go is asserted. The CFU must be started before the CDU is started. Go must remain low for at least 384 jc/k cycles after a hardware reset (prst n = 0) to allow the JPEG core to complete its memory itnitialisation sequence. This register can be read to determine if the CDU is running (1 - running, 0 stopped). Setup registers OxOC NumLinesAvail 7 Ox0 The number of image lines of data that there is space available for in the decompressed data buffer in DRAM. If this drops < 8 the CDU will stall. In normal operation this value will start off atNumBuffLines and will be decremented by 8 whenever the CDU writes a line of JPEG blocks (8 lines of data) to DRAM and incremented by 1 whenever the CFU reads a line of data from DRAM. NumLinesAvail can be overwritten by the CPU to prevent the CDU from stalling. OxI0 MaxPlane 2 Ox0 Defines the number of contone planes 1. For example, this will be 0 for K (greyscale printing), 2 for CMY, and 3 for CMYK. Ox14 MaxBlock 13 OxOO Number of JPEG MCUs (or JPEG block equivalents, i.e. 8x8 bytes) in a line - 1. Ox1 8 BuffStartAdr[21:7] 15 OxO00 Points to the start of the decompressed contone circular buffer in DRAM, aligned to a half JPEG block boundary. A half JPEG block consists of 4 words of 256-bits, enough to hold 32 contone pixels in 4 colors, i.e. half a JPEG WO 2004/050369 PCT/AU2003/001616 366 block. Ox1 C BuffEndAdr{21:7] 15 OxOOO Points to the start of the last half JPEG block at the end of the decompressed contone circular buffer in DRAM, aligned to a half JPEG block boundary. A half JPEG block consists of 4 words of 256-bits, enough to hold 32 contone pixels in 4 colors, i.e. half a JPEG block. Ox20 NumBuffLines[6:2 5 0x03 Defines size of buffer in DRAM in terms of the number of decompressed contone lines. The size of the buffer should be a multiple of 4 lines with a minimum size of 8 lines. Ox24 BypassJpg 1 Ox0 Determines whether or not the JPEG decoder will be bypassed (and hence pixels are copied directly from input to output) 0 - don't bypass, 1 - bypass Should not be changed between bands. Ox30 NextBandCurr- 17 OxO_0000 The 256-bit aligned word address SourceAdr[21:5] containing the start of the next band of compressed contone data in DRAM. This value is copied to CurrSourceAdr when both DoneBand is 1 and NextBandEnable is 1, or when Go transitions from 0 to 1. Ox34 NextBandEnd- 19 OxO_0000 The 64-bit aligned word address SourceAdr[21:3] containing the last bytes of the next band of compressed contone data in DRAM. This value is copied to EndSourceAdr when when both DoneBand is 1 and NextBandEnable is 1, or when Go transitions from 0 to 1. Ox38 NextBandValid- 3 Ox0 Indicates the number of valid bytes - I BytesLastFetch in the last 64-bit fetch of the next band of compressed contone data from DRAM. eg 0 implies bits 7:0 are valid, 1 WO 2004/050369 PCT/AU2003/001616 367 implies bits 15:0 are valid, 7 implies all 63:0 bits are valid etc. This value is copied to ValdBytesLastFetch when both DoneBand is 1 and NextBandEnable is 1, or when Go transitions from 0 to 1. Ox3C NextBandEnable 1 Ox0 When NextBandEnable is 1 and DoneBand is 1 -NextBandCurrSourceAdr is copied to CurrSourceAdr, -NextBandEndSourceAdr is copied to EndSourceAdr -NextBandlVaidBytesLastFetch is copied to VaidBytesLastFetch -DoneBand is cleared, -NextBandEnable is cleared. NextBandEnable is cleared when Go is asserted. Note that DoneBand gets cleared regardless of the state of Go. Read-only registers 0x40 DoneBand I Ox0 Specifies whether or not the current band has finished loading into the local FIFO. It is cleared to 0 when Go transitions from 0 to 1. When the last of the compressed contone data for the band has been loaded into the local FIFO, the cdufinishedband signal is given out and the DoneBand flag is set. If NextBandEnable is 1 at this time then CurrSourceAdr, EndSourceAdr and ValidBytesLastFetch are updated with the values for the next band and DoneBand is cleared. Processing of the next band starts immediately. If NextBandEnable is 0 then the remainder of the CDU will continue to run, decompressing the data already loaded, while the read control unit waits WO 2004/050369 PCT/AU2003/001616 368 for NextBandEnable to be set before it restarts. Ox44 CurrSourceAdr[21 17 OxO_0000 The current 256-bit aligned word :51 address within the current band of compressed contone data in DRAM. Ox48 EndSourceAdr[21 19 OxO_0000 The 64-bit aligned word address :3} containing the last bytes of the current band of compressed contone data in DRAM. Ox4C ValidBytesLastFet 3 Ox00 Indicates the number of valid bytes - 1 ch in the last 64-bit fetch of the current band of compressed contone data from DRAM. eg 0 implies bits 7:0 are valid, 1 implies bits 15:0 are valid, 7 implies all 63:0 bits are valid etc. JPEG decoder core setup registers 0x50 JpgDecMask 5 Ox00 As segments are decoded they can also be output on the DecJpg (JpgDecHdr) port with the user selecting the segments for output by setting bits in the jpgDecMask port as follows: 4 SOF+SOS+DNL 3 COM+APP 2 DRI 1 DQT 0 DHT If any one of the bits of jpgDecMask is asserted then the SO and EOI markers are also passed to the DecJpg port. Ox54 JpgDecTType 1 Ox0 Test type selector: 0 - DCT coefficients displayed on JpgDecTdata 1 - QDCT coefficient displayed on JpgDecTdata 0x58 JpgDecTestEn I Ox0 Signal which causes the memories to be bypassed for test purposes. Ox5C JpgDecPType 4 Ox0 Signal specifying parameters to be placed on port JpgDecPValue (See WO 2004/050369 PCT/AU2003/001616 369 Table ). JPEG decoder core read-only status registers 0x60 JpgDecHdr 8 Ox00 Selected header segments from the JPEG stream that is currently being decoded. Segments selected using JpgMask. Ox64 JpgDecTData 13 OxOOOO 12 - TSOS output of CS1650, indicates the first output byte of the first 8x8 block of the test data. 11 - TSOB output of CS1 650, indicates the first output byte of each 8x8 block of test data. 10-0 - 11-bit output test data port displays DCT coefficients or quantized coefficients depending on value of JpgDecTType. Ox68 JpgDecPValue 16 OxOOO Decoding parameter bus which enables various parameters used by the core to be read. The data available on the PValue port is for information only, and does not contain control signals for the decoder core. Ox6C JpgDecStatus 24 0x00_000 Bit 23 -jpgcorestall (if set, indicates 0 that the JPEG core is stalled by gating of jclk as the output JPEG halfblock double-buffers of the CDU are full) Bit 22 -pix out valid (This signal is an output from the JPEG decoder core and is asserted when a pixel is being output Bits 21-16 - fifocontents (Number of bytes in compressed contone FIFO at the input of CDU which feeds the JPEG decoder core) Bits 15-0 are JPEG decoder status outputs from the CS6150 (see Table for description of bits). 22.5.3 Typical operation The CDU should only be started after the CFU has been started. For the first band of data, users set up NextBandCurrSourceAdr, NextBandEndSourceAdr, NextBandValidBytesLastFetch, and the various MaxPlane, MaxBlock, BuffStartBlockAdr, WO 2004/050369 PCT/AU2003/001616 370 BuffEndBlockAdr and NumBuffLines. Users then set the CDU's Go bit to start processing of the band. When the compressed contone data for the band has finished being read in, the cdufinishedband interrupt will be sent to the PCU and CPU indicating that the memory associated with the first band is now free. Processing can now start on the next band of contone 5 data. In order to process the next band NextBandCurrSourceAdr, NextBandEndSourceAdr and NextBandValidBytesLastFetch need to be updated before finally writing a 1 to NextBandEnable. There are 4 mechanisms for restarting the CDU between bands: a. cdufinishedband causes an interrupt to the CPU. The CDU will have set its DoneBand bit. 10 The CPU reprograms the NextBandCurrSourceAdr, NextBandEndSourceAdr and NextBandValidBytesLastFetch registers, and sets NextBandEnable to restart the CDU. b. The CPU programs the CDU's NextBandCurrSourceAdr, NextBandCurrEndAdr and Next BandValidBytesLastFetch registers and sets the NextBandEnable bit before the end of the cur rent band. At the end of the current band the CDU sets DoneBand. As NextBandEnable is 15 already 1, the CDU starts processing the next band immediately. c. The PCU is programmed so that cdufinishedband triggers the PCU to execute commands from DRAM to reprogram the NextBandCurrSourceAdr, NextBandEndSourceAdr and Next BandValidBytesLastFetch registers and set the NextBandEnable bit to start the CDU processing the next band. The advantage of this scheme is that the CPU could process band 20 headers in advance and store the band commands in DRAM ready for execution. d. This is a combination of b and c above. The PCU (rather than the CPU in b) programs the CDU's NextBandCurrSourceAdr, NextBandCurrEndAdr and NextBandValidBytesLastFetch registers and sets the NextBandEnable bit before the end of the current band. At the end of the current band the CDU sets DoneBand and pulses cdufinishedband. As NextBandEnable is 25 already 1, the CDU starts processing the next band immediately. Simultaneously, cdufinishedband triggers the PCU to fetch commands from DRAM. The CDU will have restarted by the time the PCU has fetched commands from DRAM. The PCU commands program the CDU's next band shadow registers and sets the NextBandEnable bit. If an error occurs in the JPEG stream, the JPEG decoder will suspend its operation, an error bit 30 will be set in the JpgDecStatus register and the core will ignore any input data and await a reset before starting decoding again. An interrupt is sent to the CPU by asserting cdujicujpegerror and the CDU should then be reset by means of a write to its Reset register before a new page can be printed. 22.5.4 Read control unit 35 The read control unit is responsible for reading the compressed contone data and passing it to the JPEG decoder via the FIFO. The compressed contone data is read from DRAM in single 256-bit accesses, receiving the data from the DIU over 4 clock cycles (64-bits per cycle). The protocol and timing for read accesses to DRAM is described in section 20.9.1 on page 269. Read accesses to DRAM are implemented by means of the state machine described in Figure 138.
WO 2004/050369 PCT/AU2003/001616 371 All counters and flags should be cleared after reset. When Go transitions from 0 to 1 all counters and flags should take their initial value. While the Go bit is set, the state machine relies on the DoneBand bit to tell it whether to attempt to read a band of compressed contone data. When DoneBand is set, the state machine does nothing. When DoneBand is clear, the state machine 5 continues to load data into the JPEG input FIFO up to 256-bits at a time while there is space available in the FIFO. Note that the state machine has no knowledge about numbers of blocks or numbers of color planes - it merely keeps the JPEG input FIFO full by consecutive reads from DRAM. The DIU is responsible for ensuring that DRAM requests are satisfied at least at the peak DRAM read bandwidth of 0.36 bits/cycle (see section 22.3 on page 359). 10 A modulo 4 counter, rdcount, is use to count each of the 64-bits received in a 256-bit read access. It is incremented whenever diucdurvalid is asserted. As each 64-bit value is returned, indicated by diu cdurvalid being asserted, currsourceadr is compared to both endsourceadr and end of bandstore: * If {curr sourceadr rd_count} equals endsourceadr, the endofband control signal sent 15 to the FIFO is I (to signify the end of the band), the finishedCDUBand signal is output, and the DoneBand bit is set. The remaining 64-bit values in the burst from the DIU are ignored, i.e. they are not written into the FIFO. " If rdcount equals 3 and {curr sourceadr rd_count} does not equal endsourceadr, then currsource-adr is updated to be either startofbandstore or currsourceadr + 1, 20 depending on whether currsourceadr also equals end ofbandstore. The endofband control signal sent to the FIFO is 0. currsourceadr is output to the DIU as cdu diuradr. A count is kept of the number of 64-bit values in the FIFO. When diu_ cdu_rvalid is 1 and ignoredata is 0, data is written to the FIFO by asserting FifoWr, and fifocontents[3:0] and 25 fifowr adr[2:0] are both incremented. When fifocontents[3:0] is greater than 0, jpg in strb is asserted to indicate that there is data available in the FIFO for the JPEG decoder core. The JPEG decoder core assertsjpg inrdy when it is ready to receive data from the FIFO. Note it is also possible to bypass the JPEG decoder core by setting the BypassJpg register to 1. In this case data is sent directly from the 30 FIFO to the half-block double-buffer. While the JPEG decoder is not stalled (jpgcore stall equal 0), and jpgin rdy (or bypassjpg) and jpgin strb are both 1, a byte of data is consumed by the JPEG decoder core. fiford adr[5:0] is then incremented to select the next byte. The read address is byte aligned, i.e. the upper 3 bits are input as the read address for the FIFO and the lower 3 bits are used to select a byte from the 64 bits. If fifo_rd_adr[2:0] = 111 then the next 64-bit 35 value is read from the FIFO by asserting fifo_rd, and fifocontents[3:0] is decremented. 22.5.5 Compressed contone FIFO The compressed contone FIFO conceptually is a 64-bit input, and 8-bit output FIFO to account for the 64-bit data transfers from the DIU, and the 8-bit requirement of the JPEG decoder. In reality, the FIFO is actually 8 entries deep and 65-bits wide (to accommodate two 256-bit 40 accesses), with bits 63-0 carrying data, and bit 64 containing a 1-bit endofband flag. Whenever WO 2004/050369 PCT/AU2003/001616 372 64-bit data is written to the FIFO from the DIU, an endof_ band flag is also passed in from the read control unit. The endofband bit is I if this is the last data transfer for the current band, and 0 if it is not the last transfer. When endofband= 1 during an input, the VaidBytesLastFetch register is also copied to an image version of the same. 5 On the JPEG decoder side of the FIFO, the read address is byte aligned, i.e. the upper 3 bits are input as the read address for the FIFO and the lower 3 bits are used to select a byte from the 64 bits (1st byte corresponds to bits 7-0, second byte to bits 15-8 etc.). If bit 64 is set on the read, bits 63-0 contain the end of the bytestream for that band, and only the bytes specified by the image of ValidBytesLastFetch are valid bytes to be read and presented to the JPEG decoder. 10 Note that ValidBytesLastFetch is copied to an image register as it may be possible for the CDU to be reprogrammed for the next band before the previous band's compressed contone data has been read from the FIFO (as an additional effect of this, the CDU has a non-problematic limitation in that each band of contone data must be more than 4 x 64-bits, or 32 bytes, in length). 22.5.6 CS6150 JPEG decoder 15 JPEG decoder functionality is implemented by means of a modified version of the Amphion CS6150 JPEG decoder core. The decoder is run at a nominal clock speed of 160 MHz. (Amphion have stated that the CS6150 JPEG decoder core can run at 185 MHz in 0.1 3um technology). The core is clocked byjc/k which a gated version of the system clock pclk. Gating the clock provides a mechanism for stalling the JPEG decoder on a single color pixel-by-pixel basis. Control of the flow 20 of output data is also provided by the PixOutEnab input to the JPEG decoder. However, this only allows stalling of the output at a JPEG block boundary and is insufficient for SoPEC. Thus gating of the clock is employed and PixOutEnab is instead tied high. The CS6150 decoder automatically extracts all relevant parameters from the JPEG bytestream and uses them to control the decoding of the image. The JPEG bytestream contains data for the 25 Huffman tables, quantization tables, restart interval definition and frame and scan headers. The decoder parses and checks the JPEG bytestream automatically detecting and processing all the JPEG marker segments. After identifying the JPEG segments the decoder re-directs the data to the appropriate units to be stored or processed as appropriate. Any errors detected in the bytestream, apart from those in the entropy coded segments, are signalled and, if an error is 30 found, the decoder stops reading the JPEG stream and waits to be reset. JPEG images must have their data stored in interleaved format with no subsampling. Images longer than 65536 lines are allowed: these must have an initial imageHeight of 0. If the image has a Define Number Lines (DNL) marker at the end (normally necessary for standard JPEG, but not necessary for SoPEC's version of the CS6150), it must be equal to the total image height mod 35 64k or an error will be generated. See the CS6150 Databook [21] for more details on how the core is used, and for timing diagrams of the interfaces. Note that [21] does not describe the use of the DNL marker in images of more than 64k lines length as this is a modification to the core. The CS6150 decoder can be bypassed by setting the BypassJpg register. If this register is set, 40 then the data read from DRAM must be in the same format as if it was produced by the JPEG WO 2004/050369 PCT/AU2003/001616 373 decoder: 8x8 blocks of pixels in the correct color order. The data is uncompressed and is therefore lossless. The following subsections describe the means by which the CS6150 internals can be made visible. 5 22.5.6.1 JPEG decoder reset The JPEG decoder has 2 possible types of reset, an asynchronous reset and a synchronous clear. In SoPEC the asynchronous reset is connected to the hardware synchronous reset of the CDU and can be activated by any hardware reset to SoPEC (either from external pin or from any of the wake-up sources, e.g. USB activity, Wake-up register timeout) or by resetting the PEP 10 section (ResetSection register in the CPR block). The synchronous clear is connected to the software reset of the CDU and can be activated by the low to high transition of the Go register, or a software reset via the Reset register. The 2 types of reset differ, in that the asynchronous reset, resets the JPEG core and causes the core to enter a memory initialization sequence that takes 384 clock cycles to complete after the 15 reset is deasserted. The synchronous clear resets the core, but leaves the memory as is. This has some implications for programming the CDU. In general the CDU should not be started (i.e. setting Go to 1) until at least 384 cycles after a hardware reset. If the CDU is started before then, the memory initialization sequence will be terminated leaving the JPEG core memory in an unknown state. This is allowed if the memory is 20 to be initialized from the incoming JPEG stream. 22.5.6.2 JPEG decoder parameter bus The decoding parameter bus JpgDecPValue is a 16-bit port used to output various parameters extracted from the input data stream and currently used by the core. The 4-bit selector input (JpgDecPType) determines which internal parameters are displayed on the parameter bus as per 25 Table 148. The data available on the PValue port does not contain control signals used by the CS6150. Table 148. Parameter bus definitions PType Output orientation PValue Ox0 FY[1 5:0] FY: number of lines in frame Ox1 FX[1 5:0] FX: number of columns in frame Ox2 00_YMCU[13:0] YMCU: number of MCUs in Y direction of the current scan Ox3 00_XMCU[1 3:0] XMCU: number of MCUs in X direction of the current scan Ox4 Cs0[7:0]JTq0[1:0]_VO CsO: identifier for the first scan component [2:0] _HO[2:0] TqO: quantization table identifier for the first scan compo nent V0: vertical sampling factor for the first scan component. Values = 1-4 HO: horizontal sampling factor for the first scan component.
WO 2004/050369 PCT/AU2003/001616 374 Values = 1-4 Ox5 Cs1[7:0]_Tq1[1:0)_V1 Cs1, Tq1, V1 and H1 for the second scan component. [2:0] _H1[2:0] V1, Hi undefined if NS<2 Ox6 Cs2[7:0]_Tq2[1:0]_V2 Cs2, Tq2, V2 and H2 for the second scan component. [2:0] _H2[2:0] V2, H2 undefined if NS<3 Ox7 Cs3[7:0]_Tq3[1:0]_V3 Cs3, Tq3, V3 and H3 for the second scan component. [2:0] _H3[2:0] V3, H3 undefined if NS<4 0x8 CsH[15:0] CsH: no. of rows in current scan Ox9 CsV[15:0] CsV: no. of columns in current scan OxA DRI[1 5:0] DRi: restart interval OxB 000_HMAX[2:0]_VMA HMAX: maximal horizontal sampling factor in frame VMAX: X[2: 0]_ maximal vertical sampling factor in frame MCUBLK: MCUBLK[3:ONS[2:0 number of blocks per MCU of the current scan, from 1 to 10 NS: number of scan components in current scan, 1-4 22.5.6.3 JPEG decoder status register The status register flags indicate the current state of the CS6150 operation. When an error is detected during the decoding process, the decompression process in the JPEG decoder is suspended and an interrupt is sent to the CPU by asserting cdu icujpegerror (generated from 5 DecError). The CPU can check the source of the error by reading the JpgDecStatus register. The CS6150 waits until a reset process is invoked by asserting the hard reset prst n or by a soft reset of the CDU. The individual bits of JpgDecStatus are set to zero at reset and active high to indicate an error condition as defined in Table 149. Note: A DecHfError will not block the input as the core will try to recover and produce the correct 10 amount of pixel data. The DecHfError is cleared automatically at the start of the next image and so no intervention is required from the user. If any of the other errors occur in the decode mode then, following the error cancellation, the core will discard all input data until the next Start Of Image (SOl) without triggering any more errors. The progress of the decoding can be monitored by observing the values of Tb/Def, IDctInProg, 1 5 DecinProg and JpglnProg. Table 149. JPEG decoder status register definitions Bit Name Description 15 - 12 TblDef[7:4] Indicates the number of Huffman tables defined, 1bit/table. 11 - 8 TblDef[3:0] Indicates the number of quantization tables defined, I bit/table. 7 DecHfError Set when an undefined Huffman table symbol is referenced during decoding. 6 CtlError Set when an invalid SOF parameter or an invalid SOS parameter is detected. Also set when there is a mismatch between the DNL segment input WO 2004/050369 PCT/AU2003/001616 375 to the core and the number of lines in the input image which have already been decoded. Note that SoPEC's implementation of the CS6150 does not require a final DNL when the initial setting for ImageHeight is 0. This is to allow images longer than 64k lines. 5 HtError Set when an invalid DHT segment is detected. 4 QtError Set when an invalid DQT segment is detected. 3 DecError Set when anything other than a JPEG marker is input. Set when any of DecFlags[6:4] are set. Set when any data other than the SOI marker is detected at the start of a stream. Set when any SOF marker is detected other than SOFO. Set if incomplete Huffman or quantization definition is detected. 2 lDctInProg Set when IDCT starts processing first data of a scan. Cleared when IDCT has processed the last data of a scan. 1 DecinProg For each scan this signal is asserted after the SigSOS (Start of Scan Segment) signal has been output from the core and is de asserted when the decoding of a scan is complete. It indicates that the core is in the decoding state. 0 JpginProg Set when core starts to process input data (Jpgln) and de-asserted when decoding has been completed i.e. when the last pixel of last block of the image is output. 22.5.7 Half-block buffer interface Since the CDU writes 256 bits (4 x 64 bits) to memory at a time, it requires a double-buffer of 2 x 256 bits at its output. This is implemented in an 8 x 64 bit FIFO. It is required to be able to stall the JPEG decoder core at its output on a half JPEG block boundary, i.e. after 32 pixels (8 bits per 5 pixel). We provide a mechanism for stalling the JPEG decoder core by gating the clock to the core(with jclk enable) when the FIFO is full. The output FIFO is responsible for providing two buffered half JPEG blocks to decouple JPEG decoding (read control unit) from writing those JPEG blocks to DRAM (write control unit). Data coming in is in 8-bit quantities but data going out is in 64-bit quantities for a single color plane. 10 22.5.8 Write control unit A line of JPEG blocks in 4 colors, or 8 lines of decompressed contone data, is stored in DRAM with the memory arrangement as shown Figure 139.The arrangement is in order to optimize access for reads by writing the data so that 4 color components are stored together in each 256 bit DRAM word. 15 The CDU writes 8 lines of data in parallel but stores the first 4 lines and second 4 lines separately in DRAM. The write sequence for a single line of JPEG 8x8 blocks in 4 colors, as shown in Figure 139, is as follows below and corresponds to the order in which pixels are output from the JPEG decoder core: WO 2004/050369 PCT/AU2003/001616 376 block 0, color 0, line 0 in word p bits 63-0, line 1 in word p+1 bits 63-0, line 2 in word p+2 bits 63-0, line 3 in word p+3 bits 63-0, 5 block 0, color 0, line 4 in word q bits 63-0, line 5 in word q+1 bits 63-0, line 6 in word q+2 bits 63-0, line 7 in word q+3 bits 63-0, 10 block 0, color 1, line 0 in word p bits 127-64, line 1 in word p+1 bits 127-64, line 2 in word p+2 bits 127-64, line 3 in word p+3 bits 127-64, 15 block 0, color 1, line 4 in word q bits 127-64, line 5 in word q+1 bits 127-64, line 6 in word q+2 bits 127-64, line 7 in word q+3 bits 127-64, 20 repeat for block 0 color 2, block 0 color 3........ block 1, color 0, line 0 in word p+4 bits 63-0, line 1 in word p+5 bits 63-0, 25 etc................................................... block N, color 3, line 4 in word q+4n bits 255-192, line 5 in word q+4n+l bits 255-192, 30 line 6 in word q+4n+2 bits 255 192, line 7 in word q+4n+3 bit 255-192 In SoPEC data is written to DRAM 256 bits at a time. The DIU receives a 64-bit aligned address from the CDU, i.e. the lower 2 bits indicate which 64-bits within a 256-bit location are being written to. With that address the DIU also receives half a JPEG block (4 lines) in a single color, 4 x 64 bits 35 over 4 cycles. All accesses to DRAM must be padded to 256 bits or the bits which should not be written are masked using the individual bit write inputs of the DRAM. When writing decompressed contone data from the CDU, only 64 bits out of the 256-bit access to DRAM are valid, and the remaining bits of the write are masked by the DIU. This means that the decompressed contone data is written to DRAM in 4 back-to-back 64-bit write masked accesses to 4 consecutive 256-bit 40 DRAM locations/words.
WO 2004/050369 PCT/AU2003/001616 377 Writing of decompressed contone data to DRAM is implemented by the state machine in Figure 140. The CDU writes the decompressed contone data to DRAM half a JPEG block at a time, 4 x 64 bits over 4 cycles. All counters and flags should be cleared after reset. When Go transitions from 0 to 1 all counters and flags should take their initial value. While the Go bit is set, the state 5 machine relies on the halfblockoktoread and linestoreokto-write flags to tell it whether to attempt to write a half JPEG block to DRAM. Once the half-block buffer interface contains a half JPEG block, the state machine requests a write access to DRAM by asserting cdu diu wreq and providing the write address, corresponding to the first 64-bit value to be written, on cdudiuwadr (only the address the first 64-bit value in each access of 4x64 bits is issued by the CDU. The DIU 10 can generate the addresses for the second, third and fourth 64-bit values). The state machine then waits to receive an acknowledge from the DIU before initiating a read of 4 64-bit values from the half-block buffer interface by asserting rdadv for 4 cycles. The output cdudiuwvalid is asserted in the cycle after rd adv to indicate to the DIU that valid data is present on the cdudiudata bus and should be written to the specified address in DRAM. A rdadv_half block 15 pulse is then sent to the half-block buffer interface to indicate that the current read buffer has been read and should now be available to be written to again. The state machine then returns to the request state. The pseudocode below shows how the write address is calculated on a per clock cycle basis. Note counters and flags should be cleared after reset. When Go transitions from 0 to 1 all 20 counters and flags should be cleared and lwrhalfblock adr gets loaded with buffstartadr and uprhalfblockadr gets loaded with buffstartadr + maxblock + 1. // assign write address output to DRAM cdu diu wadr[6:51 = 00 // corresponds to 25 linenumber, only first address is // issued for each DRAM access. Thus line is always 0. // The DIU generates these bits of the address. 30 cdu diu wadr[4:3) = color if (half == 1) then cdu-diuwadr[21:7] = uprhalfblockadr // for lines 4-7 of JPEG block 35 else cdudiuwadr[21:7] = lwrhalfblockadr // for lines 0-3 of JPEG block // update half, color, block and addresses after each DRAM 40 write access WO 2004/050369 PCT/AU2003/001616 378 if (rd adv half block == 1) then if (half == 1) then half = 0 if (color == max-plane) then 5 color = 0 if (block == max block) then // end of writing a line of JPEG blocks pulse wradv8line block = 0 10 // update half block address for start of next line of JPEG blocks taking // account of address wrapping in circular buffer and 4 line offset 15 if (upr-halfblockadr == buff end adr) then upr-halfblockadr = buffstartadr + max-block + 1 elsif (uprhalfblockadr + maxblock + 1 == buff end adr) then 20 upr-halfblock adr = buff start adr else upr-halfblock adr = uprhalfblockadr + max-block + 2 else 25 block ++ uprhalfblock adr ++ // move to address for lines 4-7 for next block else color ++ 30 else half = 1 if (color == max-plane) then if (block == max-block) then // end of writing a line of JPEG blocks 35 // update half block address for start of next line of JPEG blocks taking // account of address wrapping in circular buffer and 4 line offset 40 if (lwrhalfblockadr == buff end adr) then WO 2004/050369 PCT/AU2003/001616 379 lwr halfblock adr = buff start adr + max-block + 1 elsif (lwr halfblock adr + max-block + 1 buff end adr) then 5 lwr halfblock adr = buff start adr else lwr halfblock adr = lwr halfblock adr + max-block + 2 10 else lwrhalfblockadr ++ // move to address for lines 0-3 for next block 22.5.9 Contone line store interface The contone line store interface is responsible for providing the control over the shared resource 15 in DRAM. The CDU writes 8 lines of data in up to 4 color planes, and the CFU reads them line-at a-time. The contone line store interface provides the mechanism for keeping track of the number of lines stored in DRAM, and provides signals so that a given line cannot be read from until the complete line has been written. The CDU writes 8 lines of data in parallel but writes the first 4 lines and second 4 lines to separate 20 areas in DRAM. Thus, when the CFU has read 4 lines from DRAM that area now becomes free for the CDU to write to. Thus the size of the line store in DRAM should be a multiple of 4 lines. The minimum size of the line store interface is 8 lines, providing a single buffer scheme. Typical sizes are 12 lines for a 1.5 buffer scheme while 16 lines provides a double-buffer scheme. The size of the contone line store is defined by num bufflines. A count is kept of the number of 25 lines stored in DRAM that are available to be written to. When Go transitions from 0 to 1, NumLinesAvail is set to the value of numbufflines. The CDU may only begin to write to DRAM as long as there is space available for 8 lines, indicated when the linestoreok_towrite bit is set. When the CDU has finished writing 8 lines, the write control unit sends an wradv8line pulse to the contone line store interface, and NumLinesA vail is decremented by 8. The write control unit then 30 waits for linestoreoktowrite to be set again. If the contone line store is not empty (has one or more lines available in it), the CDU will indicate to the CFU via the cducfulinestorerdy signal. The cdu_cfu_/inestorerdy signal is generated by comparing the NumLinesAvail with the programmed numbufflines. As the CFU reads a line from the contone line store it will pulse the rdadvline to indicate that it has read a full line from the 35 line store. NumLinesAvail is incremented by I on receiving a rdadvline pulse. To enable running the CDU while the CFU is not running the NumLinesA vail register can also be updated via the configuration register interface. In this scenario the CPU polls the value of the NumLinesAvail register and overwrites it to prevent stalling of the CDU (NumLinesAvai < 8). The CPU will always have priority in any updating of the NumLinesAvail register. 40 23 Contone FIFO Unit (CFU) WO 2004/050369 PCT/AU2003/001616 380 23.1 OVERVIEW The Contone FIFO Unit (CFU) is responsible for reading the decompressed contone data layer from the circular buffer in DRAM, performing optional color conversion from YCrCb to RGB followed by optional color inversion in up to 4 color planes, and then feeding the data on to the 5 HCU. Scaling of data is performed in the horizontal and vertical directions by the CFU so that the output to the HCU matches the printer resolution. Non-integer scaling is supported in both the horizontal and vertical directions. Typically, the scale factor will be the same in both directions but may be programmed to be different. 23.2 BANDWIDTH REQUIREMENTS 10 The CFU must read the contone data from DRAM fast enough to match the rate at which the contone data is consumed by the HCU. Pixels of contone data are replicated a X scale factor (SF) number of times in the X direction and Y scale factor (SF) number of times in the Y direction to convert the final output to 1600 dpi. Replication in the X direction is performed at the output of the CFU on a pixel-by-pixel basis while 15 replication in the Y direction is performed by the CFU reading each line a number of times, according to the Y-scale factor, from DRAM. The HCU generates 1 dot (bi-level in 6 colors) per system clock cycle to achieve a print speed of 1 side per 2 seconds for full bleed A4/Letter printing. The CFU output buffer needs to be supplied with a 4 color contone pixel (32 bits) every SF cycles. With support for 4 colors at 267 ppi the CFU must read data from DRAM at 5.33 20 bits/cycle". 23.3 COLOR SPACE CONVERSION The CFU allows the contone data to be passed directly on, which will be the case if the color represented by each color plane in the JPEG image is an available ink. For example, the four colors may be C, M, Y, and K, directly represented by CMYK inks. The four colors may represent 25 gold, metallic green etc. for multi-SoPEC printing with exact colors. JPEG produces better compression ratios for a given visible quality when luminance and chrominance channels are separated. With CMYK, K can be considered to be luminance, but C, M and Y each contain luminance information and so would need to be compressed with appropriate luminance tables. We therefore provide the means by which CMY can be passed to 30 SoPEC as YCrCb. K does not need color conversion. When being JPEG compressed, CMY is typically converted to RGB, then to YCrCb and then finally JPEG compressed. At decompression, the YCrCb data is obtained, then color converted to RGB, and finally back to CMY. The external RIP provides conversion from RGB to YCrCb, specifically to match the actual 35 hardware implementation of the inverse transform within SoPEC, as per CCIR 601-2 [24] except that Y, Cr and Cb are normalized to occupy all 256 levels of an 8-bit binary encoding. 1432 bits / 6 cycles = 5.33 bits/cycle WO 2004/050369 PCT/AU2003/001616 381 The CFU provides the translation to either RGB or CMY. RGB is included since it is a necessary step to produce CMY, and some printers increase their color gamut by including RGB inks as well as CMYK. Consequently the JPEG stream in the color space convertor is one of: 5 e 1 color plane, no color space conversion * 2 color planes, no color space conversion * 3 color planes, no color space conversion * 3 color planes YCrCb, conversion to RGB * 4 color planes, no color space conversion 10 * 4 color planes YCrCbX, conversion of YCrCb to RGB, no color conversion of X The YCrCb to RGB conversion is described in [14]. Note that if the data is non-compressed, there is no specific advantage in performing color conversion (although the CDU and CFU do permit it). 23.4 COLOR SPACE INVERSION In addition to performing optional color conversion the CFU also provides for optional bit-wise inversion in 15 up to 4 color planes. This provides the means by which the conversion to CMY may be finalised, or to may be used to provide planar correlation of the dither matrices. The RGB to CMY conversion is given by the relationship: " C = 255 - R * M = 255 - G 20 - Y=255-B These relationships require the page RIP to calculate the RGB from CMY as follows: " R=255-C * G=255-M " B=255-Y 25 23.5 SCALING Scaling of pixel data is performed in the horizontal and vertical directions by the CFU so that the output to the HCU matches the printer resolution. The CFU supports non-integer scaling with the scale factor represented by a numerator and a denominator. Only scaling up of the pixel data is allowed, i.e. the numerator should be greater than or equal to the denominator. For example, to 30 scale up by a factor of two and a half, the numerator is programmed as 5 and the denominator programmed as 2. Scaling is implemented using a counter as described in the pseudocode below. An advance pulse is generated to move to the next dot (x-scaling) or line (y-scaling). 35 if (count + denominator - numerator >= 0) then count = count + denominator - numerator advance = 1 else count = count + denominator 40 advance = 0 WO 2004/050369 PCT/AU2003/001616 382 23.6 LEAD-IN AND LEAD-OUT CLIPPING The JPEG algorithm encodes data on a block by block basis, each block consists of 64 8-bit pixels (representing 8 rows each of 8 pixels). If the image is not a multiple of 8 pixels in X and Y then padding must be present. This padding (extra pixels) will be present after decoding of the 5 JPEG bytestream. Extra padded lines in the Y direction (which may get scaled up in the CFU) will be ignored in the HCU through the setting of the BottomMargin register. Extra padded pixels in the X direction must also be removed so that the contone layer is clipped to the target page as necessary. 10 In the case of a multi-SoPEC system, 2 SoPECs may be responsible for printing the same side of a page, e.g. SoPEC #1 controls printing of the left side of the page and SoPEC #2 controls printing of the right side of the page and shown in Figure 141. The division of the contone layer between the 2 SoPECs may not fall on a 8 pixel (JPEG block) boundary. The JPEG block on the boundary of the 2 SoPECs (JPEG block n below) will be the last JPEG block in the line printed by 15 SoPEC #1 and the first JPEG block in the line printed by SoPEC #2. Pixels in this JPEG block not destined for SoPEC #1 are ignored by appropriately setting the LeadOutClipNum. Pixels in this JPEG block not destined for SoPEC #2 must be ignored at the beginning of each line. The number of pixels to be ignored at the start of each line is specified by the Lead/nClipNum register. It may also be the case that the CDU writes out more JPEG blocks than is required to be read by 20 the CFU, as shown for SoPEC #2 below. In this case the value of the MaxBlock register in the CDU is set to correspond to JPEG block m but the value for the MaxBlock register in the CFU is set to correspond to JPEG block rn-1. Thus JPEG block m is not read in by the CFU. Additional clipping on contone pixels is required when they are scaled up to the printer's resolution. The scaling of the first valid pixel in the line is controlled by setting the XstartCount 25 register. The HcuLineLength register defines the size of the target page for the contone layer at the printer's resolution and controls the scaling of the last valid pixel in a line sent to the HCU. 23.7 IMPLEMENTATION Figure 142 shows a block diagram of the CFU. 23.7.1 Definitions of 1/O 30 Table 150. CFU port list and description Port Name Pins I/O Description Clocks and reset pclk I In System clock prstn 1 In System reset, synchronous active low. PCU interface pcucfusel 1 In Block select from the PCU. When pcu cfusel is high both pcu adr and pcu-dataout are valid. pcu_rwn 1 In Common read/not-write signal from the PCU.
WO 2004/050369 PCT/AU2003/001616 383 pcu-adr[6:2] 4 In PCU address bus. Only 5 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. cfu_pcurdy 1 Out Ready signal to the PCU. When cfu pcu rdy is high it indicates the last cycle of the access. For a write cycle this means pcu dataout has been registered by the block and for a read cycle this means the data on cfupcu-datain is valid. cfu_pcu datain[31:01 32 Out Read data bus to the PCU. DIU interface cfudiu-rreq 1 Out CFU read request, active high. A read request must be accompanied by a valid read address. diu cfu rack 1 In Acknowledge from DIU, active high. Indicates that a read request has been accepted and the new read address can be placed on the address bus, cfu diu radr. cfu diu radr[21:5] 17 Out CFU read address. 17 bits wide (256-bit aligned word). diucfurvalid 1 In Read data valid, active high. Indicates that valid read data is now on the read data bus, diu data. diu-data[63:0] 64 In Read data from DRAM. CDU interface cducfulinestore rdy 1 In When high indicates that the contone line store has 1 or more lines available to be read by the CFU. cfucdurdadvline 1 Out Read line pulse, active high. Indicates that the CFU has finished reading a line of decompressed contone data to the circular buffer in DRAM and that line of the buffer is now free. HCU interface hcu cfu advdot 1 In Informs the CFU that the HCU has captured the pixel data on cfu_hcu c[0-3]data lines and the CFU can now place the next pixel on the data lines. cfuhcuavail 1 Out Indicates valid data present on cfuhcu-c[0-3]data lines. cfuhcu cOdata[7:0] 8 Out Pixel of data in contone plane 0. cfuhcu_cidata[7:0] 8 Out Pixel of data in contone plane 1. cfuhcuc2data[7:0] 8 Out Pixel of data in contone plane 2. cfuhcuc3data[7:0] 8 Out Pixel of data in contone plane 3. 23.7.2 Configuration registers WO 2004/050369 PCT/AU2003/001616 384 The configuration registers in the CFU are programmed via the PCU interface. Refer to section 21.8.2 on page 351 for the description of the protocol and timing diagrams for reading and writing registers in the CFU. Note that since addresses in SoPEC are byte aligned and the PCU only supports 32-bit register reads and writes, the lower 2 bits of the PCU address bus are not required 5 to decode the address space for the CFU. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of cfu pcu datain. The configuration registers of the CFU are listed in Table 151: Table 151. CFU registers Address Register Name #bits Value Description (CFU base +) on Reset Control registers Ox00 Reset I OxI A write to this register causes a reset of the CFU. Ox04 Go 1 Ox0 Writing 1 to this register starts the CFU. riting 0 to this register halts the CFU. When Go is deasserted the state machines go to their idle states but all counters and configuration registers keep their values. When Go is asserted all counters are reset, but configuration registers keep their values (i.e. they don't get reset). The CFU must be started before the CDU is started. This register can be read to determine if the CFU is running (1 - running, 0 - stopped). Setup registers Ox10 MaxBlock 13 OxOO Number of JPEG MCUs (or JPEG block equivalents, i.e. 8x8 bytes) in a line - 1. Ox14 BuffStartAdr[21:7] 15 OxOOO Points to the start of the decompressed contone circular buffer in DRAM, aligned to a half JPEG block boundary. A half JPEG block consists of 4 words of 256-bits, enough to hold 32 contone pixels in 4 colors, i.e. half a JPEG WO 2004/050369 PCT/AU2003/001616 385 block. Ox1 8 BuffEndAdr[2l:7] 15 OxOOOO Points to the end of the decompressed contone circular buffer in DRAM, aligned to a half JPEG block boundary (address is inclusive). A half JPEG block consists of 4 words of 256-bits, enough to hold 32 contone pixels in 4 colors, i.e. half a JPEG block. Ox1 C 4LineOffset 13 OxOOOO Defines the offset between the start of one 4 line store to the start of the next 4 line store - 1. In Figure n page394 on page Error! Bookmark not defined., if BufStartAdr corresponds to line 0 block 0 then BuffStartAdr + 4LineOffset corresponds to line 4 block 0. 4LineOffset is specified in units ofl 28 bytes, eg 0 - 128 bytes,1 - 256 bytes etc. This register is required in addition to MaxBlock as the number of JPEG blocks in a line required by the CFU may be different from the number of JPEG blocks in a line written by the CDU. Ox20 YCrCb2RGB 1 Ox0 Set this bit to enable conversion from YCrCb to RGB. Should not be changed between bands. Ox24 InvertColorPlane 4 OxO Set these bits to perform bit-wise inversion on a per color plane basis. bitO - 1 invert color plane 0 - 0 do not convert bit1 - 1 invert color plane 1 - 0 do not convert bit2 - I invert color plane 2 - 0 do not convert bit3 - 1 invert color plane 3 Should not be changed between bands.
WO 2004/050369 PCT/AU2003/001616 386 Ox28 HcuLineLength 16 OxOOO Number of contone pixels - 1 in a line (after scaling). Equals the number of hcu cfudotadv pulses - 1 received from the HCU for each line of contone data. Ox2C LeadInClipNum 3 Ox0 Number of contone pixels to be ignored at the start of a line (from JPEG block 0 in a line). They are not passed to the output buffer to be scaled in the X direction. Ox30 LeadOutClipNum 3 Ox0 Number of contone pixels to be ignored at the end of a line (from JPEG block MaxBlock in a line). They are not passed to the output buffer to be scaled in the X direction. 0x34 XstartCount 8 Ox00 Value to be loaded at the start of every line into the counter used for scaling in the X direction. Used to control the scaling of the first pixel in a line to be sent to the HCU. This value will typically be zero, except in the case where a number of dots are clipped on the lead in to a line. Ox38 XscaleNum 8 Ox01 Numerator of contone scale factor in X direction. Ox3C XscaleDenom 8 Ox01 Denominator of contone scale factor in X direction. Ox40 YscaleNum 8 Ox01 Numerator of contone scale factor in Y direction. Ox44 YscaleDenom 8 Ox01 Denominator of contone scale factor in Y direction. 23.7.3 Storage of decompressed contone data in DRAM The CFU reads decompressed contone data from DRAM in single 256-bit accesses. JPEG blocks of decompressed contone data are stored in DRAM with the memory arrangement as shown The arrangement is in order to optimize access for reads by writing the data so that 4 color 5 components are stored together in each 256-bit DRAM word. The means that the CFU reads 64 bits in 4 colors from a single line in each 256-bit DRAM access. The CFU reads data line at a time in 4 colors from DRAM. The read sequence, as shown in Figure 143, is as follows: WO 2004/050369 PCT/AU2003/001616 387 line 0, block 0 in word p of DRAM line 0, block 1 in word p+4 of DRAM line 0, block n in word p+4n of DRAM 5 (repeat to read line a number of times according to scale factor) line 1, block 0 in word p+1 of DRAM line 1, block 1 in word p+5 of DRAM 10 etc...................................... The CFU reads a complete line in up to 4 colors a Y scale factor number of times from DRAM before it moves on to read the next. When the CFU has finished reading 4 lines of contone data that 4 line store becomes available for the CDU to write to. 23.7.4 Decompressed contone buffer 15 Since the CFU reads 256 bits (4 colors x 64 bits) from memory at a time, it requires storage of at least 2 x 256 bits at its input. To allow for all possible DIU stall conditions the input buffer is increased to 3 x 256 bits to meet the CFU target bandwidth requirements. The CFU receives the data from the DIU over 4 clock cycles (64-bits of a single color per cycle). It is implemented as 4 buffers. Each buffer conceptually is a 64-bit input and 8-bit output buffer to account for the 64-bit 20 data transfers from the DIU, and the 8-bit output per color plane to the color space converter. On the DRAM side, wr buff indicates the current buffer within each triple-buffer that writes are to occur to. wrset selects which triple-buffer to write the 64 bits of data to when wr en is asserted. On the color space converter side, rdbuff indicates the current buffer within each triple-buffer that reads are to occur from. When rden is asserted a byte is read from each of the triple-buffers in 25 parallel. rdsel is used to select a byte from the 64 bits (1st byte corresponds to bits 7-0, second byte to bits 15-8 etc.). Due to the limitations of available register arrays in IBM technology, the decompressed contone buffer is implemented as a quadruple buffer. While this offers some benefits for the CFU it is not necessitated by the bandwidth requirements of the CFU. 30 23.7.5 Y-scaling control unit The Y-scaling control unit is responsible for reading the decompressed contone data and passing it to the color space converter via the decompressed contone buffer. The decompressed contone data is read from DRAM in single 256-bit accesses, receiving the data from the DIU over 4 clock cycles (64-bits per cycle). The protocol and timing for read accesses to DRAM is described in 35 section 20.9.1 on page 269. Read accesses to DRAM are implemented by means of the state machine described in Figure 144. All counters and flags should be cleared after reset. When Go transitions from 0 to 1 all counters and flags should take their initial value. While the Go bit is set, the state machine relies on the line8_oktoread and buffoktowrite flags to tell it whether to attempt to read a line of 40 compressed contone data from DRAM. When line8_oktoread is 0 the state machine does WO 2004/050369 PCT/AU2003/001616 388 nothing. When line8_oktoread is 1 the state machine continues to load data into the decompressed contone buffer up to 256-bits at a time while there is space available in the buffer. A bit is kept for the status of each 64-bit buffer: buffavail[O] and buffaval[1]. It also keeps a single bit ( rdbuff) for the current buffer that reads are to occur from, and a single bit (wr buff) for 5 the current buffer that writes are to occur to. buffoktowrite equals -buff aval[wr_buffl. When a wradvDuff pulse is received, buff avail[wrbuff] is set, and wrbuff is inverted. Whenever diucfurvalid is asserted, wren is asserted to write the 64-bits dt data from DRAM to the buffer selected by wrsel and wrbuff. 10 buffoktoread equals buff avail[rdbuffj. If there is data available in the buffer and the output double-buffer has space available (outbuff oktowriteequals 1) then data is read from the buffer by asserting rd_en and rdsel gets inremented to point to the next value. wradv is asserted in the following cycle to wrte the data to the output double-buffer of the CFU. When finished reading the suffer, 15 rd sel equals b11 and rd_en is asserted, buffavail[rd buff] is set, and rfbuff is inverted. Each line is read a number of times from DRAM, according to the Y-scale factor, before tl'e CFU moves on to start reading the next line of decompressed contone data. Scaling to the printbad resolution in the Y direction is thus performed. 20 The pseudocode below shows how the read address from DRAM is calculated on a per clok cycle basis. Note all counters and flags should be cleared after reset or when Go is cleared When a 1 is written to Go, both currhalfblock and linestarthalfblock get loaded with buffstart adr, and y scale-count gets loaded with yscale_denom. Scaling in the Y directiolis implemented by line replication by re-reading lines from DRAM. The algorithm for non-integer 25 scaling is described in the pseudocode below. // assign read address output to DRAM cdudiuwadr[21:7] = currhalfblock cdu diu wadr[6:5] = line[1:0] 30 // update block, line, yscalecount and addresses aftei each DRAM read access if (wr adv buff == 1) then if (block == maxblock) then // end of reading a line 35 of contone in up to 4 colors block = 0 // check whether to advance to next line of contone data in DRAM if (y scale count + yscale-denom - yscale-num >= 0) 40 then WO 2004/050369 PCT/AU2003/001616 389 y_scalecount = y-scalecount + yscaledenom y_scalenum pulse RdAdvline if (line == 3) then // end of reading 4 line 5 store of contone data line = 0 // update half block address for start of next line taking account of // address wrapping in circular buffer and 4 10 line offset if (curr halfblock == buff end adr) then curr halfblock = buff start adr line start adr = buff start adr elsif ((linestartadr + 4lineoffset) == 15 buff end adr)) then curr halfblock = buff start adr line start adr = buff start adr else curr halfblock = line start adr + 20 line offset line start adr = line start adr + 4line offset else line ++ 25 curr halfblock = line start adr else // re-read current line from DRAM y scale count = y_scalecount + y scale_denom curr halfblock line start adr 30 else block ++ curr halfblock ++ 23.7.6 Contone line store interface The contone line store interface is responsible for providing the control over the shared resource 35 in DRAM. The CDU writes 8 lines of data in up to 4 color planes, and the CFU reads them line-at a-time. The contone line store interface provides the mechanism for keeping track of the number of lines stored in DRAM, and provides signals so that a given line cannot be read from until the complete line has been written. A count is kept of the number of lines that have been written to DRAM by the CDU and are 40 available to be read by the CFU. At start-up, buff linesavail is set to the 0. The CFU may only begin to read from DRAM when the CDU has written 8 complete lines of contone data. When the WO 2004/050369 PCT/AU2003/001616 390 CDU has finished writing 8 lines, it sends an cdu_cfu_wradv8/ine pulse to the CFU, and bufflinesavail is incremented by 8. The CFU may continue reading from DRAM as long as buff_linesavail is greater than 0. line8_oktoread is set while buff_linesavail is greater than 0. When it has completely finished reading a line of contone data from DRAM, the Y-scaling control 5 unit sends a RdAdvLine signal to contone line store interface and to the CDU to free up the line in the buffer in DRAM. bufflinesavail is decremented by 1 on receiving a RdAdvine pulse. 23.7.7 Color Space Converter (CSC) The color space converter consists of 2 stages: optional color conversion from YCrCb to RGB followed by optional bit-wise inversion in up to 4 color planes. 10 The convert YCrCb to RGB block takes 3 8-bit inputs defined as Y, Cr, and Cb and outputs either the same data YCrCb or RGB. The YCrCb2RGB parameter is set to enable the conversion step from YCrCb to RGB. If YCrCb2RGB equals 0, the conversion does not take place, and the input pixels are passed to the second stage. The 4th color plane, if present, bypasses the convert YCrCb to RGB block. Note that the latency of the convert YCrCb to RGB block is 1 cycle. This 15 latency should be equalized for the 4th color plane as it bypasses the block. The second stage involves optional bit-wise inversion on a per color plane basis under the control of invert color plane. For example if the input is YCrCbK, then YCrCb2RGB can be set to 1 to convert YCrCb to RGB, and invertcolorjplane can be set to 0111 to then convert the RGB to CMY, leaving K unchanged. 20 If YCrCb2RGB equals 0 and invertcolor plane equals 0000, no color conversion or color inversion will take place, so the output pixels will be the same as the input pixels. Figure 145 shows a block diagram of the color space converter. The convert YCrCb to RGB block is an implementation of [141. Although only 10 bits of coefficients are used (1 sign bit, 1 integer bit, 8 fractional bits), full internal accuracy is maintained 25 with 18 bits. The conversion is implemented as follows: * R* = Y + (359/256)(Cr-1 28) * G* = Y - (1 83/256)(Cr-1 28) - (88/256)(Cb-1 28) * B* = Y + (454/256)(Cb-1 28) R*, G* and B* are rounded to the nearest integer and saturated to the range 0-255 to give R, G 30 and B. Note that, while a Reset results in all-zero output, a zero input gives output RGB = [015, 13616, 01]. 23.7.8 X-scaling control unit The CFU has a 2 x 32-bit double-buffer at its output between the color space converter and the HCU. The X-scaling control unit performs the scaling of the contone data to the printers output 1-179 is saturated to 0 16135.5, with rounding becomes 136. 17227 is saturated to 0 WO 2004/050369 PCT/AU2003/001616 391 resolution, provides the mechanism for keeping track of the current read and write buffers, and ensures that a buffer cannot be read from until it has been written to. A bit is kept for the status of each 32-bit buffer: buffaval[O] and buff avai[1]. It also keeps a single bit (rdbuff) for the current buffer that reads are to occur from, and a single bit (wr buff) for 5 the current buffer that writes are to occur to. The output value outbuffokto write equals -buffavai[wr buff]. Contone pixels are counted as they are received from the Y-scaling control unit, i.e. when wradv is 1. Pixels in the lead-in and lead-out areas are ignored, i.e. they are not written to the output buffer. Lead-in and lead-out clipping of pixels is implemented by the following pseudocode that generates the wr_ en pulse for 10 the output buffer. if (wradv == 1) then if (pixelcount == {maxblock,b111}) then pixelcount = 0 15 else pixelcount ++ ,if ((pixelcount < leadin clip num) OR (pixel count > ({max_block,b111} leadoutclipnum))) then 20 wr en = 0 else wr en = 1 When a wr en pulse is sent to the output double-buffer, buffaval/[wr buff] is set, and wrbuff is inverted. 25 The output cfu hcu avail equals buff avai/[rd_ buff]. When cfu_hcu avail equals 1, this indicates to the HCU that data is available to be read from the CFU. The HCU responds by asserting hcucfu_ advdot to indicate that the HCU has captured the pixel data on cfuhcu c[O-3]data lines and the CFU can now place the next pixel on the data lines. The input pixels from the CSC may be scaled a non-integer number of times in the X direction to 30 produce the output pixels for the HCU at the printhead resolution. Scaling is implemented by pixel replication. The algorithm for non-integer scaling is described in the pseudocode below. Note, x_scale_count should be loaded with xstartcount after reset and at the end of each line. This controls the amount by which the first pixel is scaled by. hcu_linelength and hcucfudotadv control the amount by which the last pixel in a line that is sent to the HCU is scaled by. 35 if (hcucfudotadv == 1) then if (x scalecount + xscaledenom - x scalenum >= 0) then WO 2004/050369 PCT/AU2003/001616 392 x scale count = x scale count + x scale denom x scale num rd en = 1 else 5 x scale count = x scale count + x scale denom rd en = 0 else x scale count = x scale count rd en = 0 10 When a rd en pulse is received, buff avail[rdbuff is cleared, and rdbuff is inverted. A 16-bit counter, dotadv_count, is used to keep a count of the number of hcucfudotadv pulses received from the HCU. If the value of dotadvcount equals hcu _inelength and a hcu_cfu dotadv pulse is received, then a rd-en pulse is genrated to present the next dot at the output of the CFU, dotadv count is reset to 0 and xscalecount is loaded with xstartcount. 15 24 Lossless Bi-level Decoder (LBD) 24.1 OVERVIEW The Lossless Bi-level Decoder (LBD) is responsible for decompressing a single plane of bi-level data. In SoPEC bi-level data is limited to a single spot color (typically black for text and line graphics). 20 The input to the LBD is a single plane of bi-level data, read as a bitstream from DRAM. The LBD is programmed with the start address of the compressed data, the length of the output (decompressed) line, and the number of lines to decompress. Although the requirement for SoPEC is to be able to print text at 10:1 compression, the LBD can cope with any compression ratio if the requested DRAM access is available. A pass-through mode is provided for 1:1 25 compression. Ten-point plain text compresses with a ratio of about 50:1. Lossless bi-level compression across an average page is about 20:1 with 10:1 possible for pages which compress poorly. The output of the LBD is a single plane of decompressed bi-level data. The decompressed bi level data is output to the SFU (Spot FIFO Unit), and in turn becomes an input to the HCU 30 (Halftoner/Compositor unit) for the next stage in the printing pipeline. The LBD also outputs a lbdfinishedband control flag that is used by the PCU and is available as an interrupt to the CPU. 24.2 MAIN FEATURES OF LBD Figure 147 shows a schematic outline of the LBD and SFU. The LBD is required to support compressed images of up to 800 dpi. If possible we would like to 35 support bi-level images of up to 1600 dpi. The line buffers must therefore be long enough to store a complete line at 1600 dpi. The PECI LBD is required to output 2 dots/cycle to the HCU. This throughput capability is retained for SoPEC to minimise changes to the block, although in SoPEC the HCU will only read I dot/cycle. The PECI LDB outputs 16 bits in parallel to the PECI spot buffer. This is also WO 2004/050369 PCT/AU2003/001616 393 retained for SoPEC. Therefore the LBD in SoPEC can run much faster than is required. This is useful for allowing stalls, e.g. due to band processing latency, to be absorbed. The LBD has a pass through mode to cope with local negative compression. Pass through mode is activated by a special run-length code. Pass through mode continues to either end of line or for 5 a pre-programmed number of bits, whichever is shorter. The special run-length code is always executed as a run-length code, followed by pass through. The LBD outputs decompressed bi-level data to the NextLineFIFO in the Spot FIFO Unit (SFU). This stores the decompressed lines in DRAM, with a typical minimum of 2 lines stored in DRAM, nominally 3 lines up to a programmable number of lines. The SFU's NextLineFIFO can fill while 10 the SFU waits for write access to DRAM. Therefore the LBD must be able to support stalling at its output during a line. The LBD uses the previous line in the decoding process. This is provided by the SFU via it's PrevLineFIFO. Decoding can stall in the LBD while this FIFO waits to be filled from DRAM. A signal sfu_1db_rdy indicates that both the SFU's NextLineF/FO and PrevLineFIFO are available 15 for writing and reading, respectively. A configuration register in the LBD controls whether the first line being decoded at the start of a band uses the previous line read from the SFU or uses an all O's line instead. The line length is stored in DRAM must be programmable to a value greater than 128. An A4 line of 13824 dots requires 1.7Kbytes of storage. An A3 line of 19488 dots requires 2.4 Kbytes of 20 storage. The compressed spot data can be read at a rate of 1 bit/cycle for pass through mode 1:1 compression. The LBD finished band signal is exported to the PCU and is additionally available to the CPU as an interrupt. 25 24.2.1 Bi-level Decoding in the LBD The black bi-level layer is losslessly compressed using Silverbrook Modified Group 4 (SMG4) compression which is a version of Group 4 Facsimile compression [221 without Huffman and with simplified run length encodings. The encoding are listed in Table 152 and Table 153. Table 152. Bi-Level group 4 facsimile style compression encodings 30 Encoding Description same as Group 4 Facsimile 1000 Pass Command: aO +- b2, skip next two edges 1 Vertical(0): aO <- b1, color = !color 110 Vertical(1): aO <- bI + 1, color = !color 010 Vertical(-1): aO <- b1 - 1, color = !color 110000 Vertical(2): a0 <- b1 + 2, color = !color 010000 Vertical(-2): aO <- b1 - 2, color =!color Unique to this 100000 Vertical(3): aO +- b1 + 3, color = !color implementation WO 2004/050369 PCT/AU2003/001616 394 000000 Vertical(-3): a0 <- b1 - 3, color = !color <RL><RL>10 Horizontal: a0 <- a0 + <RL> + <RL> 0 SMG4 has a pass through mode to cope with local negative compression. Pass through mode is activated by a special run-length code. Pass through mode continues to either end of line or for a pre-programmed number of bits, whichever is shorter. The special run-length code is always executed as a run-length code, followed by pass through. The pass through escape code is a 5 medium length run-length with a run of less than or equal to 31. Table 153. Run length (RL) encodings Encoding Description Unique to this RRRRR1 Short Black Runlength (5 bits) implementation RRRRR1 Short White Runlength (5 bits) RRRRRRRRRR10 Medium Black Runlength (10 bits) RRRRRRRR10 Medium White Runlength (8 bits) RRRRRRRRRR10 Medium Black Runlength with RRRRRRRRRR <= 31, Enter pass through RRRRRRRR10 Medium White Runlength with RRRRRRRR <= 31, Enter pass through RRRRRRRRRRRRR Long Black Runlength (15 bits) RROO RRRRRRRRRRRRR Long White Runlength (15 bits) RROO Since the compression is a bitstream, the encodings are read right (least significant bit) to left (most significant bit). The run lengths given as RRRRR in Table 153 are read in the same way 10 (least significant bit at the right to most significant bit at the left). There is an additional enhancement to the G4 fax algorithm, it relates to pass through mode. It is possible for data to compress negatively using the G4 fax algorithm. On occasions like this it would be easier to pass the data to the LBD as un-compressed data. Pass through mode is a new feature that was not implemented in the PECI version of the LBD. When the LBD is in pass 15 through mode the least significant bit of the data stream is an un-compressed bit. This bit is used to construct the current line. To enter pass through mode the LBD takes advantage of the way run lengths can be written. Usually if one of the runlength pair is less than or equal to 31 it should be encoded as a short runlength. However under the coding scheme of Table it is still legal to write it as a medium or 20 long runlength. The LBD has been designed so that if a short runlength value is detected in a medium runlength then once the horizontal command containing this runlength is decoded WO 2004/050369 PCT/AU2003/001616 395 completely this will tell the LBD to enter pass through mode and the bits following the runlength is un-compressed data. The number of bits to pass through is either a programmed number of bits or the end of the line which ever comes first. Once the pass through mode is completed the current color is the same as the color of the last bit of the passed through data. 5 24.2.2 DRAM Access Requirements The compressed page store for contone, bi-level and raw tag data is 2 Mbytes. The LBD will access the compressed page store in single 256-bit DRAM reads. The LBD will need a 256-bit double buffer in its interface to the DIU. The LBD's DIU bandwidth requirements are summarized in Table 154 10 Table 154. DRAM bandwidth requirements Direction Maximum number of Peak Bandwidth Average Bandwidth cycles between each (bits/cycle) (bits/cycle) 256-bit DRAM access Read 2561 (1:1 compression) 1 (1:1 compression) 0.1 (10:1 compression) 1: At 1:1 compression the LBD requires I bit/cycle or 256 bits every 256 cycles. 24.3 IMPLEMENTATION 15 24.3.1 Definitions of 10 Table 155. LBD Port List Port Name Pins 1/O Description Clocks and Resets Pclk 1 In SoPEC Functional clock. prst-n 1 In Global reset signal. Bandstore signals cduendofbandstore[21:5] 17 In Address of the end of the current band of data. 256-bit word aligned DRAM address. cdustartofbandstore[21:5] 17 In Address of the start of the current band of data. 256-bit word aligned DRAM address. lbdfinishedband 1 Out LBD finished band signal to PCU and Interrupt Controller. DIU Interface signals lbd-diu-rreq 1 Out LBD requests DRAM read. A read request must be accompanied by a valid read address.
WO 2004/050369 PCT/AU2003/001616 396 lbddiuradr[21:5] 17 Out Read address to DIU 17 bits wide (256-bit aligned word). diu_Ibdrack I In Acknowledge from DIU that read request has been accepted and new read address can be placed on /bd diu_radr. diu-data[63:0] 64 in Data from DIU to SoPEC Units. First 64-bits is bits 63:0 of 256 bit word. Second 64-bits is bits 127:64 of 256 bit ord. Third 64-bits is bits 191:128 of 256 bit word. Fourth 64-bits is bits 255:192 of 256 bit word. diu lbd rvalid 1 In Signal from DIU telling SoPEC Unit that valid read data is on the diu data bus PCU Interface data and control signals pcu-addr[5:2] 4 In PCU address bus. Only 4 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. lbdpcu-datain[31:0] 32 Out Read data bus from the LBD to the PCU. pcu-rwn 1 In Common read/not-write signal from the PCU. pcujlbdsel I In Block select from the PCU. When ocu-lbd sel is high both pcu-addr and ocu dataout are valid. Ibdpcu rdy 1 Out Ready signal to the PCU. When /bd pcuL_rdy is high it indicates the last cycle of the access. For a write cycle this means pcu dataout has been registered by the block and for a read cycle this means the data on lbd pcu detain is valid. SFU Interface data and control signals sfulbd-rdy 1 In Ready signal indicating SFU has previous line data available for reading and is also ready to be written to.
WO 2004/050369 PCT/AU2003/001616 397 lbd sfu advline 1 Out Advance line signal to previous and next line buffers lbd-sfu_padvword 1 Out Advance word signal for previous line buffer. sfulbd_pdata15:0] 16 In Data from the previous line buffer. Ibdsfuwdata[15:0] 16 Out Write data for next line buffer. lbd sfu wdatavalid 1 Out Write data valid signal for next line buffer data. 24.3.2 Configuration Registers Table 156. LBD Configuration Registers Address Register #Bits Value Description (LBD base +) Name on Reset Control registers Ox00 Reset I Ox1 A write to this register causes a reset of the LBD. This register can be read to indicate the reset state: 0 - reset in progress 1 - reset not in progress 0x04 Go 1 Ox0 Writing 1 to this register starts the LBD. Writing 0 to this register halts the LBD. The Go register is reset to 0 by the LBD when it finishes processing a band. When Go is deasserted the state-machines go to their idle states but all counters and configuration registers keep their values. When Go is asserted all counters are reset, but configuration registers keep their values (i.e. they don't get reset). The LBD should only be started after the SFU is started. This register can be read to determine if the LBD is running (1 - running, 0 - stopped). Setup registers (constant for during processing the page) 0x08 LineLength 16 [xO0 Width of expanded bi-level line (in dots) (must be set greater than 128 bits).
WO 2004/050369 PCT/AU2003/001616 398 Ox0C PassThrough 1 OxI Writing 1 to this register enables passthrough Enable mode. Writing 0 to this register disables pass through mode thereby making the LBD compatible with PEC1. Ox10 PassThrough 16 OxOOOO This is the dot length - I for which pass DotLength through mode will last. If the end of the line is reached first then pass-through will be disabled. The value written to this register must be a non-zero value. Work registers (need to be set up before processing a band) Ox1 4 NextBandCu 17 OxOOOO Shadow register which is copied to rrReadAdr[2 0 CurrReadAdr when (NextBandEnable == I & 1:5] Go == 0). (256-bit NextBandCurrReadAdr is the address of the aligned start of the next band of compressed bi-level DRAM data in DRAM. address) 0x18 NextBandLin 15 OxOOO Shadow register which is copied to Lines esRemaining Remaining when (NextBandEnable == I & Go == 0). NextBandLinesRemaining is the number of lines to be decoded in the next band of compressed bi-level data. Ox1 C NextBandPre 1 Ox0 Shadow register which is copied to Prev vLineSource LineSource when (NextBandEnable == I & Go == 0). 1 - use the previous line read from the SFU for decoding the first line at the start of the next band. 0 - ignore the previous line read from the SFU for decoding the first line at the start of the next band (an all O's line is used instead). Ox20 NextBandEn 1 Ox0 If (NextBandEnable == 1 & Go == 0) then able -NextBandCurrReadAdr is copied to CurrReadAdr, -NextBandLinesRemaining is copied to LinesRemaining, -NextBandPrevLineSource is copied WO 2004/050369 PCT/AU2003/001616 399 to PrevLineSource, -Go is set, -NextBandEnable is cleared. To start LBD processing NextBandEnable should be set. Work registers (read only for external access) 0x24 CurrReadAdr 17 - The current 256-bit aligned read address [21:5] within the compressed bi-level image (DRAM (256-bit address). Read only register. aligned DRAM address) 0x28 LinesRemain 15 - Count of number of lines remaining to be ing decoded. The band has finished when this number reaches 0. Read only register. Ox2C PrevLineSou 1 - 1 - uses the previous line read from the SFU rce for decoding the first line at the start of the next band. 0 - ignores the previous line read from the SFU for decoding the first line at the start of the next band (an all O's line is used instead). Read only register. Ox30 CurrWriteAdr 15 - The current dot position for writing to the SFU. Read only register. Ox34 FirstLineOfB 1 - Indicates whether the current line is con and sidered to be the first line of the band. Read only register. 24.3.3 Starting the LBD between bands The LBD should be started after the SFU. The LBD is programed with a start address for the compressed bi-level data, a decode line length, the source of the previous line and a count of how many lines to decode. The LBD's NextBandEnable bit should then be set (this will set LBD Go). 5 The LBD decodes a single band and then stops, clearing it's Go bit and issuing a pulse on /bd_ finishedband. The LBD can then be restarted for the next band, while the HCU continues to process previously decoded bi-level data from the SFU. There are 4 mechanisms for restarting the LBD between bands: a. ibdfinishedband causes an interrupt to the CPU. The LBD will have stopped and cleared its 10 Go bit. The CPU reprograms the LBD, typically the NextBandCurrReadAdr, NextBandLines Remaining and NextBandPrevLineSource shadow registers, and sets NextBandEnable to restart the LBD.
WO 2004/050369 PCT/AU2003/001616 400 b. The CPU programs the LBD's NextBandCurrReadAdr, NextBandLinesRemaining, and Next BandPrevLineSource shadow registers and sets the NextBandEnable flag before the end of the current band. At the end of the band the LBD clears Go, NextBandEnable is already set so the LBD restarts immediately. 5 c. The PCU is programmed so that Ibdfinishedband triggers the PCU to execute commands from DRAM to reprogram the LBD's NextBandCurrReadAdr, NextBandLinesRemaining, and NextBandPrevLineSource shadow registers and set NextBandEnable to restart the LBD. The advantage of this scheme is that the CPU could process band headers in advance and store the band commands in DRAM ready for execution. 10 d. This is a combination of b and c above. The PCU (rather than the CPU in b) programs the LBD's NextBandCurrReadAdr, NextBandLinesRemaining, and NextBandPrevLineSource shadow registers and sets the NextBandEnable flag before the end of the current band. At the end of the band the LBD clears Go and pulses /bd finishedband. NextBandEnable is already set so the LBD restarts immediately. Simultaneously, Ibd_finishedband triggers the PCU to fetch commands from 15 DRAM. The LBD will have restarted by the time the PCU has fetched commands from DRAM. The PCU commands program the LBD's shadow registers and sets NextBandEnable for the next band. 24.3.4 Top-level Description A block diagram of the LBD is shown in Figure 148. 20 The LBD contains the following sub-blocks: Table 157. Functional sub-blocks in the LBD name Description Registers and Resets PCU interface and configuration registers. Also generates the Go and the Reset signals for the rest of the LBD Stream Decoder Accesses the bi-level description from the DRAM through the DIU inter Face. It decodes the bit stream into a command with arguments, which it then passes to the command controller. Command Controller Interprets the command from the stream decoder and provide the line fill unit with a limit address and color to fill the SFU Next Line Buffer. It also provides the next edge unit starting address to look for the next edge. Next Edge Unit Scans through the Previous Line Buffer using its current address to find the next edge of a color provided by the command controller. The next edge unit outputs this as the next current address back to the command controller and sets a valid bit when this address is at the next edge. Line Fill Unit Fills the SFU Next Line Buffer with a color from its current address up to a limit address. The color and limit are provided by the command controller.
WO 2004/050369 PCT/AU2003/001616 401 In the following description the LBD decodes data for its current decode line but writes this data into the SFU's next line buffer. Naming of signals and logical blocks are taken from [22]. The LBD is able to stall mid-line should the SFU be unable to supply a previous line or receive a 5 current line frame due to band processing latency. All output control signals from the LBD must always be valid after reset. For example, if the LBD is not currently decoding, Ibd sfu advine (to the SFU) and /bd_finishedband will always be 0. 24.3.5 Registers and Resets sub-block description Since the CDU, LBD and TE all access the page band store, they share two registers that enable 10 sequential memory accesses to the page band stores to be circular in nature. The CDU chapter lists these two registers. The register descriptions for the LBD are listed in Table . During initialisation of the LBD, the LineLength and the LinesRemaining configuration values are written to the LBD. The 'Registers and Resets' sub-block supplies these signals to the other sub blocks in the LBD. In the case of LinesRemaining, this number is decremented for every line that 15 is completed by the LBD. If pass through is used during a band the PassThroughEnable register needs to be programmed and PassThroughDotLength programmed with the length of the compressed bits in pass through mode. PrevLineSource is programmed during the initialisation of a band, if the previous line supplied for 20 the first line is a valid previous line, a 1 is written to PrevLineSource so that the data is used. If a 0 is written the LBD ignores the previous line information supplied and acts as if it is receiving all zeros for the previous line regardless of what the out of the SFU is. The 'Registers and Resets' sub-block also generates the resets used by the rest of the LBD and the Go bit which tells the LBD that it can start requesting data from the DIU and commence 25 decoding of the compressed data stream. 24.3.6 Stream Decoder Sub-block Description The Stream Decoder reads the compressed bi-level image from the DRAM via the DIU (single accesses of 256-bits) into a double 256-bit FIFO. The barrel shift register uses the 64-bit word from the FIFO to fill up the empty space created by the barrel shift register as it is shifting it's 30 contents. The bit stream is decoded into a command/arguments pair, which in turn is passed to the command controller. A dataflow block diagram of the stream decoder is shown in Figure 149. 24.3.6.1 DecodeC - Decode Command The DecodeC logic encodes the command from bits 6..0 of the bit stream to output one of three 35 commands: SKIP, VERTICAL and RUNLENGTH. It also provides an output to indicate how many bits were consumed, which feeds back to the barrel shift register. There is a fourth command, PASSTHROUGH, which is not encoded in bits 6..0, instead it is inferred in a special runlength. If the stream decoder detects a short runlength value, i.e. a number less than 31, encoded as a medium runlength this tell the Stream Decoder that once the 40 horizontal command containing this runlength is decoded completely the LBD enters WO 2004/050369 PCT/AU2003/001616 402 PASS_ THROUGH mode. Following the runlength there will be a number of bits that represent un compressed data. The LBD will stay in PASS_ THROUGH mode until all these bits have been decoded successfully, this will occur once a programmed number of bits is reached or the line ends, which ever comes first. 5 24.3.6.2 DecodeD - Decode Delta The DecodeD logic decodes the run length from bits 20..3 of the bit stream. If DecodeC is decoding a vertical command, it will cause DecodeD to put constants of -3 through 3 on its output. The output delta is a 15 bit number, which is generally considered to be positive, but since it needs to only address to 13824 dots for an A4 page and 19488 dots for an A3 page (of 32,768), a 10 2's complement representation of -3,-2,-1 will work correctly for the data pipeline that follows. This unit also outputs how many bits were consumed. In the case of PASSTHROUGH mode, DecodeD parses the bits that represent the un compressed data and this is used by the Line Fill Unit to construct the current line frame. DecodeD parses the bits at one bit per clock cycle and passes the bit in the less significant bit 15 location of delta to the line fill unit. DecodeD currently requires to know the color of the run length to decode it correctly as black and white runs are encoded differently. The stream decoder keeps track of the next color based on the current color and the current command. 24.3.6.3 State-machine 20 This state machine continuously fetches consecutive DRAM data whenever there is enough free space in the FIFO, thereby keeping the barrel shift register full so it can continually decode commands for the command controller. Note in Figure 149 that each read cycle currreadaddr is compared to endofbandstore. If the two are equal, currreadaddr is loaded with startofbandstore (circular memory addressing). Otherwise currreadaddr is simply 25 incremented. startofbandstore and endofbandstore need to be programed so that the distance between them is a multiple of the 256-bit DRAM word size. When the state machine decodes a SKIP command, the state machine provides two SKIP instructions to the command controller. The RUNLENGTH command has two different run lengths. The two run lengths are passed to the 30 command controller as separate RUNLENGTH instructions. In the first instruction fetch, the first run length is passed, and the state machine selects the DecodeD shift value for the barrel shift. In the second instruction fetch from the command controller another RUNLENGTH instruction is generated and the respective shift value is decoded. This is achieved by forcing DecodeC to output a second RUNLENGTH instruction and the respective shift value is decoded. 35 For PASSTHROUGH mode, the PASS_THROUGH command is issued every time the command controller requests a new command. It does this until all the un-compressed bits have been processed. 24.3.7 Command Controller Sub-block Description The Command Controller interprets the command from the Stream Decoder and provides the line 40 fill unit with a limit address and color to fill the SFU Next Line Buffer. It provides the next edge unit WO 2004/050369 PCT/AU2003/001616 403 with a starting address to look for the next edge and is responsible for detecting the end of line and generating the eob cc signal that is passed to the line fill unit. A dataflow block diagram of the command controller is shown in Figure 150. Note that data names such as aO and b1p are taken from [22], and they denote the reference or starting 5 changing element on the coding line and the first changing element on the reference line to the right of aO and of the opposite color to aO respectively. 24.3.7.1 State machine The following is an explanation of all the states that the state machine utilizes. i START 10 This is the state that the Command Controller enters when a hard or soft reset occurs or when Go has been de-asserted. This state cannot be left until the reset has been removed, Go has been asserted and the NEU (Next Edge Unit), the SD (Stream Decoder) and the SFU are ready. ii AWAIT BUFFER The NEU contains a buffer memory for the data it receives from the SFU. When the command 15 controller enters this state the NEU detects this and starts buffering data, the command controller is able to leave this state when the state machine in the NEU has entered the NEU RUNNING state. Once this occurs the command controller can proceed to the PARSE state. iii PAUSECC During the decode of a line it is possible for the FIFO in the stream decoder to get starved of data 20 if the DRAM is not able to supply replacement data fast enough. Additionally the SFU can also stall mid-line due to band processing latency. If either of these cases occurs the LBD needs to pause until the stream decoder gets more of the compressed data stream from the DRAM or the SFU can receive or deliver new frames. All of the remaining states check if sdvalid goes to zero (this denotes a starving of the stream decoder) or if sfu _bdrdy goes to zero and that the LBD 25 needs to pause. PAUSE_ CC is the state that the command controller enters to achieve this and it does not leave this state until sdvalid and sfu Ibd rdy are both asserted and the LBD can recommence decompressing. iv PARSE Once the command controller enters the PARSE state it uses the information that is supplied by 30 the stream decoder. The first clock cycle of the state sees the sdack signal getting asserted informing the stream decoder that the current register information is being used so that it can fetch the next command. When in this state the command controller can receive one of four valid commands: a) Runlength or Horizontal 35 For this command the value given as delta is an integer that denotes the number of bits of the current color that must be added to the current line. Should the current line position, aO, be added to the delta and the result be greater than the final position of the current frame being processed by the Line Fill Unit (only 16 bits at a time), it is necessary for the command controller to wait for the Line Fill Unit (LFU) to process up to that WO 2004/050369 PCT/AU2003/001616 404 point. The command controller changes into the WAIT FOR RUNLENGTH state while this occurs. When the current line position, aO, and the delta together equal or exceed the LINELENGTH, which is programmed during initialisation, then this denotes that it is the end of the current line. 5 The command controller signals this to the rest of the LBD and then returns to the START state. b) Vertical When this command is received, it tells the command controller that, in the previous line, it needs to find a change from the current color to opposite of the current color, i.e. if the current color is white it looks from the current position in the previous line for the next time where there is a 10 change in color from white to black. It is important to note that if a black to white change occurs first it is ignored. Once this edge has been detected, the delta will denote which of the vertical commands to use, refer to Table . The delta will denote where the changing element in the current line is relative to the changing element on the previous line, for a Vertical(2) the new changing element position in 15 the current line will correspond to the two bits extra from changing element position in the previous line. Should the next edge not be detected in the current frame under review in the NEU, then the command controller enters the WAIT_FORNE state and waits there until the next edge is found. c) Skip 20' A skip follow the same functionality as to Vertical(O) commands but the color in the current line is not changed as it is been filled out. The stream decoder supplies what looks like two separate skip commands that the command controller treats the same a two Vertical(O) commands and has been coded not to change the current color in this case. d) Pass Through 25 When in pass through mode the stream decoder supplies one bit per clock cycle that is uses to construct the current frame. Once pass through mode is completed, which is controlled in the stream decoder, the LBD can recommence normal decompression again. The current color after pass through mode is the same color as the last bit in un-compressed data stream. Pass through mode does not need an extra state in the command controller as each pass through command 30 received from the stream decoder can always be processed in one clock cycle. v WAIT FOR RUNLENGTH As some RUNLENGTH's can carry over more than one 16-bit frame, this means that the Line Fill Unit needs longer than one clock cycle to write out all the bits represented by the RUNLENGTH. After the first clock cycle the command controller enters into the WAIT_FORRUNLENGTH state 35 until all the RUNLENGTH data has been consumed. Once finished and provided it is not the end of the line the command controller will return to the PARSE state. vi WAIT FORNE Similar to the RUNLENGTH commands the vertical commands can sometimes not find an edge in the current 16-bit frame. After the first clock cycle the command controller enters the WO 2004/050369 PCT/AU2003/001616 405 WAIT_FORNE state and remains here until the edge is detected. Provided it is not the end of the line the command controller will return to the PARSE state. vii FINISH LINE At the end of a line the command controller needs to hold its data for the SFU before going back 5 to the START state. Command controller remains in the FINISHLINE state for one clock cycle to achieve this. 24.3.8 Next Edge Unit Sub-block Description The Next Edge Unit (NEU) is responsible for detecting color changes, or edges, in the previous line based on the current address and color supplied by the Command Controller. The NEU is the 10 interface to the SFU and it buffers the previous line for detecting an edge. For an edge detect operation the Command Controller supplies the current address, this typically was the location of the last edge, but it could also be the end of a run length. With the current address a color is also supplied and using these two values the NEU will search the previous line for the next edge. If an edge is found the NEU returns this location to the Command Controller as the next address in the 15 current line and it sets a valid bit to tell the Command Controller that the edge has been detected. The Line Fill Unit uses this result to construct the current line. The NEU operates on 16-bit words and it is possible that there is no edge in the current 16 bits in the NEU. In this case the NEU will request more words from the SFU and will keep searching for an edge. It will continue doing this until it finds an edge or reaches the end of the previous line, which is based on the 20 LINELENGTH. A dataflow block diagram of the Next Edge unit is shown in Figure 152. 24.3.8.1 NEU Buffer The algorithm being employed for decompression is based on the whole previous line and is not delineated during the line. However the Next Edge Unit, NEU, can only receive 16 bits at a time from the SFU. This presents a problem for vertical commands if the edge occurs in the successive 25 frame, but refers to a changing element in the current frame. To accommodate this the NEU works on two frames at the same time, the current frame and the first 3 bits from the successive frame. This allows for the information that is needed from the previous line to construct the current frame of the current line. In addition to this buffering there is also buffering right after the data is received from the SFU as 30 the SFU output is not registered. The current implementation of the SFU takes two clock cycles from when a request for a current line is received until it is returned and registered. However when NEU requests a new frame it needs it on the next clock cycle to maintain a decoded rate of 2 bits per clock cycle. A more detailed diagram of the buffer in the NEU is shown in Figure 153. The output of the buffer are two 16-bit vectors, useprevlinea and useprevLineb, that are 35 used to detect an edge that is relevant to the current line being put together in the Line Fill Unit. 24.3.8.2 NEU Edge Detect The NEU Edge Detect block takes the two 16 bit vectors supplied by the buffer and based on the current line position in the current line, aO, and the current color, sd_color, it will detect if there is an edge relevant to the current frame. If the edge is found it supplies the current line position, b1p, WO 2004/050369 PCT/AU2003/001616 406 to the command controller and the line fill unit. The configuration of the edge detect is shown in Figure 154. The two vectors from the buffer, useprev_linea and use_prev line b, pass into two sub-blocks, 5 transitionwtob and transition_btow. transitionwtob detects if any white to black transitions occur in the 19 bit vector supplied and outputs a 19-bit vector displaying the transitions. transitionwtob is functionally the same as transition-btow, but it detects white to black transitions. The two 19-bit vectors produced enter into a multiplexer and the output of the multiplexer is controlled by color neu. colorneu is the current edge transition color that the edge detect is 10 searching for. The output of the multiplexer is masked against a 19-bit vector, the mask is comprised of three parts concatenated together: decode_b_ext, decodeb and FIRSTFLUWRITE. The output of transition wtob (and it complement transition_ btow) are all the transitions in the 16 bit word that is under review. The decodeb is a mask generated from a0. In bit-wise terms all the 15 bits above and including aO are 1's and all bits below aO are O's. When they are gated together it means that all the transitions below aO are ignored and the first transition after aO is picked out as the next edge. The decodeb block decodes the 4 Isb of the current address (aO) into 16-bit mask bits that control which of the data bits are examined. Table 158 shows the truth table for this block. 20 Table 158. Decode b truth table input output 0000 1111111111111111 0001 1111111111111110 0010 1111111111111100 0011 1111111111111000 0100 1111111111110000 0101 1111111111100000 0110 1111111111000000 0111 1111111110000000 1000 1111111100000000 1001 1111111000000000 1010 1111110000000000 1011 1111100000000000 1100 1111000000000000 1101 1110000000000000 1110 1100000000000000 1111 1000000000000000 WO 2004/050369 PCT/AU2003/001616 407 For cases when there is a negative vertical command from the stream decoder it is possible that the edge is in the three lower significant bits of the next frame. The decode_b_ext block supplies the mask so that the necessary bits can be used by the NEU to detect an edge if present, Table 159 shows the truth table for this block. 5 Table 159. Decode b ext truth table delta output Vertical(-3) 111 Vertical(-2) 111 Vertical(-1) 011 OTHERS 001 FIRSTFLU_ WRITE is only used in the first frame of the current line. 2.2.5 a) in [22] refers to "Processing the first picture element", in which it states that "The first starting picture element, aO, 10 on each coding line is imaginarily set at a position just before the first picture element, and is regarded as a white picture element". transition wtob and transition btow are set up produce this case for every single frame. However it is only used by the NEU if it is not masked out. This occurs when FIRSTFLU_ WRITE is '1' which is only asserted at the beginning of a line. 2.2.5 b) in [22] covers the case of "Processing the last picture element", this case states that "The 15 coding of the coding line continues until the position of the imaginary changing element situated after the last actual element is coded". This means that no matter what the current color is the NEU needs to always find an edge at the end of a line. This feature is used with negative vertical commands. The vector, endframe, is a "one-hot" vector that is asserted during the last frame. It asserts a bit 20 in the end of line position, as determined by LineLength, and this simulates an edge in this location which is ORed with the transition's vector. The output of this, masked data, is sent into the encodeB one hot block 24.3.8.3 Encode b one hot The encode_b_onehot block is the first stage of a two stage process that encodes the data to 25 determine the address of the 0 to 1 transition. Table 160 lists the truth table outlining the functionally required by this block. Table 160. Encode b one hot Truth Table Input output XXXXXXXXXXXXXXX1 0000000000000000001 XXXXXXXXXXXXXXXXX10 0000000000000000010 XXXXXXXXXXXXXXI00 0000000000000000100 XXXXXXXXXXXXXXX1000 0000000000000001000 XXXXXXXXXXXXXX10000 0000000000000010000 WO 2004/050369 PCT/AU2003/001616 408 XXXXXXXXXXXXX100000 OOOOOO100 XXXXXXXXXXXX1 000000 D000001000 XXXXXXXXXXX1 0000000 000000000 XXXXXXXXXX10000000 0000000000 XXXXXXXXX1000000000 0000010000 XXXXXXXX1 0000000000 0000100000 XXXXXXX1 00000000000 0000100000 XXXXXX10000000000000001000000 XXXXX1 00000000000000001000000 XXXX1 00000000000000 0010000000 XXX10000000000000000010000000 XX100000000000000000100000000 X1000000000000000000100000000 1000000000000000000 1000000000 00000000000000000000000000000100000 The output of encode_b_one_hot is a "one-hot' vector that will denote where that edge transition is located. In cases of multiple edges, only the first one will be picked. 24.3.8.4 Encode-b_4bit 5 Encode-b_4bit is the second stage of the two stage process that encodes the data to determine the address of the 0 to 1 transition. Encode-b_4bIt receives the "one-hot' vector from encode -b -one -hot and determines the bit location that is asserted. If there is none present this means that there was no edge present in this frame. If there is a bit asserted the bit location in the vector is converted to a number, for example 10 if bit 0 is asserted then the number is one, if bit one is asserted then the number is one, etc. The delta supplied to the NEU determines what vertical command is being processed. The formula that is implemented to return bip to the command controller is: for V(n) bip = x + n moduluslG 15 where x is the number that was extracted from the "one-hot" vector and n is the vertical command. 24.3.8.5 State machine The following is an explanation of all the states that the NEU state machine utilizes. 20 i AEU START This is the state that NEU enters when a hard or soft reset occurs or when Go has been de asserted. This state can not left until the reset has been removed, Go has been asserted and it detects that the command controller has entered it's AWAITBUFF state. When this occurs the NEU enters the NEUFILL-BUFF state.
WO 2004/050369 PCT/AU2003/001616 409 ii NEU FILL BUFF Before any compressed data can be decoded the NEU needs to fill up its buffer with new data from the SFU. The rest of the LBD waits while the NEU retrieves the first four frames from the previous line. Once completed it enters the NEUHOLD state. 5 iii NEU HOLD The NEU waits in this state for one clock cycle while data requested from the SFU on the last access returns. iv NEU RUNNING NEURUNNING controls the requesting of data from the SFU for the remainder of the line by 10 pulsing Ibd sfu pladvword when the LBD needs a new frame from the SFU. When the NEU has received all the word it needs for the current line, as denoted by the LineLength, the NEU enters the NEU EMPTY state. v NEU EMPTY NEU waits in this state while the rest of the LBD finishes outputting the completed line to the SFU. 15 The NEU leaves this state when Go gets deasserted. This occurs when the endofline signal is detected from the LBD. 24.3.9 Line Fill Unit sub-block description The Line Fill Unit, LFU, is responsible for filling the next line buffer in the SFU. The SFU receives the data in blocks of sixteen bits. The LFU uses the color and aO provided by the Command 20 Controller and when it has put together a complete 16-bit frame, it is written out to the SFU. The LBD signals to the SFU that the data is valid by strobing the /bd sfuwdatavalid signal. When the LFU is at the end of the line for the current line data it strobes /bd sfu advline to indicate to the SFU that the end of the line has occurred. A dataflow block diagram of the line fill unit is shown in Figure 154. 25 The dataflow above has the following blocks: 24.3.9.1 State Machine The following is an explanation of all the states that the LFU state machine utilizes. i LFU START This is the state that the LFU enters when a hard or soft reset occurs or when Go has been de 30 asserted. This state can not left until the reset has been removed, Go has been asserted and it detects that aO is no longer zero, this only occurs once the command controller start processing data from the Next Edge Unit, NEU. ii LFU NEW REG LFUNEWREG is only entered at the beginning of a new frame. It can remain in this state on 35 subsequent cycles if a whole frame is completed in one clock cycle. If the frame is completed the LFU will output the data to the SFU with the write enable signal. However if a frame is not completed in one clock cycle the state machine will change to the LFUCOMPLETEREG state to complete the remainder of the frame. LFUNEWREG handles all the Ibdsfuwdata writes and asserts Ibdsfuwdatavalid as necessary. 40 iii LFU COMPLETEREG WO 2004/050369 PCT/AU2003/001616 410 LFU_COMPLETEREG fills out all the remaining parts of the frame that were not completed in the first clock cycle. The command controller supplies the aO value and the color and the state machine uses these to derive the limit and color sel 16bit /f which the line fill data block needs to construct a frame. Limit is the four lower significant bits of aO and colorsel_ 16bitIf is a 16-bit 5 wide mask of sdcolor. The state machine also maintains a check on the upper eleven bits of aO. If these increment from one clock cycle to the next that means that a frame is completed and the data can be written to the SFU. In the case of the LineLength being reached the Line Fill Unit fills out the remaining part of the frame with the color of the last bit in the line that was decoded. 24.3.9.2 line-fill data 10 linefilldata takes the limit value and the colorsel_16bitIf values and constructs the current frame that the command controller and the next edge unit are decoding. The following pseudo code illustrate the logic followed by the linefilldata. worksfuwdata is exported by the LBD to the SFU as lbd sfu wdata. 15 if (lfu state == LFUSTART) OR (lfu state == LFU NEW REG) then work sfu wdata = color sel 16bitlf else work_sfuwdata[(l5 - limit) downto limit] = 20 color sel 16bit lf[(15 - limit) downto limit] 25 Spot FIFO Unit (SFU) 25.1 OVERVIEW The Spot FIFO Unit (SFU) provides the means by which data is transferred between the LBD and 25 the HCU. By abstracting the buffering mechanism and controls from both units, the interface is clean between the data user and the data generator. The amount of buffering can also be increased or decreased without affecting either the LBD or HCU. Scaling of data is performed in the horizontal and vertical directions by the SFU so that the output to the HCU matches the printer resolution. Non-integer scaling is supported in both the horizontal and vertical directions. 30 Typically, the scale factor will be the same in both directions but may be programmed to be different. 25.2 MAIN FEATURES OF THE SFU The SFU replaces the Spot Line Buffer Interface (SLBI) in PEC1. The spot line store is now located in DRAM. 35 The SFU outputs the previous line to the LBD, stores the next line produced by the LBD and outputs the HCU read line. Each interface to DRAM is via a feeder FIFO. The LBD interfaces to the SFU with a data width of 16 bits. The SFU interfaces to the HCU with a data width of 1 bit. Since the DRAM word width is 256-bits but the LBD line length is a multiple of 16 bits, a capability to flush the last multiples of 16-bits at the end of a line into a 256-bit DRAM word size is required.
WO 2004/050369 PCT/AU2003/001616 411 Therefore, SFU reads of DRAM words at the end of a line, which do not fill the DRAM word, will already be padded. A signal sfulbdrdy to the LBD indicates that the SFU is available for writing and reading. For the first LBD line after SFU Go has been asserted, previous line data is not supplied until after the first 5 lbdsfuadvline strobe from the LBD (zero data is supplied instead), and sfu (bdrdy to the LBD indicates that the SFU is available for writing. lbd sfuadvline tells the SFU to advance to the next line. lbd sfupladvword tells the SFU to supply the next 16-bits of previous line data. Until the number of /bdsfu pladvword strobes received is equivalent to the LBD line length, sfu lbdrdy indicates that the SFU is available for both reading and writing. Thereafter it indicates the SFU is 10 available for writing. The LBD should not generate lbd sfu_pladvword or lbdsfuadvIlne strobes until sfu _bd rdy is asserted. A signal sfuhcuavail indicates that the SFU has data to supply to the HCU. Another signal hcusfu_advdot, from the HCU, tells the SFU to supply the next dot. The HCU should not generate the hcu_sfuadvdot signal until sfuhcu_ avail is true. The HCU can therefore stall 15 waiting for the sfuhcuavail signal. X and Y non-integer scaling of the bi-level dot data is performed in the SFU. At 1600 dpi the SFU requires I dot per cycle for all DRAM channels, 3 dots per cycle in total (read + read + write). Therefore the SFU requires two 256 bit read DRAM access per 256 cycles, 1 write access every 256 cycles. A single DIU read interface will be shared for reading the current 20 and previous lines from DRAM. 25.3 Bi-LEVEL DRAM MEMORY BUFFER BETWEEN LBD, SFU AND HCU Figure 158 shows a bi-level buffer store in DRAM. Figure 158 (a) shows the LBD previous line address reading after the HCU read line address in DRAM. Figure 158 (b) shows the LBD previous line address reading before the HCU read line address in DRAM. 25 Although the LBD and HCU read and write complete lines of data, the bi-level DRAM buffer is not line based. The buffering between the LBD, SFU and HCU is a FIFO of programmable size. The only line based concept is that the line the HCU is currently reading cannot be over-written because it may need to be re-read for scaling purposes. The SFU interfaces to DRAM via three FIFOs: 30 a. The HCUReadLineFIFO which supplies dot data to the HCU. b. The LBDNextLineF/FO which writes decompressed bi-level data from the LBD. c. The LBDPrevLineF/FO which reads previous decompressed bi-level data for the LBD. There are four address pointers used to manage the bi-level DRAM buffer: a. hcureadline rd adr[21:5] is the read address in DRAM for the HCUReadLineFIFO. 35 b. hcustartreadline-adr[21:5] is the start address in DRAM for the current line being read by the HCUReadLineFIFO. c. Ibdnextinewr adr[21:5] is the write address in DRAM for the LBDNextLineFIFO. d. /bd prevline rdadr[21:5] is the read address in DRAM for the LBDPrevLineF/FO. The address pointers must obey certain rules which indicate whether they are valid: WO 2004/050369 PCT/AU2003/001616 412 a. hcureadlinerdadr is only valid if it is reading earlier in the line than Ibdnextline_wradr is writing i.e. the fifo is not empty b. The SFU (Ibd nextinewradr) cannot overwrite the current line that the HCU is reading from (hcustartreadline adr) i.e. the fifo is not full, when compared with the HCU read line pointer 5 c. The LBDNextLineFIFO (Ibdnextlinewr adr) must be writing earlier in the line than LBD PrevLineFIFO (Ibdprev/ine rd adr) is reading and must not overwrite the current line that the HCU is reading from i.e. the fifo is not full when compared to the PrevLineFifo read pointer d. The LBDPrevLineFIFO (Ibd prevline rd adr) can read right up to the address that LBDNext LineFIFO (Ibd nextinewradr) is writing i.e the fifo is not empty. 10 e. At startup i.e. when sfu go is asserted, the pointers are reset to startsfuadr[21:5]. f. The address pointers can wrap around the SFU bi-level store area in DRAM. As a guideline, the typical FIFO size should be a minimum of 2 lines stored in DRAM, nominally 3 lines, up to a programmable number of lines. A larger buffer allows lines to be decompressed in advance. This can be useful for absorbing local complexities in compressed bi-level images. 15 25.4 DRAM ACCESS REQUIREMENTS The SFU has 1 read interface to the DIU and 1 write interface. The read interface is shared between the previous and current line read FIFOs. The spot line store requires 5.1 Kbytes of DRAM to store 3 A4 lines. The SFU will read and write the spot line store in single 256-bit DRAM accesses. The SFU will need 256-bit double buffers for 20 each of its previous, current and next line interfaces. The SFU's DIU bandwidth requirements are summarized in Table 161. Table 161. DRAM bandwidth requirements Direction Maximum number of Peak Bandwidth required Average cycles between each to be supported by DIU Bandwidth 256-bit DRAM access (6its/cycle) (bits/cycle) Read 1281 2 2 Write 2562 1 1 1: Two separate reads of 1 bit/cycle. 25 2: Write at 1 bit/cycle. 25.5 SCALING Scaling of bi-level data is performed in both the horizontal and vertical directions by the SFU so that the output to the HCU matches the printer resolution. The SFU supports non-integer scaling with the scale factor represented by a numerator and a denominator. Only scaling up of the bi 30 level data is allowed, i.e. the numerator should be greater than or equal to the denominator. Scaling is implemented using a counter as described in the pseudocode below. An advance pulse is generated to move to the next dot (x-scaling) or line (y-scaling). if (count + denominator >= numerator) then 35 count = (count + denominator) - numerator WO 2004/050369 PCT/AU2003/001616 413 advance = 1 else count = count + denominator advance = 0 5 X scaling controls whether the SFU supplies the next dot or a copy of the current dot when the HCU asserts hcusfuadvdot. The SFU counts the number of hcusfuadvdot signals from the HCU. When the SFU has supplied an entire HCU line of data, the SFU will either re-read the current line from DRAM or advance to the next line of HCU read data depending on the 10 programmed Y scale factor. An example of scaling for numerator = 7 and denominator = 3 is given in Table 162. The signal advance if asserted causes the next input dot to be output on the next cycle, otherwise the same input dot is output Table 162. Non-integer scaling example for scaleNum = 7, scaleDenom = 3 15 count advance dot 0 0 1 3 0 1 6 1 1 2 0 2 5 1 2 1 0 3 4 1 3 0 0 4 3 0 4 6 1 4 2 0 5 25.6 LEAD-IN AND LEAD-OUT CLIPPING To account for the case where there may be two SoPEC devices, each generating its own portion of a dot-line, the first dot in a line may not be replicated the total scale-factor number of times by an individual SoPEC. The dot will ultimately be scaled-up correctly with both devices doing part of 20 the scaling, one on its lead-out and the other on its lead in. Scaled up dots on the lead-out, i.e. which go beyond the HCU linelength, will be ignored. Scaling on the lead-in, i.e. of the first valid dot in the line, is controlled by setting the XstartCount register. At the start of each line count in the pseudo-code above is set to XstartCount. If there is no lead in, XstartCount is set to 0 i.e. the first value of count in Table . If there is lead-in then XstartCount 25 needs to be set to the appropriate value of count in the sequence above. 25.7 INTERFACES BETWEEN LDB, SFU AND HCU 25.7.1 LDB-SFU Interfaces WO 2004/050369 PCT/AU2003/001616 414 The LBD has two interfaces to the SFU. The LBD writes the next line to the SFU and reads the previous line from the SFU. 25.7.1.1 LBDNextLineF/FO Interface The LBDNextLineF/FO interface from the LBD to the SFU comprises the following signals: 5 e lbdsfu_wdata, 16-bit write data. e Ibd sfu wdatavalid, write data valid. e lbdsfuadvine, signal indicating LDB has advanced to the next line. The LBD should not write to the SFU until sfu lbdrdy is true. The LBD can therefore stall waiting for the sfu _bd rdy signal. 10 25.7.1.2 LBDPrevLineF/FO Interface The LBDPrevLineF/FO interface from the SFU to the LBD comprises the following signals: * sfu-lbdp/data, 16-bit data. The previous line read buffer interface from the LBD to the SDU comprises the following signals: * lbd sfu pladvword, signal indicating to the SFU to supply the next 16-bit word. 15 * lbdsfuadvilne, signal indicating LDB has advanced to the next line. Previous line data is not supplied until after the first Ibdsfuadvilne strobe from the LBD (zero data is supplied instead). The LBD should not assert /bd sfu pladvword unless sfuIbd_rdy is asserted. 25.7.1.3 Common Control Signals 20 sfu_/bd_rdy indicates to the LBD that the SFU is available for writing. After the first lbdsfuadviine and before the number of /bd sfu pladvword strobes received is equivalent to the LBD line length, sfu lbd rdy indicates that the SFU is available for both reading and writing. Thereafter it indicates the SFU is available for writing. The LBD should not generate lbd sfupladvword or lbdsfuadvilne strobes until sfu_Ibd rdy is 25 asserted. 25.7.2 SFU-HCU Current Line FIFO Interface The interface from the SFU to the HCU comprises the following signals: * sfuhcusdata, 1-bit data. e sfuhcuavai, data valid signal indicating that there is data available in the SFU 30 HCUReadLineF/FO. The interface from HCU to SFU comprises the following signals: * hcu_sfu advdot, indicating to the SFU to supply the next dot. The HCU should not generate the hcusfuadvdot signal until sfuhcuavail is true. The HCU can therefore stall waiting for the sfuhcuavail signal. 35 25.8 IMPLEMENTATION 25.8.1 Definitions of 10 Table 163. SFU Port List Port Name Pins I/O Description WO 2004/050369 PCT/AU2003/001616 415 Clocks and Resets Pclk 1 in SoPEC Functional clock. prstn 1 In Global reset signal. DIU Read Interface signals sfu-diu-rreq 1 Out SFU requests DRAM read. A read request must be accompanied by a valid read address. sfudiuradr[21:5] 17 Out Read address to DIU 17 bits wide (256-bit aligned word). diusfurack 1 In Acknowledge from DIU that read request has been accepted and new read address can be placed on sfu diu radr. diu-data[63:0] 64 In Data from DIU to SoPEC Units. First 64-bits are bits 63:0 of 256 bit word. Second 64-bits are bits 127:64 of 256 bit word. Third 64-bits are bits 191:128 of 256 bit word. Fourth 64-bits are bits 255:192 of 256 bit word. diu sfu rvalid 1 In Signal from DIU telling SoPEC Unit that valid read data is on the diu data bus. DIU Write Interface signals sfu-diu-wreq 1 Out SFU requests DRAM write. A write request must be accompanied by a valid write address together with valid write data and a write valid. sfu_diu_wadr[21:5] 17 Out Write address to DIU 17 bits wide (256-bit aligned word). diusfuwack I In Acknowledge from DIU that write request has been accepted and new write address can be placed on sfudiu wadr. sfudiudata[63:0] 64 Out Data from SFU to DIU. First 64-bits are bits 63:0 of 256 bit word. Second 64-bits are bits 127:64 of 256 bit word. Third 64-bits are bits 191:128 of 256 bit word. Fourth 64-bits are bits 255:192 of 256 bit word. sfu diu wvalid 1 Out Signal from PEP Unit indicating that data on sfu diu data is valid. PCU Interface data and control signals pcu-adr[5:2] 4 In PCU address bus. Only 4 bits are required to decode the address space for this block pcudataout[31:0] 32 In Shared write data bus from the PCU sfu pcu-datain[31:0] 32 Out Read data bus from the SFU to the PCU WO 2004/050369 PCT/AU2003/001616 416 pcu_rwn 1 In Common read/not-write signal from the PCU pcusfusel 1 In Block select from the PCU. When pcu sfusel is high both pcu adr and pcu dataout are valid sfu_pcu-rdy 1 Out Ready signal to the PCU. When sfupcu rdy is high it indicates the last cycle of the access. For a write cycle this means pcudataout has been registered by the block and for a read cycle this means the data on sfupcu datain is valid. LBD Interface Data and Control Signals sfulbd-rdy 1 Out Signal indication that SFU has previous line data available and is ready to be written to. lbd sfu advline 1 In Line advance signal for both next and previous lines. lbdsfupladvword 1 In Advance word signal for previous line buffer. sfu-lbd_pdata[15:0] 16 Out Data from the previous line buffer. lbdsfuwdata[15:0] 16 In Write data for next line buffer. lbdsfuwdatavalid 1 In Write data valid signal for next line buffer data. HCU Interface Data and Control Signals hcusfuadvdot 1 In Signal indicating to the SFU that the HCU is ready to accept the next dot of data from SFU. sfu hcu sdata 1 Out Bi-level dot data. sfuhcuavail 1 Out Signal indicating valid bi-level dot data on sfu hcu sdata. 25.8.2 Configuration Registers Table 164. SFU Configuration Registers Address register name Abits value on reset description (SFU_base +) Control registers Ox00 Reset 1 OxI A write to this register causes a reset of the SFU. This register can be read to indicate the reset state: 0 - reset in progress 1 - reset not in progress 0x04 Go 1 Ox0 Writing 1 to this register starts the SFU. Writing 0 to this register halts the SFU. When Go is deasserted the state- WO 2004/050369 PCT/AU2003/001616 417 machines go to their idle states but all counters and configuration registers keep their values. When Go is asserted all counters are reset, but configuration registers keep their values (i.e. they don't get reset). The SFU must be started before the LBD is started. This register can be read to determine if the SFU is running (1 - running, 0 - stopped). Setup registers (constant for during processing the page) 0x08 HCUNumDot 16 OxOOOO Width of HCU line (in dots). s Ox0C HCUDRAMW 8 Ox00 Number of 256-bit DRAM words in a ords HCU line - 1. Ox10 LBDDRAMW 8 Ox00 Number of 256-bit words in a LBD line ords - 1. (LBD line length must be at least 128 bits). Ox14 StartSfuAdr[2 17 OxOOOO 0 First SFU location in memory. 1:5] (256-bit aligned DRAM address) 0x18 EndSfuAdr[21 17 OxO00 0 Last SFU location in memory. :5] (256-bit aligned DRAM address) OxIC XstartCount 8 Ox00 Value to be loaded at the start of every line into the counter used for scaling in the X direction. Used to control the scaling of the first dot in a line. This value will typically equal zero, except in the case where a number of WO 2004/050369 PCT/AU2003/001616 418 dots are clipped on the lead in to a line. XstartCount must be programmed to be less than the XscaleNurn value. Ox20 XscaleNum 8 OxO1 Numerator of spot data scale factor in X direction. Ox24 XscaleDenom 8 Ox01 Denominator of spot data scale factor in X direction. Ox28 YscaleNum 8 Ox01 Numerator of spot data scale factor in Y direction. Ox2C YscaleDenom 8 Ox01 Denominator of spot data scale factor in Y direction. Work registers (PCU has read-only access) 0x30 HCUReadLin 17 - Current address pointer in DRAM to eAdr[21:5] HCU read data. Read only register. (256-bit aligned DRAM address) 0x34 HCUStartRea 17 - Start address in DRAM of line being dLineAdr[21:5 read by HCU buffer in DRAM. Read only register. (256-bit aligned DRAM address) 0x38 LBDNextLine 17 - Current address pointer in DRAM to Adr[21:5] LBD write data. Read only register (256-bit aligned DRAM address) Ox3C LBDPrevLine 17 - Current address pointer in DRAM to Adr[21:5] LBD read data. Read only register (256-bit aligned DRAM address) 25.8.3 SFU sub-block partition WO 2004/050369 PCT/AU2003/001616 419 The SFU contains a number of sub-blocks: Name description PCU Interface PCU interface, configuration and status registers. Also generates the Go and the Reset signals for the rest of the SFU LBD Previous Contains FIFO which is read by the LBD previous line interface. Line FIFO LBD Next Line Contains FIFO which is written by the LBD next line interface. FIFO HCU Read Line Contains FIFO which is read by the HCU interface. FIFO DIU Interface Contains DIU read interface and DIU write interface. Manages the and Address address pointers for the bi-level DRAM buffer. Contains X and Y scaling Generator logic. The various FIFO sub-blocks have no knowledge of where in DRAM their read or write data is 5 stored. In this sense the FIFO sub-blocks are completely de-coupled from the bi-level DRAM buffer. All DRAM address management is centralised in the DIU Interface and Address Generation sub-block. DRAM access is pre-emptive i.e. after a FIFO unit has made an access then as soon as the FIFO has space to read or data to write a DIU access will be requested immediately. This ensures there are no unnecessary stalls introduced e.g. at the end of an LBD or 10 HCU line. There now follows a description of the SFU sub-blocks. 25.8.4 PCU Interface Sub-block The PCU interface sub-block provides for the CPU to access SFU specific registers by reading or writing to the SFU address space. 15 25.8.5 LBDPrevLineFIFO sub-block Table 165. LBDPrevLineFIFO Additional 10 Definitions Port Name Pins I/O Description Internal Output plf-rdy 1 Out Signal indicating LBDPrevLineF/FO is ready to be read from. Until the first /bd sfu advine for a band has been received and after the number of reads from DRAM for a line is received is equal to LBDDRAMWords, plftrdy is always asserted. During the second and subsequent lines p/f rdy is deasserted whenever the LBDPrevLineF/FO has one word left in the FIFO.. DIU and Address Generation sub-block Signals plf-diurreq 1 Out Signal indicating the LBDPrevLineF/FO has 256-bits of data free.
WO 2004/050369 PCT/AU2003/001616 420 plf diurack 1 In Acknowledge that read request has been accepted and plfdiurreq should be de-asserted. plf-diurdata 1 In Data from the DIU to LBDPrevLineF/FO. First 64-bits are bits 63:0 of 256 bit word. Second 64-bits are bits 127:64 of 256 bit word. Third 64-bits are bits 191:128 of 256 bit word. Fourth 64-bits is are 255:192 of 256 bit word. plf diurrvalid 1 In Signal indicating data on p/f diurdata is valid. plf diuidle I Out Signal indicating DIU state-machine is in the IDLE state. 25.8.5.1 General Description The LBDPrevLineF/FO sub-block comprises a double 256-bit buffer between the LBD and the DIU Interface and Address Generator sub-block. The FIFO is implemented as 8 times 64-bit 5 words. The FIFO is written by the DIU Interface and Address Generator sub-block and read by the LBD. Whenever 4 locations in the FIFO are free the FIFO will request 256-bits of data from the DIU Interface and Address Generation sub-block by asserting p/f diurreq. A signal p/f diurack indicates that the request has been accepted and pif diurreq should be de-asserted. 10 The data is written to the FIFO as 64-bits on piftdiurdata[63:0] over 4 clock cycles. The signal p/f diurvalid indicates that the data returned on pifdiurdata[63:0] is valid. p/fdiurvalid is used to generate the FIFO write enable, write en, and to increment the FIFO write address, write_adr[2:0]. If the LBDPrevLineF/FO still has 256-bits free then pit diurreq should be asserted again. 15 The DIU interface and Address Generation sub-block handles all address pointer management and DIU interfacing and decides whether to acknowledge a request for data from the FIFO. The state diagram of the LBDPrevLineFIFO DIU Interface is shown in Figure 163. If sfugo is deasserted then the state-machine returns to its idle state. The LBD reads 16-bit wide data from the LBDPrevLineF/FO on sfubdIdata[15:0]. 20 /bdsfupladvword from the LBD tells the LBDPrevLineFIFO to supply the next 16-bit word. The FIFO control logic generates a signal wordselect which selects the next 16-bits of the 64-bit FIFO word to output on sfu lbd p/data[15:0]. When the entire current 64-bit FIFO word has been read by the LBD lbd sfupladvword will cause the next word to be popped from the FIFO. Previous line data is not supplied until after the first lbdsfuadvilne strobe from the LBD after 25 sfu go is asserted (zero data is supplied instead). Until the first /bdsfuadvilne strobe after sfugo lbd sfu_pladvword strobes are ignored. The LBDPrevLineF/FO control logic uses a counter, p/count[7:0], to counts the number of DRAM read accesses for the line. When the pLcount counter is equal to the LBDDRAMWords, a complete line of data has been read by the LBD the pif rdy is set high, and the counter is reset. It 30 remains high until the next /bdsfuadvline strobe from the LBD. On receipt of the lbdsfuadvilne WO 2004/050369 PCT/AU2003/001616 421 strobe the remaining data in the 256-bit word in the FIFO is ignored, and the FIFO readadr is rounded up if required. The LBDPrevLineF/FO generates a signal p/f rdy to indicate that it has data available. Until the first lbd sfu advilne for a band has been received and after the number of DRAM reads for a line 5 is equal to LBDDRAMWords, plf rdy is always asserted. During the second and subsequent lines p/frdy is deasserted whenever the LBDPrevLineF/FO has one word left. The last 256-bit word for a line read from DRAM can contain extra padding which should not be output to the LBD. This is because the number of 16-bit words per line may not fit exactly into a 256-bit DRAM word. When the count of the number of DRAM reads for a line is equal to 10 lbd dramwords the LBDPrevLineF/FO must adjust the FIFO write address to point to the next 256-bit word boundary in the FIFO for the next line of data. At the end of a line the read address must round up the nearest 256-bit word boundary and ignore the remaining 16-bit words. This can be achieved by considering the FIFO read address, read adr[2:0], will require 3 bits to address 8 locations of 64-bits. The next 256-bit aligned address is calculated by inverting the MSB of the 15 readadr and setting all other bits to 0. if (read adr[1:0] /= boo AND lbd sfu advline == 1)then read adr[1:0] = bOO read adr[2] = -read adr[2] 20 25.8.6 LBDNextLineFIFO sub-block Table 166. LBDNextLineFIFO Additional 10 Definition Port Name Pins 1/O Description LBDNextLineFIFO Interface Signals nif rdy 1 Out Signal indicating LBDNextLineF/FO is ready to be written to i.e. there is space in the FIFO. DIU and Address Generation sub-block Signals nifdiuwreq 1 Out Signal indicating the LBDNextLineF/FO has 256-bits of data for writing to the DIU. nlf_diuwack 1 In Acknowledge from DIU that write request has been accepted and write data can be output on n/f_diuwdata together with n/f diuwvalid. nif diuwdata 1 Out Data from LBDNextLineFIFO to DIU Interface. First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word hird 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word nif_diuwvalid 1 In Signal indicating that data on wlf_diuwdata is valid. 25.8.6.1 General Description WO 2004/050369 PCT/AU2003/001616 422 The LBDNextLineFIFO sub-block comprises a double 256-bit buffer between the LBD and the DIU Interface and Address Generator sub-block. The FIFO is implemented as 8 times 64-bit words. The FIFO is written by the LBD and read by the DIU Interface and Address Generator. Whenever 4 locations in the FIFO are full the FIFO will request 256-bits of data to be written to the 5 DIU Interface and Address Generator by asserting nif diuwreq. A signal n/f diuwack indicates that the request has been accepted and n/f diuwreq should be de-asserted. On receipt of n/f_diuwack, the data is sent to the DIU Interface as 64-bits on n/f diuwdata[63:0] over 4 clock cycles. The signal n/f_diuwvalid indicates that the data on n/f_diuwdata[63:0] is valid. n/f diuwvalid should be asserted with the smallest latency after n/f_diuwack. If the 10 LBDNextLineFIFO still has 256-bits more to transfer then nff_diuwreq should be asserted again. The state diagram of the LBDNextLineF/FO DIU Interface is shown in Figure 166. If sfugo is deasserted then the state-machine returns to its Idle state. The signal n/frdy indicates that the LBDNextLineFIFO has space for writing by the LBD. The LBD writes 16-bit wide data supplied on lbdsfu wdata[15:0]. /bd sfu wvalid indicates that the data is 15 valid. The LBDNextLineFIFO control logic counts the number of /bdsfu wvalid signals and is used to correctly address into the next line FIFO. The /bdsfuwvalid counter is rounded up to the nearest 256-bit word when a lbdsfuadvine strobe is received from the LBD. Any data remaining in the FIFO is flushed to DRAM with padding being added to fill a complete 256-bit word. 20 25.8.7 sfu lbdrdy Generation The signal sfu_Ibd_rdy is generated by ANDing plf rdy from the LBDPrevLineFIFO and n/f rdy from the LBDNextLineF/FO. sfu_/bd_rdy indicates to the LBD that the SFU is available for writing i.e. there is space available in the LBDNextLineF/FO. After the first lbdsfuadvilne and before the number of 25 lbdsfujpladvword strobes received is equivalent to the line length, sfulbd_rdy indicates that the SFU is available for both reading, i.e. there is data in the LBDPrevLineFFO, and writing. Thereafter it indicates the SFU is available for writing. 25.8.8 LBD-SFU Interfaces Timing Waveform Description In Figure 167 and Figure 168, shows the timing of the data valid and ready signals between the 30 SFU and LBD. A diagram and pseudocode is given for both read and write interfaces between the SFU and LBD. 25.8.8.1 LBD-SFU write interface timing The main points to note from Figure 167 are: * In clock cycle 1 sfulbd_rdy detects that it has only space to receive 2 more 16 bit words 35 from the LBD after the current clock cycle. e The data on /bdsfuwdata is valid and this is indicated by lbdsfu_wdatavalid being asserted. * In clock cycle 2 sfu_bdrdy is deasserted however the LBD can not react to this signal until clock cycle 3. So in clock cycle 3 there is also valid data from the LBD which consumes the 40 last available location available in the FIFO in the SFU (FIFO free level is zero).
WO 2004/050369 PCT/AU2003/001616 423 * In clock cycle 4 and 5 the FIFO is read and 2 words become free in the FIFO. e In cycle 4 the SFU determines that the FIFO has more room and asserts the ready signal on the next cycle. * The LBD has entered a pause mode and waits for sfu_/bdrdy to be asserted again, in 5 cycle 5 the LBD sees the asserted ready signal and responds by writing one unit into the FIFO, in cycle 6. * The SFU detects it has 2 spaces left in the FIFO and the current cycle is an active write (same as in cycle 1), and deasserts the ready on the next cycle. * In cycle 7 the LBD did not have data to write into the FIFO, and so the FIFO remains with 10 one space left * The SFU toggles the ready signal every second cycle, this allows the LBD to write one unit at a time to the FIFO. e In cycle 9 the LBD responds to the single ready pulse by writing into the FIFO and consuming the last remaining unit free. 15 The write interface pseudocode for generating the ready is. // ready generation pseudocode if (fifo free level > 2)then nlfrdy = 1 elsif (fifo free level == 2) then 20 if (lbd-sfu wdatavalid == 1)then nlf_rdy = 0 else nlfrdy = 1 elsif (fifo free level == 1) then 25 if (lbd sfu wdatavalid == 1)then nlf_rdy = 0 else nlf_rdy = NOT(sfulbdrdy) else 30 nlf_rdy = 0 sfulbdrdy = (nlf_rdy AND plfrdy) 25.8.8.2 SFU-LBD read interface The read interface is similar to the write interface except that read data (sfujlbd p/data) takes an extra cycle to respond to the data advance signal (/bd sfupladvword signal). 35 It is not possible to read the FIFO totally empty during the processing of a line, one word must always remain in the FIFO. At the end of a line the fifo can be read to totally empty. This functionality is controlled by the SFU with the generation of the plf rdy signal. There is an apparent corner case on the read side which should be highlighted. On examination this turns out to not be an issue. 40 Scenario 1: WO 2004/050369 PCT/AU2003/001616 424 sfu_/bd_rdy will go low when there is still is still 2 pieces of data in the FIFO. If there is a Ibd sfupladvword pulse in the next cycle the data will appear on sfulbd pidata[15:0]. Scenario 2: sfulbd_rdy will go low when there is still 2 pieces of data in the FIFO. If there is no 5 lbd sfupladvword pulse in the next cycle and it is not the end of the page then the SFU will read the data for the next line from DRAM and the read FIFO will fill more, sfulbd_rdy will assert again, and so the data will appear on sfu_/bd pdata[15:0]. If it happens that the next line of data is not available yet the sfu_lbd p/data bus will go invalid until the next lines data is available. The LBD does not sample the 10 sfu-lbd pidata bus at this time (i.e. after the end of a line) and it is safe to have invalid data on the bus. Scenario 3: sfu_ibdrdy will go low when there is still 2 pieces of data in the FIFO. If there is no lbd sfu pladvword pulse in the next cycle and it is the end of the page then the SFU will 15 do no more reads from DRAM, sfu lbd rdy will remain de-asserted, and the data will not be read out from the FIFO. However last line of data on the page is not needed for decoding in the LBD and will not be read by the LBD. So scenario 3 will never apply. The pseudocode for the read FIFO ready generation // ready generation pseudocode 20 if (pl-count == lbddramwords) then plfrdy = 1 elsif (fifo fill level > 3)then plfrdy = 1 elsif (fifo fill level == 3) then 25 if (lbdsfupladvword == 1)then plf-rdy = 0 else plfrdy = 1 elsif (fifo fill level == 2) then 30 if (lbd sfu_pladvword == 1) then plfrdy = 0 else plfrdy = NOT(sfulbdrdy) else 35 plfrdy = 0 sfulbdrdy = (plfrdy AND nlfrdy) 25.8.9 HCUReadLineFIFO sub-block Table 167. HCUReadLineFIFO Additional 10 Definition 40 WO 2004/050369 PCT/AU2003/001616 425 Port Name Pins 1/O Description DIU and Address Generation sub-block Signals hrf xadvance 1 In Signal from horizontal scaling unit 1 - supply the next dot 1 - supply the current dot hrf hcu endofline 1 Out Signal lasting I cycle indicating then end of the HCU read line. hrfdiurreq 1 Out Signal indicating the HCUReadLineFIFO has space for 256-bits of DIU data. hrf_diurack 1 In cknowledge that read request has been accepted and hrf_diurreq should be de-asserted. hrf diurdata 1 In Data from HCUReadLineFIFO to DIU. First 64-bits are bits 63:0 of 256 bit word. Second 64-bits are bits 127:64 of 256 bit word. Third 64-bits are bits 191:128 of 256 bit word. Fourth 64-bits are bits 255:192 of 256 bit word. hrfdiurvalid I In Signal indicating data on hrfdiurdata is valid. hrf_diuidle 1 Out Signal indicating DIU state-machine is in the IDLE state. 25.8.9.1 General Description The HCUReadLineFIFO sub-block comprises a double 256-bit buffer between the HCU and the DIU Interface and Address Generator sub-block. The FIFO is implemented as 8 times 64-bit words. The FIFO is written by the DIU Interface and Address Generator sub-block and read by the 5 HCU. The DIU Interface and Address Generation (DAG) sub-block interface of the HCUReadLineFFO is identical to the LBDPrevLineFIFO DIU interface. Whenever 4 locations in the FIFO are free the FIFO will request 256-bits of data from the DAG sub-block by asserting hrf diurreq. A signal hrfdiurack indicates that the request has been 10 accepted and hrf diurreq should be de-asserted. The data is written to the FIFO as 64-bits on hrfdiurdata[63:0] over 4 clock cycles. The signal hrfdiurvalid indicates that the data returned on hrf diurdata[63:0] is valid. hrfdiurvalid is used to generate the FIFO write enable, writeen, and to increment the FIFO write address, write_adr[2:0]. If the HCUReadLineFIFO still has 256-bits free then hrf_diurreq should be asserted 15 again. The HCUReadLineFIFO generates a signal sfu_hcu_avail to indicate that it has data available for the HCU. The HCU reads single-bit data supplied on sfuhcusdata. The FIFO control logic generates a signal bitselect which selects the next bit of the 64-bit FIFO word to output on sfu_hcusdata. The signal hcusfuadvdot tells the HCUReadLineFIFO to supply the next dot 20 (hrf xadvance = 1) or the current dot (hrf. xadvance = 0) on sfu hcusdata according to the hrf_xadvance signal from the scaling control unit in the DAG sub-block. The HCU should not WO 2004/050369 PCT/AU2003/001616 426 generate the hcusfuadvdot signal until sfu_hcu avail is true. The HCU can therefore stall waiting for the sfuhcuavail signal. When the entire current 64-bit FIFO word has been read by the HCU hcu_sfuadvdot will cause the next word to be popped from the FIFO. 5 The last 256-bit word for a line read from DRAM and written into the HCUReadLineFIFO can contain dots or extra padding which should not be output to the HCU. A counter in the HCUReadLineFIFO, hcuadvdot count[15:O], counts the number of hcusfuadvdot strobes received from the HCU. When the count equals hcu num dots[15:O] the HCUReadLineF/FO must adjust the FIFO read address to point to the next 256-bit word boundary in the FIFO. This 10 can be achieved by considering the FIFO read address, read_aidr[2:0], will require 3 bits to address 8 locations of 64-bits. The next 256-bit aligned address is calculated by inverting the MSB of the read_adr and setting all other bits to 0. If (hcuadvdotcount == hcunumdots) then 15 readadr[1:O] = bOO readadr[2] = -read adr [2] The DIU Interface and Address Generator sub-block scaling unit also needs to know when hcuadvdotcount equals hcu-numdots. This condition is exported from the HCUReadLineFIFO 20 as the signal hrf hcuendofine. When the hrfhcu endofine is asserted the scaling unit will decide based on vertical scaling whether to go back to the start of the current line or go onto the next line. 25.8.9.2 DRAM Access Limitation The SFU must output 1 bit/cycle to the HCU. Since HCUNumDots may not be a multiple of 256 25 bits the last 256-bit DRAM word on the line can contain extra zeros. In this case, the SFU may not be able to provide 1 bit/cycle to the HCU. This could lead to a stall by the SFU. This stall could then propagate if the margins being used by the HCU are not sufficient to hide it. The maximum stall can be estimated by the calculation: DRAM service period - X scale factor * dots used from last DRAM read for HCU line. 30 25.8.10 DIU Interface and Address Generator Sub-block Table 168. DIU Interface and Address Generator Additional 10 Description Port name Pins 1/O Description Internal LBDPrevLineFIFO Inputs plf diurreq 1 In Signal indicating the LBDPrevLineFiFO has 256 bits of data free. plf diurack 1 Out Acknowledge that read request has been accepted and pifdiurreq should be de-asserted. plf diurdata 1 Out Data from the DIU to LBDPrevLineF/FO. first 64-bits are bits 63:0 of 256 bit word WO 2004/050369 PCT/AU2003/001616 427 Second 64-bits are bits 127:64 of 256 bit word Third 64-bits are bits 191:128 of 256 bit word Fourth 64-bits are bits 255:192 of 256 bit word plf-diurrvalid I Out Signal indicating data on p/f diurdata is valid. plf-diuidle I In Signal indicating DIU state-machine is in the IDLE state. Internal LBDNextLineFIFO Inputs nIf_diuwreq 1 In Signal indicating the LBDNextLineFIFO has 256 bits of data for writing to the DIU. nf diuwack 1 Out Acknowledge from DIU that write request has been accepted and write data can be output on nifdiuwdata together with nif diuwvalid. nlf_diuwdata 1 In Data from LBDNextLineFIFO to DIU Interface. First 64-bits are bits 63:0 of 256 bit word Second 64-bits are bits 127:64 of 256 bit word Third 64-bits are bits 191:128 of 256 bit word Fourth 64-bits are bits 255:192 of 256 bit word nif_diuwvalid 1 In Signal indicating that data on w/f_diuwdata is valid. Internal HCUReadLineFIFO Inputs hrf_hcuendofline 1 In Signal lasting 1 cycle indicating then end of the HCU read line. hrf_xadvance 1 Out Signal from horizontal scaling unit 1 - supply the next dot 1 - supply the current dot hrf diurreq 1 In Signal indicating the HCUReadLineFIFO has space for 256-bits of DIU data. hrf diurack 1 Out Acknowledge that read request has been accepted and hrfdiurreq should be de-asserted. hrf_diurdata 1 Out Data from HCUReadLineFIFO to DIU. First 64-bits are bits 63:0 of 256 bit word Second 64-bits are bits 127:64 of 256 bit word Third 64-bits are bits 191:128 of 256 bit word Fourth 64-bits are bits 255:192 of 256 bit word hrf diurvalid 1 Out Signal indicating data on p/fdiurdata is valid. hrfdiuidle 1 In Signal indicating DIU state-machine is in the IDLE state. 25.8.10.1 General Description WO 2004/050369 PCT/AU2003/001616 428 The DIU Interface and Address Generator (DAG) sub-block manages the bi-level buffer in DRAM. It has a DIU Write Interface for the LBDNextLineFIFO and a DIU Read Interface shared between the HCUReadLineFIFO and LBDPrevLineFIFO. All DRAM address management is centralised in the DAG. DRAM access is pre-emptive i.e. after 5 a FIFO unit has made an access then as soon as the FIFO has space to read or data to write a DIU access will be requested immediately. This ensures there are no unnecessary stalls introduced e.g. at the end of an LBD or HCU line. The control logic for horizontal and vertical non-integer scaling logic is completely contained in the DAG sub-block. The scaling control unit exports the h/f_xadvance signal to the 10 HCUReadlineFIFO which indicates whether to replicate the current dot or supply the next dot for horizontal scaling. 25.8.10.2 DIU Write Interface The LBDNextLineFiFO generates all the DIU write interface signals directly except for sfudiuwadr[21:5] which is generated by the Address Generation logic 15 The DIU request from the LBDNextLineFIFO will be negated if its respective address pointer in DRAM is invalid i.e. n/f_adrvalid = 0. The implementation must ensure that no erroneous requests occur on sfudiuwreq. 25.8.10.3 DIU Read Interface Both HCUReadLineFIFO and LBDPrevLineFIFO share the read interface. If both sources 20 request simultaneously, then the arbitration logic implements a round-robin sharing of read accesses between the HCUReadLineFIFO and LBDPrevLineFIFO. The DIU read request arbitration logic generates a signal, select hrfplf, which indicates whether the DIU access is from the HCUReadLineFIFO or LBDPrevLineFIFO (0=HCUReadLineFIFO, 1 = LBDPrevLineF/FO). Figure 171 shows select hrfp/f multiplexing the returned DIU acknowledge 25 and read data to either the HCUReadLineFIFO or LBDPrevLineFIFO. The DIU read request arbitration logic is shown in Figure 172. The arbitration logic will select a DIU read request on hrfdiurreq or p/f diurreq and assert sfudiurreq which goes to the DIU. The accompanying DIU read address is generated by the Address Generation Logic. The select signal select hrfplf will be set according to the arbitration winner (0=HCUReadLineFFO, 30 1=LBDPrevLineFFO). sfu diu rreq is cleared when the DIU acknowledges the request on diusfurack. Arbitration cannot take place again until the DIU state-machine of the arbitration winner is in the idle state, indicated by diuidle. This is necessary to ensure that the DIU read data is multiplexed back to the FIFO that requested it. The DIU read requests from the HCUReadLineFIFO and LBDPrevLineFIFO will be negated if 35 their respective addresses in DRAM are invalid, hrfadrvalid = 0 or p/f adrvalid = 0. The implementation must ensure that no erroneous requests occur on sfudiu_rreq. If the HCUReadLineFIFO and LBDPrevLineFIFO request simultaneously, then if the request is not following immediately another DIU read port access, the arbitration logic will choose the HCUReadLineFIFO by default. If there are back to back requests to the DIU read port then the WO 2004/050369 PCT/AU2003/001616 429 arbitration logic implements a round-robin sharing of read accesses between the HCUReadLineFIFO and LBDPrevLineFIFO. A pseudo-code description of the DIU read arbitration is given below. 5 // history is of type {none, hrf, plf}, hrf is HCUReadLineFIFO, plf is LBDPrevLineFIFO // initialisation on reset select hrfplf = 0 // default choose hrf history = none // no DIU read access immediately preceding 10 // state-machine is busy between asserting sfu_diurreq and diu idle = 1 // if DIU read requester state-machine is in idle state then de-assert busy 15 if (diu idle == 1) then busy = 0 //if acknowledge received from DIU then de-assert DIU request 20 if (diusfurack == 1) then //de-assert request in response to acknowledge sfudiu rreq = 0 // if not busy then arbitrate between incoming requests 25 // if request detected then assert busy if (busy == 0) then //if there is no request if (hrf diurreq == 0) AND (plf diurreq == 0) then sfu diu rreq = 0 30 history = none // else there is a request else { // assert busy and request DIU read access busy = 1 35 sfu-diu-rreq = 1 // arbitrate in round-robin fashion between the requestors // if only HCUReadLineFIFO requesting choose HCUReadLineFIFO 40 if (hrf diurreq == 1) AND (plfdiurreq == 0) then history = hrf WO 2004/050369 PCT/AU2003/001616 430 selecthrfplf = 0 // if only LBDPrevLineFIFO requesting choose LBDPrevLineFIFO if (hrf diurreq == 0) AND (plf diurreq == 1) then 5 history = plf selecthrfplf = 1 //if both HCUReadLineFIFO and LBDPrevLineFIFO requesting if (hrfdiurreq == 1) AND (plfdiurreq == 1) then 10 // no immediately preceding request choose HCUReadLineFIFO if (history == none) then history = hrf select hrfplf = 0 15 // if previous winner was HCUReadLineFIFO choose LBDPrevLineFIFO elsif (history == hrf) then history = plf select hrfplf = 1 20 // if previous winner was LBDPrevLineFIFO choose HCUReadLineFIFO elsif (history == plf) then history = hrf selecthrfplf = 0 25 // end there is a request 25.8.10.4 Address Generation Logic The DIU interface generates the DRAM addresses of data read and written by the SFU's FIFOs. A write request from the LBDNextLineFIFO on nif_diuwreq causes a write request from the DIU 30 Write Interface. The Address Generator supplies the DRAM write address on sfudiu_wadr[21:5]. A winning read request from the DIU read request arbitration logic causes a read request from the DIU Read Interface. The Address Generator supplies the DRAM read address on sfudiu-radr[21:5]. The address generator is configured with the number of DRAM words to read in a HCU line, 35 hcu dram words, the first DRAM address of the SFU area, startsfu adr[21:5], and the last DRAM address of the SFU area, end sfu adr[21:5]. Note hcu_dramwords configuration register specifies the the number of DRAM words consumed per line in the HCU, while Ibddramwords specifies the number of DRAM words generated per line by the LBD. These values are not required to be the same.
WO 2004/050369 PCT/AU2003/001616 431 For example the LBD may store 10 DRAM words per line (Ibd dram_ words = 10), but the HCU may consume 5 DRAM words per line. In such case the hcudram_words would be set to 5 and the HCU Read Line FIFO would trigger a new line after it had consumed 5 DRAM words (via hrfhcu endofline). 5 Address Generation There are four address pointers used to manage the bi-level DRAM buffer: a. hcureadlinerdadr is the read address in DRAM for the HCUReadLineFIFO. b. hcustartreadlineadr is the start address in DRAM for the current line being read by the HCUReadLineFIFO. 10 c. /bdnextlnewradr is the write address in DRAM for the LBDNextLineFIFO. d. /bd_previne-rdadr is the read address in DRAM for the LBDPrevLineFIFO. The current value of these address pointers are readable by the CPU. Four corresponding address valid flags are required to indicate whether the address pointers are valid, based on whether the FIFOs are full or empty. 15 a. h/f_adrvalid, derived from hrf_nif_fifoemp b. h/f_startadrvalid, derived from starthrf_nf_fifoemp c. n/f_adrvalid. derived from nfplf fifo full and n/f_hrffifofull d. p/f_adrvalid. derived from pLf_n/f_fifoemp DRAM requests from the FIFOs will not be issued to the DIU until the appropriate address flag is 20 valid. Once a request has been acknowledged, the address generation logic can calculate the address of the next 256-bit word in DRAM, ready for the next request. Rules for address pointers The address pointers must obey certain rules which indicate whether they are valid: 25 a. hcureadlnerdadr is only valid if it is reading earlier in the line than /bdnextlinewradr is writing i.e. the fifo is not empty b. The SFU (/bd next/inewradr) cannot overwrite the current line that the HCU is reading from (hcustartread/ine adr) i.e. the fifo is not full, when compared with the HCU read line pointer c. The LBDNextLineFIFO (Ibdnextline_wr adr) must be writing earlier in the line than LBD 30 PrevLineFIFO (/bd prev/ine rd adr) is reading and must not overwrite the current line that the HCU is reading from i.e. the fifo is not full when compared to the PrevLineFifo read pointer d. The LBDPrevLineF/FO (/bdprevline rd.adr) can read right up to the address that LBDNext L/neFIFO (/bd nextinewradr) is writing i.e the fifo is not empty. e. At startup i.e. when sfugo is asserted, the pointers are reset to startsfuadr[21:5]. 35 f. The address pointers can wrap around the SFU bi-level store area in DRAM. Address generator pseudo-code: Initialization: if (sfugo rising edge) then //initialise address pointers to start of SFU address 40 space WO 2004/050369 PCT/AU2003/001616 432 lbdyrevline-rdadr = start_sfuadr[21:5] lbd nextline wr adr = start sfu adr[21:5) hcu readline rd adr = startsfuadr[21:5] hcu startreadline adr = start sfuadr[21:5] 5 libanextline-wrwrap = o lbdyprevline rd_wrap = 0 hcu startreadlinewrap = 0 hcu readline-rdwrap = 0 } 10 Determine FIFO fill and empty status: // calculate which FIFOs are full and empty plf_nlf_fifoeemp = (lbdprevlinerdadr == lbd nextline wr adr) AND (lbdprevlinerd-wrap == 15 lbdnextline_wr_wrap) nlfplffifo full = (lbd nextline wr adr == lbd_prevlinerdadr) AND (lbdprevlinerd-wrap lbdnextline_wr_wrap) 20 nlf hrf fifo full = (lbd nextline wr adr == hcu startreadline adr ) AND (hcustartreadline wrap ! lbdnextline_wrwrap ) // hcu start address can jump addresses and so needs 25 comparitor if (hcustartreadline wrap lbd nextline-wr wrap) then starthrfnlffifo-emp = (hcu_startreadlineadr >=lbd-nextline wr adr) else 30 starthrfnlffifo-emp NOT(hcustartreadline adr >=lbd nextline wr adr) // hcu read address can jump addresses and so needs comparitor if (hcu readline rd wrap == lbdnextline_wr wrap) then 35 hrfnlffifo-emp = (hcureadlinerdadr >=lbd nextline wr adr) else hrf_nlf_fifo emp = NOT(hcureadlinerdadr >=lbd-nextline wr adr) 40 Address pointer updating: WO 2004/050369 PCT/AU2003/001616 433 // LBD Next line FIFO // if DIU write acknowledge and LBDNextLineFIFO is not full with reference to PLF and HRF if (diusfu wack == 1 AND nlfplffifofull 1= 1 AND 5 nlf_hrffifofull !=1 ) then if (lbdnextline wr adr == end-sfuadr) then // if end of SFU address range lbdnextlinewradr = startsfuadr // go to start of SFU address range 10 lbdnextlinewrwrap= NOT (lbdnextline-wr-wrap) / invert the wrap bit else lbdnextlinewradr++ / increment address pointer 15 // LBD PrevLine FIFO //if DIU read acknowledge and LBDPrevLineFIFO is not empty if (diusfurack == 1 AND select hrfplf 1 AND plfnlf_fifoemp !=1) then 20 if (lbdprevline rd adr == endsfuadr) then lbdprevlinerd adr = startsfuadr // go to start of SFU address range lbd_prevlinerd-wrap= NOT (lbd prevline-rd-wrap) / invert the wrap bit 25 else lbd_prevline rdadr++ // increment address pointer // HCU ReadLine FIFO 30 // if DIU read acknowledge and HCUReadLineFIFO fifo is not empty if (diu sfurack == 1 AND select hrfplf 0 AND hrfnlffifo emp 1= 1) then // going to update hcu read line address 35 if (hrf hcu endofline == 1) AND (hrf-yadvance 1) then // read the next line from DRAM // advance to start of next HCU line in DRAM hcu startreadline adr = hcu startreadline adr + lbd dram words 40 offset = hcu startreadline adr - end sfu-adr - 1 // allow for address wraparound WO 2004/050369 PCT/AU2003/001616 434 if (offset >= 0) then hcu startreadline adr = start sfu adr + offset hcustartreadline-wrap= NOT (hcu_startreadlinewrap) 5 hcu readline rd adr = hcu startreadline adr hcu readline rd wrap= hcustartreadline wrap elsif (hrfhcuendofline == 1) AND (hrfyadvance 0) then 10 hcu readlinerdadr = hcustartreadline adr / restart and re-use the same line hcureadlinerd-wrap= hcustartreadlinewrap elsif (hcu readlinerdadr == endsfuadr) then // check if the FIFO needs to wrap space 15 hcureadlinerdadr = startsfuadr // go to start of SFU address space hcureadlinerd-wrap= NOT (hcureadline-rdwrap) else hcu readline rd adr ++ // 20 increment address pointer 25.8.10.4.1 X scaling of data for HCUReadLineFIFO The signal hcusfu_advdot tells the HCUReadLineFIFO to supply the next dot or the current dot on sfuhcusdata according to the hrfxadvance signal from the scaling control unit. When 25 hrfxadvance is 1 the HCUReadLineFIFO should supply the next dot. When hrfxadvance is 0 the HCUReadLineFIFO should supply the current dot. The algorithm for non-integer scaling is described in the pseudocode below. Note, x scalecount should be loaded with xstartcount after reset and at the end of each line. The end of the line is indicated by hrfhcuendoffine from the HCUReadLineFIFO. 30 if (hcu sfu advdot == 1) then if (x scale count + x scale denom - x scale num >= 0) then x scale count =x scale count + x scale denom 35 x scale num hrf xadvance = 1 else xscalecount = x scale count + x scale denom hrf xadvance = 0 40 else x scale count = x scale count WO 2004/050369 PCT/AU2003/001616 435 hrf xadvance = 0 25.8.10.4.2 Y scaling of data for HCUReadLineFIFO The HCUReadLineFIFO counts the number of hcusfuadvdot strobes received from the HCU. When the count equals hcunumdots the HCUReadLineFIFO will assert hrfhcuendof/ine for a 5 cycle. The algorithm for non-integer scaling is described in the pseudocode below. Note, y scale_count should be loaded with zero after reset. if (hrfhcuendofline 1) then 10 if (yscalecount + yscaledenom - yscalenum >= 0) then y_scale count = yscalecount + y_scale_denom y scalenum hrf_yadvance = 1 15 else y_scale count = yscalecount + yscaledenom hrf_yadvance 0 else y_scale_count = y_scalecount 20 hrfyadvance = 0 When the hrf_hcu_endofline is asserted the Y scaling unit will decide whether to go back to the start of the current line, by setting hrf yadvance = 0, or go onto the next line, by setting hrf yadvance = 1. 25 Figure 176 shows an overview of X and Y scaling for HCU data. 26 Tag Encoder (TE) 26.1 OVERVIEW The Tag Encoder (TE) provides functionality for Netpage-enabled applications, and typically requires the presence of IR ink (although K ink can be used for tags in limited circumstances). 30 The TE encodes fixed data for the page being printed, together with specific tag data values into an error-correctable encoded tag which is subsequently printed in infrared or black ink on the page. The TE places tags on a triangular grid, and can be programmed for both landscape and portrait orientations. Basic tag structures are normally rendered at 1600 dpi, while tag data is encoded into an arbitrary 35 number of printed dots. The TE supports integer scaling in the Y-direction while the TFU supports integer scaling in the X-direction. Thus, the TE can render tags at resolutions less than 1600 dpi which can be subsequently scaled up to 1600 dpi. The output from the TE is buffered in the Tag FIFO Unit (TFU) which is in turn used as input by the HCU. In addition, a tefinishedband signal is output to the end of band unit once the input tag WO 2004/050369 PCT/AU2003/001616 436 data has been loaded from DRAM. The high level data path is shown by the block diagram in Figure 177. After passing through the HCU, the tag plane is subsequently printed with an infrared-absorptive ink that can be read by a Netpage sensing device. Since black ink can be IR absorptive, limited 5 functionality can be provided on offset-printed pages using black ink on otherwise blank areas of the page -for example to encode buttons. Alternatively an invisible infrared ink can be used to print the position tags over the top of a regular page. However, if invisible IR ink is used, care must be taken to ensure that any other printed information on the page is printed in infrared transparent CMY ink, as black ink will obscure the infrared tags. The monochromatic scheme was 10 chosen to maximize dynamic range in blurry reading environments. When multiple SoPEC chips are used for printing the same side of a page, it is possible that a single tag will be produced by two SoPEC chips. This implies that the TE must be able to print partial tags. The throughput requirement for the SoPEC TE is to produce tags at half the rate of the PEC1 TE. 15 Since the TE is reused from PEC1, the SoPEC TE over-produces by a factor of 2. In PEC1, in order to keep up with the HCU which processes 2 dots per cycle, the tag data interface has been designed to be capable of encoding a tag in 63 cycles. This is actually accomplished in approximately 52 cycles within PEC1. If the SoPEC TE were to be modified from two dots production per cycle to a nominal one dot per cycle it should not lose the 63/52 cycle 20 performance edge attained in the PEC1 TE. 26.2 WHAT ARE TAGS? The first barcode was described in the late 1940's by Woodland and Silver, and finally patented in 1952 (US Patent 2,612,994) when electronic parts were scarce and very expensive. Now however, with the advent of cheap and readily available computer technology, nearly every item 25 purchased from a shop contains a barcode of some description on the packaging. From books to CDs, to grocery items, the barcode provides a convenient way of identifying an object by a product number. The exact interpretation of the product number depends on the type of barcode. Warehouse inventory tracking systems let users define their own product number ranges, while inventory in shops must be more universally encoded so that products from one company don't 30 overlap with products from another company. Universal Product Codes (UPC) were introduced in the mid 1970's at the request of the National Association of Food Chains for this very reason. Barcodes themselves have been specified in a large number of formats. The older barcode formats contain characters that are displayed in the form of lines. The combination of black and white lines describe the information the barcodes contains. Often there are two types of lines to 35 form the complete barcode: the characters (the information itself) and lines to separate blocks for better optical recognition. While the information may change from barcode to barcode, the lines to separate blocks stays constant. The lines to separate blocks can therefore be thought of as part of the constant structural components of the barcode. Barcodes are read with specialized reading devices that then pass the extracted data onto the 40 computer for further processing. For example, a point-of-sale scanning device allows the sales WO 2004/050369 PCT/AU2003/001616 437 assistant to add the scanned item to the current sale, places the name of the item and the price on a display device for verification etc. Light-pens, gun readers, scanners, slot readers, and cameras are among the many devices used to read the barcodes. To help ensure that the data extracted was read correctly, checksums were introduced as a crude 5 form of error detection. More recent barcode formats, such as the Aztec 2D barcode developed by Andy Longacre in 1995 (US patent number US5591956), but now released to the public domain, use redundancy encoding schemes such as Reed-Solomon. Reed Solomon encoding is adequately discussed in [28], [30] and [34]. The reader is advised to refer to these sources for background information. Very often the degree of redundancy encoding is user selectable. 10 More recently there has also been a move from the simple one dimensional barcodes (line based) to two dimensional barcodes. Instead of storing the information as a series of lines, where the data can be extracted from a single dimension, the information is encoded in two dimensions. Just as with the original barcodes, the 2D barcode contains both information and structural components for better optical recognition. Figure 178 shows an example of a QR Code (Quick 15 Response Code), developed by Denso of Japan (US patent number US5726435). Note the barcode cell is comprised of two areas: a data area (depends on the data being stored in the barcode), and a constant position detection pattern. The constant position detection pattern is used by the reader to help locate the cell itself, then to locate the cell boundaries, to allow the reader to determine the original orientation of the cell (orientation can be determined by the fact 20 that there is no 4th corner pattern). The number of barcode encoding schemes grows daily. Yet very often the hardware for producing these barcodes is specific to the particular barcode format. As printers become more and more embedded, there is an increasing desire for real-time printing of these barcodes. In particular, Netpage enabled applications require the printing of 2D barcodes (or tags) over the page, 25 preferably in infra-red ink. The tag encoder in SoPEC uses a generic barcode format encoding scheme which is particularly suited to real-time printing. Since the barcode encoding format is generic, the same rendering hardware engine can be used to produce a wide variety of barcode formats. Unfortunately the term "barcode" is interpreted in different ways by different people. Sometimes it 30 refers only to the data area component, and does not include the constant position detection pattern. In other cases it refers to both data and constant position detection pattern. We therefore use the term tag to refer to the combination of data and any other components (such as position detection pattern, blank space etc. surround) that must be rendered to help hold or locate/read the data. A tag therefore contains the following components: 35 * data area(s). The data area is the whole reason that the tag exists. The tag data area(s) contains the encoded data (optionally redundancy-encoded, perhaps simply checksummed) where the bits of the data are placed within the data area at locations specified by the tag encoding scheme. * constant background patterns, which typically includes a constant position detection 40 pattern. These help the tag reader to locate the tag. They include components that are easy WO 2004/050369 PCT/AU2003/001616 438 to locate and may contain orientation and perspective information in the case of 2D tags. Constant background patterns may also include such patterns as a blank area surrounding the data area or position detection pattern. These blank patterns can aid in the decoding of the data by ensuring that there is no interference between tags or data areas. 5 In most tag encoding schemes there is at least some constant background pattern, but it is not necessarily required by all. For example, if the tag data area is enclosed by a physical space and the reading means uses a non-optical location mechanism (e.g. physical alignment of surface to data reader) then a position detection pattern is not required. Different tag encoding schemes have different sized tags, and have different allocation of physical 10 tag area to constant position detection pattern and data area. For example, the QR code has 3 fixed blocks at the edges of the tag for position detection pattern (see Figure 178) and a data area in the remainder. By contrast, the Netpage tag structure (see Figures 179 and 180) contains a circular locator component, an orientation feature, and several data areas. Figure 179(a) shows the Netpage tag constant background pattern in a resolution independent form. Figure 179(b) is 15 the same as Figure 179(a), but with the addition of the data areas to the Netpage tag. Figure 180 is an example of dot placement and rendering to 1600 dpi for a Netpage tag. Note that in Figure 180 a single bit of data is represented by many physical output dots to form a block within the data area. 26.2.1 Contents of the data area 20 The data area contains the data for the tag. Depending on the tag's encoding format, a single bit of data may be represented by a number of physical printed dots. The exact number of dots will depend on the output resolution and the target reading/scanning resolution. For example, in the QR code (see Figure 178), a single bit is represented by a dark module or a light module, where the exact number of dots in the dark 25 module or light module depends on the rendering resolution and target reading/scanning resolution. For example, a dark module may be represented by a square block of printed dots (all on for binary 1, or all off for binary 0), as shown in Figure 181. The point to note here is that a single bit of data may be represented in the printed tag by an arbitrary printed shape. The smallest shape is a single printed dot, while the largest shape is 30 theoretically the whole tag itself, for example a giant macrodot comprised of many printed dots in both dimensions. An ideal generic tag definition structure allows the generation of an arbitrary printed shape from each bit of data. 26.2.2 What do the bits represent? 35 Given an original number of bits of data, and the desire to place those bits into a printed tag for subsequent retrieval via a reading/scanning mechanism, the original number of bits can either be placed directly into the tag, or they can be redundancy-encoded in some way. The exact form of redundancy encoding will depend on the tag format. The placement of data bits within the data area of the tag is directly related to the redundancy 40 mechanism employed in the encoding scheme. The idea is generally to place data bits together in WO 2004/050369 PCT/AU2003/001616 439 2D so that burst errors are averaged out over the tag data, thus typically being correctable. For example, all the bits of Reed-Solomon codeword would be spread out over the entire tag data area so to minimize being affected by a burst error. Since the data encoding scheme and shape and size of the tag data area are closely linked, it is 5 desirable to have a generic tag format structure. This allows the same data structure and rendering embodiment to be used to render a variety of tag formats. 26.2.2.1 Fixed and variable data components In many cases, the tag data can be reasonably divided into fixed and variable components. For example, if a tag holds N bits of data, some of these bits may be fixed for all tags while some 10 may vary from tag to tag. For example, the Universal product code allows a country code and a company code. Since these bits don't change from tag to tag, these bits can be defined as fixed, and don't need to be provided to the tag encoder each time, thereby reducing the bandwidth when producing many tags. 15 Another example is Netpage tags. A single printed page contains a number of Netpage tags. The page-id will be constant across all the tags, even though the remainder of the data within each tag may be different for each tag. By reducing the amount of variable data being passed to SoPEC's tag encoder for each tag, the overall bandwidth can be reduced. Depending on the embodiment of the tag encoder, these parameters will be either implicit or 20 explicit, and may limit the size of tags renderable by the system, For example, a software tag encoder may be completely variable, while a hardware tag encoder such as SoPEC's tag encoder may have a maximum number of tag data bits. 26.2.2.2 Redundancy-encode the tag data within the tag encoder Instead of accepting the complete number of TagData bits encoded by an external encoder, the 25 tag encoder accepts the basic non-redundancy-encoded data bits and encodes them as required for each tag. This leads to significant savings of bandwidth and on-chip storage. In SoPEC's case for Netpage tags, only 120 bits of original data are provided per tag, and the tag encoder encodes these 120 bits into 360 bits. By having the redundancy encoder on board the tag encoder the effective bandwidth and internal storage required is reduced to only 33% of what 30 would be required if the encoded data was read directly. 26.3 PLACEMENT OF TAGS ON A PAGE The TE places tags on the page in a triangular grid arrangement as shown in Figure 182. The triangular mesh of tags combined with the restriction of no overlap of columns or rows of tags means that the process of tag placement is greatly simplified. For a given line of dots, all the tags 35 on that line correspond to the same part of the general tag structure. The triangular placement can be considered as alternative lines of tags, where one line of tags is inset by one amount in the dot dimension, and the other line of dots is inset by a different amount. The dot inter-tag gap is the same in both lines of tag, and is different from the line inter-tag gap.
WO 2004/050369 PCT/AU2003/001616 440 Note also that as long as the tags themselves can be rotated, portrait and landscape printing are essentially the same - the placement parameters of line and dot are swapped, but the placement mechanism is the same. The general case for placement of tags therefore relies on a number of parameters, as shown in 5 Figure 183. The parameters are more formally described in Table 169. Note that these are placement parameters and not registers. Table 169. Tag placement parameters parameter description restrictions Tag height The number of dot lines in a tag's bounding box minimum 1 Tag width The number of dots in a single line of the tag's boundingminimum 1 box. The number of dots in the tag itself may vary depending on the shape of the tag, but the number of dots in the bounding box will be constant (by definition). Dot inter-tag gap The number of dots from the edge of one tag's bounding minimum = 0 box to the start of the next tag's bounding box, in the dot direction. Line inter-tagThe number of dot lines from the edge of one tag'sminimum =0 gap bounding box to the start of the next tag's bounding box, in the line direction. Start Position Defines the status of the top left dot on the page - is an offset in dot & row within the tag or the inter-tag gap. AitTagLinePositi Defines the status for the start of the alternate row of tags. on Is an offset in dot within the tag or within the dot inter-tag gap (the row position is always 0). 10 26.4 BASIC TAG ENCODING PARAMETERS SoPEC's tag encoder imposes range restrictions on tag encoding parameters as a direct result of on-chip buffer sizes. Table 170 lists the basic encoding parameters as well as range restrictions where appropriate. Although the restrictions were chosen to take the most likely encoding scenarios into account, it is a simple matter to adjust the buffer sizes and corresponding 15 addressing to allow arbitrary encoding parameters in future implementations. Table 170. Encoding parameters name definition maximum value imposed by TE W page width 214 dotpairs or 20.48 inches at 1600 dpi S tag size typical tag size is 2mm x 2mm maximum tag size is 384 dots x 384 dots before scaling i.e. 6 mm x 6 mm at 1600 dpi WO 2004/050369 PCT/AU2003/001616 441 N number of dots in each dimension of384 dots before scaling the tag E redundancy encoding for tag data Reed-Solomon GF(2 4 ) at 5:10 or 7:8 DF size of fixed data (unencoded) 40 or 56 bits RF size of redundancy-encoded fixed 120 bits data Dv size of variable data (unencoded) 120 or 112 bits Rv size of redundancy-encoded variable 360 or 240 bits data T Iags per page width 256 The fixed data for the tags on a page need only be supplied to the TE once. It can be supplied as 40 or 56 bits of unencoded data and encoded within the TE as described in Section 26.4.1. Alternatively it can be supplied as 120 bits of pre-encoded data (encoded arbitrarily). The variable data for the tags on a page are those 112 or 120 data bits that are variable for each 5 tag. Variable tag data is supplied as part of the band data, and is always encoded by the TE as described in Section 26.4.1, but may itself be arbitrarily pre-encoded. 26.4.1 Redundancy encoding The mapping of data bits (both fixed and variable) to redundancy encoded bits relies heavily on the method of redundancy encoding employed. Reed-Solomon encoding was chosen for its ability 10 to deal with burst errors and effectively detect and correct errors using a minimum of redundancy. Reed Solomon encoding is adequately discussed in [28], [30] and [34]. The reader is advised to refer to these sources for background information. In this implementation of the TE we use Reed-Solomon encoding over the Galois Field GF(2 4 ). Symbol size is 4 bits. Each codeword contains 15 4-bit symbols for a codeword length of 60 bits. 15 The primitive polynomial is p(x) = x 4 + x + 1, and the generator polynomial is g(x) = (x+a)(x+a 2 )...(x+a 2 t), where t = the number of symbols that can be corrected. Of the 15 symbols, there are two possibilities for encoding: * RS(15, 5): 5 symbols original data (20 bits), and 10 redundancy symbols (40 bits). The 10 redundancy symbols mean that we can correct up to 5 symbols in error. The generator 20 polynomial is therefore g(x) = (x+a)(x+a2).. .(x+c 0 ). * RS(15, 7): 7 symbols original data (28 bits), and 8 redundancy symbols (32 bits). The 8 redundancy symbols mean that we can correct up to 4 symbols in error. The generator polynomial is g(x) = (x+a)(x+a2)...(x+aa) In the first case, with 5 symbols of original data, the total amount of original data per tag is 160 25 bits (40 fixed, 120 variable). This is redundancy encoded to give a total amount of 480 bits (120 fixed, 360 variable) as follows: * Each tag contains up to 40 bits of fixed original data. Therefore 2 codewords are required for the fixed data, giving a total encoded data size of 120 bits. Note that this fixed data only needs to be encoded once per page.
WO 2004/050369 PCT/AU2003/001616 442 * Each tag contains up to 120 bits of variable original data. Therefore 6 codewords are required for the variable data, giving a total encoded data size of 360 bits. In the second case, with 7 symbols of original data, the total amount of original data per tag is 168 bits (56 fixed, 112 variable). This is redundancy encoded to give a total amount of 360 bits (120 5 fixed, 240 variable) as follows: * Each tag contains up to 56 bits of fixed original data. Therefore 2 codewords are required for the fixed data, giving a total encoded data size of 120 bits. Note that this fixed data only needs to be encoded once per page. * Each tag contains up to 112 bits of variable original data. Therefore 4 codewords are 10 required for the variable data, giving a total encoded data size of 240 bits. The choice of data to redundancy ratio depends on the application. 26.5 DATA STRUCTURES USED BY TAG ENCODER 26.5.1 Tag Format Structure The Tag Format Structure (TFS) is the template used to render tags, optimized so that the tag can 15 be rendered in real time. The TFS contains an entry for each dot position within the tag's bounding box. Each entry specifies whether the dot is part of the constant background pattern or part of the tag's data component (both fixed and variable). The TFS is very similar to a bitmap in that it contains one entry for each dot position of the tag's bounding box. The TFS therefore has TagHeight x TagWidth entries, where TagHeight matches 20 the height of the bounding box for the tag in the line dimension, and TagWidth matches the width of the bounding box for the tag in the dot dimension. A single line of TFS entries for a tag is known as a tag line structure. The TFS consists of TagHeight number of tag line structures, one for each 1600 dpi line in the tag's bounding box. Each tag line structure contains three contiguous tables, known as tables A, 25 B, and C. Table A contains 384 2-bit entries, one entry for each of the maximum number of dots in a single line of a tag (see Table ). The actual number of entries used should match the size of the bounding box for the tag in the dot dimension, but all 384 entries must be present. Table B contains 32 9-bit data addresses that refer to (in order of appearance) the data dots present in the particular line. All 32 entries must be present, even if fewer are used. Table C contains two 5-bit 30 pointers into table B, and therefore comprises 10 bits. Padding of 214 bits is added. The total length of each tag line structure is therefore 5 x 256-bit DRAM words. Thus a TFS containing TagHeight tag line structures requires a TagHeight *160 bytes. The structure of a TFS is shown in Figure 184. A full description of the interpretation and usage of Tables A, B and C is given in section 26.8.3 on 35 page 476. 26.5.1.1 Scaling a tag If the size of the printed dots is too small, then the tag can be scaled in one of several ways. Either the tag itself can be scaled by N dots in each dimension, which increases the number of entries in the TFS. As an alternative, the output from the TE can be scaled up by pixel replication 40 via a scale factor greater than 1 in the both the TE and TFU.
WO 2004/050369 PCT/AU2003/001616 443 For example, if the original TFS was 21 x 21 entries, and the scaling were a simple 2 x 2 dots for each of the original dots, we could increase the TFS to be 42 x 42. To generate the new TFS from the old, we would repeat each entry across each line of the TFS, and then we would repeat each line of the TFS. The net number of entries in the TFS would be increased fourfold (2 x 2). 5 The TFS allows the creation of macrodots instead of simple scaling. Looking at Figure 185 for a simple example of a 3 x 3 dot tag, we may want to produce a physically large printed form of the tag, where each of the original dots was represented by 7 x 7 printed dots. If we simply performed replication by 7 in each dimension of the original TFS, either by increasing the size of the TFS by 7 in each dimension or putting a scale-up on the output of the tag generator output, then we would 10 have 9 sets of 7 x 7 square blocks. Instead, we can replace each of the original dots in the TFS by a 7 x 7 dot definition of a rounded dot. Figure 186 shows the results. Consequently, the higher the resolution of the TFS the more printed dots can be printed for each macrodot, where a macrodot represents a single data bit of the tag. The more dots that are available to produce a macrodot, the more complex the pattern of the macrodot can be. As an 15 example, Figure n page461 on page Error! Bookmark not defined. shows the Netpage tag structure rendered such that the data bits are represented by an average of 8 dots x 8 dots (at 1600 dpi), but the actual shape structure of a dot is not square. This allows the printed Netpage tag to be subsequently read at any orientation. 26.5.2 Raw tag data 20 The TE requires a band of unencoded variable tag data if variable data is to be included in the tag bit-plane. A band of unencoded variable tag data is a set of contiguous unencoded tag data records, in order of encounter top left of printed band from top left to lower right. An unencoded tag data record is 128 bits arranged as follows: bits 0-111 or 0-119 are the bits of raw tag data, bit 120 is a flag used by the TE (Tag/sPrinted), and the remaining 7 bits are 25 reserved (and should be 0). Having a record size of 128 bits simplifies the tag data access since the data of two tags fits into a 256-bit DRAM word. It also means that the flags can be stored apart from the tag data, thus keeping the raw tag data completely unrestricted. If there is an odd number of tags in line then the last DRAM read will contain a tag in the first 128 bits and padding in the final 128 bits. 30 The TaglsPrinted flag allows the effective specification of a tag resolution mask over the page. For each tag position the TagisPrinted flag determines whether any of the tag is printed or not. This allows arbitrary placement of tags on the page. For example, tags may only be printed over particular active areas of a page. The Tag/sPrinted flag allows only those tags to be printed. Tag/sPrinted is a 1 bit flag with values as shown in Table 171. 35 Table 171. TagIsPrinted values Value description 0 Don't print the tag in this tag position. Output 0 for each dot within the tag bounding box.
WO 2004/050369 PCT/AU2003/001616 444 1 Print the tag as specified by the various tag structures. 26.5.3 DRAM storage requirements The total DRAM storage required by a single band of raw tag data depends on the number of tags present in that band. Each tag requires 128 bits. Consequently if there are N tags in the band, the size in DRAM is 16N bytes. 5 The maximum size of a line of tags is 163 x 128 bits. When maximally packed, a row of tags contains 163 tags (see Table ) and extends over a minimum of 126 print lines. This equates to 282 KBytes over a Letter page. The total DRAM storage required by a single TFS is TagHeight/7 KBytes (including padding). Since the likely maximum value for TagHeight is 384 (given that SoPEC restricts TagWidth to 10 384), the maximum size in DRAM for a TFS is 55 KBytes. 26.5.4 DRAM access requirements The TE has two separate read interfaces to DRAM for raw tag data, TD, and tag format structure, TFS. The memory usage requirements are shown in Table 172. Raw tag data is stored in the 15 compressed page store Table 172. Memory usage requirements Block Size Description Compressed page 2048 Kbytes Compressed data page store for Bi store level, contone and raw tag data. Tag Format Structure 55 Kbyte (384 dot line 55 kB in PEC1 for 384 dot line tags (the tags @ 1600 dpi) benchmark) at 1600 dpi 2.5 mm tags (1/10th inch) @ 1600 dpi require 160 dot lines = 160/384 x55 or 23 kB 2.5 mm tags @ 800 dpi require 80/384 x55 = 12 kB The TD interface will read 256-bits from DRAM at a time. Each 256-bit read returns 2 times 128 20 bit tags. The TD interface to the DIU will be a 256-bit double buffer. If there is an odd number of tags in line then the last DRAM read will contain a tag in the first 128 bits and padding in the final 128 bits. The TFS interface will also read 256-bits from DRAM at a time. The TFS required for a line is 136 bytes. A total of 5 times 256-bit DRAM reads is required to read the TFS for a line with 192 25 unused bits in the fifth 256-bit word. A 136-byte double-line buffer will be implemented to store the TFS data. The TE's DIU bandwidth requirements are summarized in Table 173. Table 173. DRAM bandwidth requirements WO 2004/050369 PCT/AU2003/001616 445 Block Name Direction Maximum number of Peak Bandwidth Average cycles between each (bits/cycle) Bandwidth 256-bit DRAM access (bits/cycle) TD Read Single 256 bit reads 1. 1.02 1.02 TFS Read Single 256 bit reads2. TFS is 1360.093 0.093 bytes. This means there is unused data in the fifth 256 bit read. A total of 5 reads is required. 1: Each 2mm tag lasts 126 dot cycles and requires 128 bits. This is a rate of 256 bits every 252 cycles. 5 2: 17 x 64 bit reads per line in PECI is 5 x 256 bit reads per line in SoPEC with unused bits in the last 256-bit read. 26.5.5 TD and TFS Bandstore wrapping Table 174. Bandstore Inputs from CDU Port Name Pins 1/O Description cduendofbandstore[21: 17 In Address of the end of the current band of data. 5] 256-bit word aligned DRAM address. cdustartofbandstore[21: 17 In Address of the start of the current band of data. 5] 256-bit word aligned DRAM address. 10 Both TD and TFS storage in DRAM can wrap around the bandstore area. The bounds of the band store are described by inputs from the CDU shown in Table 174. The TD and TFS DRAM interfaces therefore support bandstore wrapping. If the TD or TFS DRAM interface increments an address it is checked to see if it matches the end of bandstore address. If so, then the address is mapped to the start of the bandstore. 15 26.5.6 Tag sizes SoPEC allows for tags to be between 0 to 384 dots. A typical 2 mm tag requires 126 dots. Short tags do not change the internal bandwidth or throughput behaviours at all. Tag height is specified so as to allow the DRAM storage for raw tag data to be specified. Minimum tag width is a condition imposed by throughput limitations, so if the width is too small TE cannot consistently 20 produce 2 dots per cycle across several tags (also there are raw tag data bandwidth implications). Thinner tags still work, they just take longer and/or need scaling. 26.6 IMPLEMENTATION 26.6.1 Tag Encoder Architecture A block diagram of the TE can be seen below. 25 The TE writes lines of bi-level tag plane data to the TFU for later reading by the HCU. The TE is responsible for merging the encoded tag data with the tag structure (interpreted from the TFS). Y integer scaling of tags is performed in the TE with X-integer scaling of the tags performed in the WO 2004/050369 PCT/AU2003/001616 446 TFU. The encoded tag layer is generated 2 bits at a time and output to the TFU at this rate. The HCU however only consumes 1 bit per cycle from the TFU. The TE must provide support for 126dot Tags (2mm densely packed) with 108 Tags per line with 128bits per tag. The tag encoder consists of a TFS interface that loads and decodes TFS entries, a tag data 5 interface that loads tag raw data, encodes it, and provides bit values on request, and a state machine to generate appropriate addressing and control signals. The TE has two separate read interfaces to DRAM for raw tag data, TD, and tag format structure, TFS. It is possible that the raw tag data interface, the TD, to the DIU could be replaced by a hardware state machine at a later stage. This would allow flexibility in the generation of tags. Support for Y 10 scaling needs to be added to the PEC1 TE. The PEC1 TE already allows stalling at its output during a line when tfu teoktowrite is deasserted. 26.6.2 Y-Scaling output lines In order to support scaling in the Y direction the following modifications to the PECI TE are suggested to the Tag Data Interface, Tag Format Structure Interface and TE Top Level: 15 for Tag Data Interface: program the configuration registers of Table , firstTagLineHeight and tagMaxLine with true value i.e. not multiplied up by the scale factor YScale. Within the Tag Data interface there are two counters, countx and county that have a direct bearing on the rawTagDataAddr generation. countx decrements as tags are read from DRAM. It is 20 reset to NumTags[RtdTagSenseJ at start of each line of tags. county is decremented as each line of tags is completely read from DRAM i.e. countx = 0. Scaling may be performed by counting the number of times countx reaches zero and only decrementing county when this number reaches YScale. This will cause the TagData Interface to read each line of tag data NumTags[RtdTagSense] * YScale times. 25 e for Tag Format Structure Interface: The implication of Y-scaling for the TFS is that each Tag Line Structure is used YScale times. This may be accomplished in either of two ways: * For each Tag Line Structure read it once from DRAM and reuse YScale times. This involves gating the control of TFS buffer flipping with YScale. Because of the way in which this advTfsLine and advTagLine related functionality is coded in the PEC1 TFS this solution 30 is judged to be error-prone. * Fetch each TagLineStructure YScale times. This solution involves controlling the activity of currTfsAddr with YScale. In SoPEC the TFS must supply five addresses to the DIU to read each individual Tag Line Structure. The DIU returns 4*64-bit words for each of the 5 accesses. This is different from 35 the behaviour in PEC1, where one address is given and 17 data-words were returned by the DIU. Since the behaviour of the currTfsAddr must be changed to meet the requirements of the SoPEC DIU it makes sense to include the Y-Scaling into this change i.e. a count of the number of completed sets of 5 accesses to the DIU is compared to YScale. Only when this 40 count equals YScale can currTfsAddr be loaded with the base address of the next lines Tag WO 2004/050369 PCT/AU2003/001616 447 Line Structure in DRAM, otherwise it is re-loaded with the base address of the current lines Tag Line Structure in DRAM. For Top Level: The Top Level of the TE has a counter, LinePos, which is used to count the number of completed output lines when in a tag gap or in a line of tags. At the start (i.e. 5 top-left hand dot-pair) of a gap or tag LinePos is loaded with either TagGapLine or TagMaxLine. The value of LinePos is decremented at last dot-pair in line. Y-Scaling may be accomplished by gating the decrement of LinePos based on YScale value 26.6.3 TE Physical Hierarchy Figure 188 above illustrates the structural hierarchy of the TE. The top level contains the Tag 10 Data Interface (TDI), Tag Format Structure (TFS), and an FSM to control the generation of dot pairs along with a clocked process to carry out the PCU read/write decoding. There is also some additional logic for muxing the output data and generating other control signals. At the highest level, the TE state machine processes the output lines of a page one line at a time, with the starting position either in an inter-tag gap or in a tag (a SoPEC may be only printing part 15 of a tag due to multiple SoPECs printing a single line). If the current position is within an inter-tag gap, an output of 0 is generated. If the current position is within a tag, the tag format structure is used to determine the value of the output dot, using the appropriate encoded data bit from the fixed or variable data buffers as necessary. The TE then advances along the line of dots, moving through tags and inter-tag gaps according to the tag 20 placement parameters. 26.6.4 10 Definitions Table 175. TE Port List Port Name Pins 1/0 Description Clocks and Resets Pclk 1 In SoPEC Functional clock. prst-n 1 In Global reset signal. Bandstore Signals cduendofbandstore[21:5] 17 In Address of the end of the current band of data. 256-bit word aligned DRAM address. cdustartofbandstore[21:5] 17 In Address of the start of the current band of data. 256-bit word aligned DRAM address. te_finishedband 1 Out TE finished band signal to PCU and ICU. PCU Interface data and control signals pcu-addr[8:2] 7 In PCU address bus. 7 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. te_pcudatain[31:0] 32 Out Read data bus from the TE to the PCU. pcu-rwn 1 in Common read/not-write signal from the PCU.
WO 2004/050369 PCT/AU2003/001616 448 pcute_sel 1 In Block select from the PCU. When pcu te sel is high both pcu addr and pcu-dataout are valid. te pcu-rdy 1 Out Ready signal to the PCU. When te_pcurdy is high it indicates the last cycle of the access. For a write cycle this means pcu dataout has been registered by the block and for a read cycle this means the data on te_pcu datain is valid. TD (raw Tag Data) DIU Read Interface signals td_diu-rreq 1 Out TD requests DRAM read. A read request must be accompanied by a valid read address. td_diu-radr[21:5 17 Out TD read address to DIU. 17 bits wide (256-bit aligned word). diutdrack 1 In Acknowledge from DIU that TD read request has been accepted and new read address can be placed on tediu radr. diudata[63:0] 64 In Data from DIU to TE. First 64-bits are bits 63:0 of 256 bit word; Second 64-bits are bits 127:64 of 256 bit word; hird 64-bits are bits 191:128 of 256 bit word; Fourth 64-bits are bits 255:192 of 256 bit word. diutdrvalid 1 In Signal from DIU telling TD that valid read data is on the diu data bus. TFS (Tag Format Structure) DIU Read Interface signals tfs_diu-rreq 1 Out TFS requests DRAM read. A read request must be accompanied by a valid read address. tfs_diu-radr[21:5] 17 Out TFS Read address to DIU 17 bits wide (256-bit aligned word). diutfsrack 1 In Acknowledge from DIU that TFS read request has been accepted and new read address can be placed on tfs_diu_radr. diu data[63:0] 64 In Data from DIU to TE. First 64-bits are bits 63:0 of 256 bit word; Second 64-bits are bits 127:64 of 256 bit word; hird 64-bits are bits 191:128 of 256 bit word; Fourth 64-bits are bits 255:192 of 256 bit word. diutfs rvalid 1 In Signal from DIU telling TFS that valid read data is on the diu data bus. TFU Interface data and control signals u te oktowrite 1 In Ready signal indicating TFU has space available WO 2004/050369 PCT/AU2003/001616 449 and is ready to be written to. Also asserted from the point that the TFU has recieved its expected number of bytes for a line until the next te tfu wradvline e_tfuwdata[7:0) 8 Out Write data for TFU. te tfuwdatavalid 1 Out Write data valid signal. This signal remains high whenever there is valid output data on tetfuwdata e_tfuwradvline I Out Advance line signal strobed when the last byte in a line is placed on te_tfuwdata 26.6.5 Configuration Registers The configuration registers in the TE are programmed via the PCU interface.Refer to section 21.8.2 on page 351 for the description of the protocol and timing diagrams for reading and writing registers in the TE.Note that since addresses in SoPEC are byte aligned and the PCU only 5 supports 32-bit register reads and writes the lower 2 bits of the PCU address bus are not required to decode the address space for the TE.Table 176 lists the configuration registers in the TE. Registers which address DRAM are 64-bit DRAM word aligned as this is the case for the PEC1 TE. SoPEC assumes a 256-bit DRAM word size. If the TE can be easily modified then the DRAM word addressing should be modified to 256-bit word aligned addressing. Otherwise, software 10 should program these the 64-bit word aligned addresses on a 256-bit DRAM word boundary.. Table 176. TE Configuration Registers Address register name #bits value on reset description TE_base+ Control registers Ox00 Reset 1 1 A write to this register causes a reset of the TE. This register can be read to indicate the reset state: 0 - reset in progress 1 - reset not in progress 0x04 Go 1 0 Writing 1 to this register starts the TE. Writing 0 to this register halts the TE. When Go is deasserted the state-machines go to their idle states but all counters and configuration registers keep their values.
WO 2004/050369 PCT/AU2003/001616 450 When Go is asserted all counters are reset, but con figuration registers keep their values (i.e. they don't get reset). NextBandEnable is cleared when Go is asserted. The TFU must be started before the TE is started. This register can be read to determine if the TE is running (1 = running, 0 = stopped). Setup registers (constant for processing of a page) 0x40 TfsStartAdr 19 0 Points to the first word of the (64-bit first TFS line in DRAM. aligned DRAM address should start at a 256-bit aligned loca tion) 0x44 TfsEndAdr 19 0 Points to the first word of the (64-bit last TFS line in DRAM. aligned DRAM address should start at a 256-bit aligned loca tion) 0x48 TfsFirstLineA 19 0 Points to the first word of the dr first TFS line to be (64-bit encountered on the page. If aligned the start of the page is in an DRAM inter-tag gap, then this value address) will be the same as TFSStartAdr since the first tag WO 2004/050369 PCT/AU2003/001616 451 line reached will be the top line of a tag. Ox4C DataRedun 1 0 Defines the data to redundancy ratio for the Reed Solomon encoder. Symbol size is always 4 bits, Code word size is always 15 symbols (60 bits). 0 - 5 data symbols (20 bits), 10 redundancy symbols (40 bits) 1 -7 data symbols (28 bits), 8 redundancy symbols (32 bits) 0x50 Decode2DEn 1 0 Determines whether or not the data bits are to be 2D decoded rather than redundancy encoded (each 2 bits of the data bits becomes 4 output data bits). 0 = redundancy encode data 1 = decode each 2 bits of data into 4 bits 0x54 VariableData 1 0 Defines whether or not there Present is variable data in the tags. If there is none, no attempt is made to read tag data, and tag encoding should only reference fixed tag data. Ox58 EncodeFixed 1 0 Determines whether or not the lower 40 (or 56) bits of fixed data should be encoded into 120 bits or simply used as is. Ox5C TagMaxDotpa8 0 The width of a tag in dot irs pairs, minus 1. Minimum 0, Maximum=191. Ox60 TagMaxLine 9 0 The number of lines in a tag, minus 1. Minimum 0, Maximum = 383.
WO 2004/050369 PCT/AU2003/001616 452 0x64 TagGapDFot 14 0 The number of dot pairs between tags in the dot dimension minus 1. Only valid if TagGapPresent[bit 0] = 1. Ox68 TagGapLine 14 0 Defines the number of dotlines between tags in the line dimension minus 1. Only valid if TagGapPresent[bitl] = 1. Ox6C DotPairsPerLi 14 0 Number of output dot pairs to ne generate per tag line. Ox70 DotStartTagS 2 0 Determines for the first/even ense (bit 0) and second/odd (bit 1) rows of tags whether or not the first dot position of the line is in a tag. 1 = in a tag, 0 = in an inter-tag gap. Ox74 TagGapPrese 2 0 Bit 0 is I if there is an inter nt tag gap in the dot dimension, and 0 if tags are tightly packed. Bit 1 is 1 if there is an inter tag gap in the line dimension, and 0 if tags are tightly packed. Ox78 YScale 8 1 Tag scale factor in Y direction. Output lines to the TFU will be generated YScale times. 0x80 to DotStartPos 2x14 0 Determines for the first/even Ox84 (0) and second/odd (1) rows of tags the number of dotpairs remaining minus 1, in either the tag or inter-tag gap at the start of the line. Ox88 to 0x8C NumTags x8 0 Determines for the first/even and second/odd rows of tags WO 2004/050369 PCT/AU2003/001616 453 how many tags are present in a line (equals number of tags minus 1). Setup band related registers OxCO NextBandStar Holds the value of tTagDataAdr StartTagDataAdr for the next (64-bit band. This value is copied to aligned StartTagDataAdr when DRAM DoneBand is 1 and address - NextBandEnable is 1, or should start at when Go transitions from 0 to a 256-bit 1. aligned loca tion) OxC4 NextBandEnd Holds the value of OfTagData EndOfTagData for the next (64-bit band. This value is copied to aligned EndOfTagData when DRAM DoneBand is 1 and address) NextBandEnable is 1, or when Go transitions from 0 to 1. OxC8 NextBandFirs 9 0 Holds the value of tTagLine- FirstTagLineHeight for the Height next band. This value is copied to FirstTagLineHeight when DoneBand gets is 1 and NextBandEnable is 1, or when Go transitions from 0 to 1. OxCC NextBandEna When NextBandEnable is 1 ble and DoneBand is 1, then when te finishedband is set at the end of a band: -NextBandStartTagDataAdr is copied to StartTagDataAdr -NextBandEndOfTagData is copied to EndOfTagData WO 2004/050369 PCT/AU2003/001616 454 -NextBandFirstTagLineHeight is copied to FirstTa gLineHeight -DoneBand is cleared -NextBandEnable is cleared. NextBandEnable is cleared when Go is asserted. Read-only band related registers OxDO DoneBand 1 0 Specifies whether the tag data interface has finished loading all the tag data for the band. It is cleared to 0 when Go transitions from 0 to 1. When the tag data interface has finished loading all the tag data for the band, the tefinishedband signal is given out and the DoneBand flag is set. If NextBandEnable is1 at this time then startTagDataAdr, endOfTagData and firstTaglineHeight are updated with the values for the next band and DoneBand is cleared. Processing of the next band starts immediately. If NextBandEnable is 0 then the remainder of the TE will continue to run,, while the read control unit waits for NextBandEnable to be set before it restarts. Read only. OxD4 StartTagData 19 0 The start address of the Adr current row of raw tag data. (64-bit This is initially points to the aligned first word of the band's tag DRAM data, which should be aligned WO 2004/050369 PCT/AU2003/001616 455 address - to a 128-bit boundary (i.e. the should start at lower bit of this address a 256-bit should be 0). Read only. aligned loca tion) OxD8 EndOfTagDat 19 0 Points to the address of the a final tag for the band. When (64-bit all the tag data up to and aligned including address DRAM endOfTagData has been read address) in, the te_finishedband signal is given and the doneBand flag is set. Read only. OxDC FirstTagLineH 9 0 The number of lines minus 1 eight in the first tag encountered in this band. This will be equal to TagMaxLine if the band starts at a tag boundary. Read only. Work registers (set before starting the TE and must not be touched between bands) Ox100 LineInTag 1 0 Determines whether or not the first line of the page is in a line of tags or in an inter-tag gap. 1 - in a tag, 0 - in an inter-tag gap. Ox104 LinePos 14 0 The number of lines remaining minus 1, in either the tag or the inter-tag gap in at the start of the page. Ox1 10 to TagData 4x32 0 This 128 bit register must be Ox11C set up initially with the fixed data record for the page. This is either the lower 40 (or 56) bits (and the encodeFixed WO 2004/050369 PCT/AU2003/001616 456 register should be set), or the lower 120 bits (and encodedFixed should be clear). The tagData[0] register contains the lower 32 bits and the tagData[3] register contains the upper 32 bits. This register is used throughout the tag encoding process to hold the next tag's variable data. Work registers (set internally) Read-only from the point of view of PCU register access 0x140 DotPos 14 0 Defines the number of dotpairs remaining in either the tag or inter-tag gap. Does not need to be setup. Ox144 CurrTagPlane 14 0 The dot-pair number being Adr generated. Ox1 48 DotsinTag 1 0 Determines whether the current dot pair is in a tag or not 1 - in a tag, 0 - in an inter-tag gap. Ox1 4C TagAltSense 1 0 Determines whether the production of output dots is for the first (and subsequent even) or second (and subsequent odd) row of tags. 0x154 CurrTFSAdr 19 0 Points to the start next line of (64-bit the TFS to be read in. aligned DRAM address) 0x158 ReadsRemai 4 0 Number of reads remaining in WO 2004/050369 PCT/AU2003/001616 457 ning the current burst from the raw tag data interface Ox1 5C CountX 8 0 The number of tags remaining to be read (minus 1) by the raw tag data interface for the current line. Ox160 CountY 9 0 The number of times (minus 1) the tag data for the current line of tags needs to be read in by the raw tag data interface. Ox1 64 RtdTagSense 1 0 Determines whether the raw tag data interface is currently reading even rows of tags (=0) or odd rows of tags (=1) with respect to the start of the page. Note that this can be different from tagAltSense since the raw tag data interface is reading ahead of the production of dots. Ox1 68 RawTagData 19 0 The current read address Adr within the unencoded raw tag (64-bit data. aligned DRAM address) The PCU accessible registers are divided amongst the TE top level and the TE sub-blocks. This is achieved by including write decoders in the sub-blocks as well as the top level, see Figure 189. In order to perform reads the sub-block registers are fed to the top level where the read decode is 5 carried out on all the PCU accessible TE registers. 26.6.5.1 Starting the TE and restarting the TE between bands The TE must be started after the TFU. For the first band of data, users set up NextBandStartTagDataAdr, NextBandEndTagData and NextBandFirstTagLineHeight as well as other TE configuration registers. Users then set the TE's 10 Go bit to start processing of the band. When the tag data for the band has finished being decoded, the tefinishedband interrupt will be sent to the PCU and ICU indicating that the memory associated with the first band is now free. Processing can now start on the next band of tag data.
WO 2004/050369 PCT/AU2003/001616 458 In order to process the next band NextBandStartTagDataAdr, NextBandEndTagData and NextBandFirstTagLineHeight need to be updated before writing a 1 to NextBandEnable. There are 4 mechanisms for restarting the TE between bands: a. tefinishedband causes an interrupt to the CPU. The TE will have set its DoneBand bit. The 5 CPU reprograms the NextBandStartTagDataAdr, NextBandEndTagData and NextBandFirstTagLineHeight registers, and sets NextBandEnable to restart the TE. b. The CPU programs the TE's NextBandStartTagDataAdr, NextBandEndTagData and NextBandFirstTagLineHeight registers and sets the NextBandEnable flag before the end of the current band. At the end of the current band the TE sets DoneBand. As NextBandEnable is 10 already 1, the TE starts processing the next band immediately. c. The PCU is programmed so that tefinishedband triggers the PCU to execute commands from DRAM to reprogram the NextBandStartTagDataAdr, NextBandEndTagData and Next BandFrstTagLineHeight registers and set the NextBandEnable bit to start the TE processing the next band. The advantage of this scheme is that the CPU could process band headers in 15 advance and store the band commands in DRAM ready for execution. d. This is a combination of b and c above. The PCU (rather than the CPU in b) programs the TE's NextBandStartTagDataAdr, NextBandEndTagData and NextBandFirstTagLineHeight registers and sets the NextBandEnable bit before the end of the current band. At the end of the current band the TE sets DoneBand and pulses te_finishedband. As NextBandEnable is already 1, the 20 TE starts processing the next band immediately. Simultaneously, tefinishedband triggers the PCU to fetch commands from DRAM. The TE will have restarted by the time the PCU has fetched commands from DRAM. The PCU commands program the TE next band shadow reg isters and sets the NextBandEnable bit. After the first tag on the page, all bands have their first tag start at the top i.e. 25 NextBandFirstTagLineHeight = TagMaxLine. Therefore the same value of NextBandFirstTagLineHeight will normally be used for all bands. Certainly, NextBandFirstTagLineHeight should not need to change after the second time it is programmed. 26.6.6 TE Top Level FSM The following diagram illustrates the states in the FSM. 30 At the highest level, the TE state machine steps through the output lines of a page one line at a time, with the starting position either in an inter-tag gap (signal dotsintag = 0) or in a tag (signals ffsvalid and tdvalid and lineintag = 1) (a SoPEC may be only printing part of a tag due to multiple SoPECs printing a single line). If the current position is within an inter-tag gap, an output of 0 is generated. If the current position 35 is within a tag, the tag format structure is used to determine the value of the output dot, using the appropriate encoded data bit from the fixed or variable data buffers as necessary. The TE then advances along the line of dots, moving through tags and inter-tag gaps according to the tag placement parameters. Table 177 highlights the signals used within the FSM. 40 Table 177. Signals used within TE top level FSM WO 2004/050369 PCT/AU2003/001616 459 Signal Name Function pclk Sync clock used to register all data within the FSM prst-n, te_reset Reset signals advtagline 1 cycles pulse indicating to TDI and TFS sub-blocks to move onto the next line of Tag data currdotlineadr[1 3:0] Address counter starting 2 pclk ahead of currtagplaneadr to generate the correct dotpair for the current line dotpos Counter to identify how many dotpairs wide the tag/gap is dotsintag Signal identifying whether the dotpair are in a tag(1)/gap(0) ineintag_temp Identical to lineintag but generated 1 pclk earlier linepos shadow Shadow register for linepos due to linepos being written to by 2 different processes talaltsense Flag which alternates between tag/gap lines te state FSM state variable teplanebuf 6-bit shift register used to format dotpairs into a byte for the TFU wradvline Advance line signal strobed when the last byte in a line is placed on te tfu wdata Due to the 2 system clock delay in the TFS (both Table A and Table B outputs are registered) the TE FSM is working 2 system clock cycles AHEAD of the logic generating the write data for the 5 TFU. As a result the following control signals had to be single/double registered on the system clock. The tagdot line state can be broken down into 3 different stages. Stagel:- The state tagdot line is entered due to the go signal becoming active. This state controls the writing of dotbytes to the TFU. As long as the tag line buffer address is not equal to 10 the dotpairsperline register value and tfu teoktowrite is active, and there is valid TFS and TD available or taggaps, dotpairs are buffered into bytes and written to the TFU. The tag line buffer address is used internally but not supplied to the TFU since the TFU is a FIFO rather than the line store used in PEC1. While generating the dotline of a tag/gap line (lineintag flag = 1) the dot position counter dotpos is 15 decremented/reloaded (with tagmaxdotpairs or taggapdot) as the TE moves between tags/gaps. The dotsintag flag is toggled between tags/gaps (0 for a gap, 1 for a tag). This pattern continues until the end of a dotline approaches (currdotlineadr == dotpairsperine). 2 system clock cycles before the end of the dotline the lineintag and tagaltsense signals must be prepared for the next dotline be it in a tag/gap dotline or a purely gap dotline. 20 Stage2:- At this point the end of a dot line is reached so it is time to decrement the linepos counter if still in a tag/gap row or reload the linepos register, dotpos counter and reprogram the dotsintag flag if going onto another tag/gap or pure gap row. Any signal with the _temp extension means this register is updated a cycle early in order for the real register to get its correct value while WO 2004/050369 PCT/AU2003/001616 460 switching between dot lines and tag rows when dotpos and inepos counters reach zero i.e when dotpos = 0 the end of a tag/gap has been reached, when linepos = 0 the end of a tag row is reached. This stage uses the signals lineintag temp and tagaltsense which were generated one system clock cycle earlier in Stage 1. 5 Stage3:- This stage implements the writing of dotpairs to the correct part of the 6-bit shift register based on the LSBs of currtagplaneadr and also implements the counter for the currtagplaneadr. The currtagplaneadr is reset on reaching currtagplaneadr = (dotpairsper/ine - 1). All the qualifier signals e.g dotsintag for this stage are delayed by 2 system clock cycles i.e. the currtagplaneadr (which is the internal write address not needed by the TFU) cannot be incremented until the 10 dotpairs are available which is always 2 system clock cycles later than when currdotlineadr is incremented. The wradvine and advtagline pulses are generated using the same logic (currently separated in the PECI Tag Encoder VHDL for clarity). Both of these pulses used to update further registers hence the reason they do not use the delayed by 2 system clock cycle qualifiers. 15 26.6.7 Combinational Logic The TDI is responsible for providing the information data for a tag while the TFSI is responsible for deciding whether a particular dot on the tag should be printed as background pattern or tag information. Every dot within a tag's boundary is either an information dot or part of the background pattern. 20 The resulting lines of dots are stored in the TFU. The TFSI reads one Tag Line Structure (TLS) from the DIU for every dot line of tags. Depending on the current printing position within the tag (indicated by the signal tagdotnum), the TFS interface outputs dot information for two dots and if necessary the corresponding read addresses for encoded tag data. The read address are supplied to the TDI which outputs the corresponding 25 data values. These data values (tdi etdO and tdi etdl) are then combined with the dot information (tfsi tadotO and tfsi ta dot1) to produce the dot values that will actually be printed on the page (dots), see Figure 192. The signal lastdotintag is generated by checking that the dots are in a tag (dotsintag = 1) and that 30 the dotposition counter dotpos is equal to zero. It is also used by the TFS to load the index address register with zeros at the end of a tag as this is always the starting index when going from one tag to the next. lastdotintag is gated with advtagline in the TFSi (Table C) where advtfs_ine pulse is used to update the Table C address reg for the new tag line - this is because lastdotintag occurs a cycle earlier than adv_ifsline which would result in the wrong Table C value for the last 35 dotpair. lastdotintag is also used in the TDi FSM (etd switch state) to pulse the etdadvtag signal hence switching buffers in the ETDi for the next tag. The signal lastdotintagl is identical to lastdotintag except it is combinatorially generated (1 cycle earlier than lastdotintag, except at the end of a tagline). lastdotintagl signal is only used in the TDi to reset the tdvalid signal on the cycle when dotpos = 0. Note the UNSIGNED(currdotlineadr) = WO 2004/050369 PCT/AU2003/001616 461 UNSIGNED(dotpairsperline) - 1 not UNSIGNED(currdot/ineadr) = UNSIGNED(dotpairsperline) - 2 as in the lastdotintag gen process as this is an combinatorial process. The dotposvalid signal is created based on being in a tag line (lineintag1 = 1), dots being in a tag (dotsintagl = 1), having a valid tag format structure available (tfsvaidl = 1) and having encoded 5 tag data available (tdvalidl = 1). Note that each of the qualifier signals are delayed by I polk cycle due to the registering of Table A output data into Table C where dotposvalid is used. The dotposvalid signal is used as an enable to load the Table C address register with the next index into Table B which in turn provides the 2 addresses to make 2 dots available. The signal teffu_wdatavalid can only be active if in a taggap or if valid tag data is available 10 (tdvalid2 and tfsvalid2) and the currtagpplaneadr(1:0) equal 11 i.e. a byte of data has been generated by combining four dotpairs. The signal tagdotnum tells the TFS how many dotpairs remain in a tag/gap. It is calculated by subtracting the value in the dotpos counter from the value programmed in the tagmaxdotpairs register. 15 26.7 TAG DATA INTERFACE (TDi) 26.7.1 1/O Specification Table 178. TDI Port List signal name I/O Description Clocks and Resets pclk In SoPEC system clock prstn In -Active-low, synchronous reset in pclk domain. DIU Read Interface Signals diu-data[63:0] In Data from DRAM. td_diurreq Out Data request to DRAM. td_diuradr[21:5] Out Read address to DRAM. diutdrack In Data acknowledge from DRAM. diutdrvalid In Data valid signal from DRAM. PCU Interface Data, Control Signals and pcudataout[31:0] In PCU writes this data. pcu-addr[8:2] In PCU accesses this address. pcu rwn In Global read/write-not signal from PCU. pcu-te-sel In PCU selects TE for r/w access. pcu-te-reset In PCU reset. td_tedoneband Out PCU readable registers. td te dataredun td te decode2den d_tevariabledatapresent d te encodefixed WO 2004/050369 PCT/AU2003/001616 462 td_tenumtags0 td_tenumtagsl td_testarttagdataadr td_terawtagdataadr td_te_endoftagdata td_tefirsttaglineheight tdjte-tagdataO d-te-tagdatal td-te-tagdata2 td-te-tagdata3 td te countx td tecounty td_tertdtagsense td_te_readsremaining TFS (Tag Format Structure) tfsi-adr[8:0] In ]Read address for doto tfsi-adr1 [8:0] In jRead address for dot1 Bandstore Signals cdustartofbandstore[24:0] In Start memory area allocated for page bands cduendofbandstore[24:0] In Last address of the memory allocated for page bands te_finishedband Out Tag encoder band finished 26.7.2 Introduction The tag data interface is responsible for obtaining the raw tag data and encoding it as required by the tag encoder. The smallest typical tag placement is 2mm x 2mm, which means a tag is at least 126 1600 dpi dots wide. 5 In PECI, in order to keep up with the HCU which processes 2 dots per cycle, the tag data interface has been designed to be capable of encoding a tag in 63 cycles. This is actually accomplished in approximately 52 cycles within PEC1. For SoPEC the TE need only produce one dot per cycle; it should be able to produce tags in no more than twice the time taken by the PECI TE. Moreover, any change in implementation from two dots to one dot per cycle should not lose 10 the 63/52 cycle performance edge attained in the PEC1 TE. As shown in Figure 198, the tag data interface contains a raw tag data interface FSM that fetches tag data from DRAM, two symbol-at-a-time GF(2 4 ) Reed-Solomon encoders, an encoded data interface and a state machine for controlling the encoding process. It also contains a tagData register that needs to be set up to hold the fixed tag data for the page. 15 The type of encoding used depends on the registers TEencodefixed, TE_dataredun and TEdecode2den the options being, WO 2004/050369 PCT/AU2003/001616 463 e (15,5) RS coding, where every 5 input symbols are used to produce 15 output symbols, so the output is 3 times the size of the input. This can be performed on fixed and variable tag data. * (15,7) RS coding, where every 7 input symbols are used to produce 15 output symbols, so 5 for the same number of input symbols, the output is not as large as the (15,5) code (for more details see section 26.7.6 on page 467). This can be performed on fixed and variable tag data. * 2D decoding, where each 2 input bits are used to produce 4 output bits. This can be performed on fixed and variable tag data. 10 9 no coding, where the data is simply passed into the Encoded Data Interface. This can be performed on fixed data only. Each tag is made up of fixed tag data (i.e. this data is the same for each tag on the page) and variable tag data (i.e. different for each tag on the page). Fixed tag data is either stored in DRAM as 120-bits when it is already coded (or no coding is 15 required), 40-bits when (15,5) coding is required or 56-bits when (15,7) coding is required. Once the fixed tag data is coded it is 120-bits long. It is then stored in the Encoded Tag Data Interface. The variable tag data is stored in the DRAM in uncoded form. When (15,5) coding is required, the 120-bits stored in DRAM are encoded into 360-bits. When (15,7) coding is required, the 112-bits stored in DRAM are encoded into 240-bits. When 2D decoding is required the 120-bits stored in 20 DRAM are converted into 240-bits. In each case the encoded bits are stored in the Encoded Tag Data Interface. The encoded fixed and variable tag data are eventually used to print the tag. The fixed tag data is loaded in once from the DRAM at the start of a page. It is encoded as necessary and is then stored in one of the 8x1 5-bits registers/RAMs in the Encoded Tag Data 25 Interface. This data remains unchanged in the registers/RAMs until the next page is ready to be processed. The 120-bits of unencoded variable tag data for each tag is stored in four 32-bit words. The TE re reads the variable tag data, for a particular tag from DRAM, every time it produces that tag. The variable tag data FIFO which reads from DRAM has enough space to store 4 tags. 30 26.7.2.1 Bandstore wrapping Both TD and TFS storage in DRAM can wrap around the bandstore area. The bounds of the band store are described by inputs from the CDU shown in Table .The TD and TFS DRAM interfaces therefore support bandstore wrapping. If the TD or TFS DRAM interface increments an address it is checked to see if it matches the end of bandstore address. If so, then the address is mapped to 35 the start of the bandstore. 26.7.3 Data Flow An overview of the dataflow through the TDI can be seen in Figure 198 below. The TD interface consists of the following main sections: e the Raw Tag Data Interface - fetches tag data from DRAM; 40 e the tag data register; WO 2004/050369 PCT/AU2003/001616 464 e 2 Reed Solomon encoders - each encodes one 4-bit symbol at a time; * the Encoded Tag Data Interface - supplies encoded tag data for output; e Two 2D decoders. The main performance specification for PEC1 is that the TE must be able to output data at a 5 continuous rate of 2 dots per cycle. 26.7.4 Raw tag data interface The raw tag data interface (RTDI) provides a simple means of accessing raw tag data in DRAM. The RTDI passes tag data into a FIFO where it can be subsequently read as required. The 64-bit output from the FIFO can be read directly, with the value of the wrrd counter being used to 10 set/reset as the enable signal (rtdAvai). The FIFO is clocked out with receipt of an rtdRd signal from the TS FSM. Figure 199 shows a block diagram of the raw tag data interface. 26.7.4.1 RTDI FSM The RTDI state machine is responsible for keeping the raw tag FIFO full. The state machine reads 15 the line of tag data once for each printline that uses the tag. This means a given line of tag data will be read TagHeight times. Typically this will be 126 times or more, based on an approximately 2mm tag. Note that the first line of tag data may be read fewer times since the start of the page may be within a tag. In addition odd and even rows of tags may contain different numbers of tags. Section 26.6.5.1 outlines how to start the TE and restart it between bands. Users must set the 20 NextBandStartTagDataAdr, NextBandEndOfFagData, NextBandFirstTagLineHeight and numTags[0], numTags[l] registers before starting the TE by asserting Go. To restart the tag encoder for second and subsequent bands of a page, the NextBandStartTagDataAdr, NextBandEndOfTagData and NextBandFirstTagLineHeight registers need to be updated (typically numTags[0J and numTags[lj will be the same if the previous band 25 contains an even number of tag rows) and NextBandEnable set. See Section 26.6.5.1 for a full description of the four ways of reprogramming the TE between bands. The tag data is read once for every printline containing tags. When maximally packed, a row of tags contains 163 tags (see Table n page465 on page 440). The RTDI State Flow diagram is shown in Figure 200. An explanation of the states follows: 30 idle state:- Stay in the idle state if there is no variable data present. If there is variable data present and there are at least 4 spaces left in the FIFO then request a burst of 2 tags from the DRAM (1 * 256bits). Counter countx is assigned the number of tags in a evenfodd line which depends on the value of register rtdtagsense. Down-counter county is assigned the number of dot lines high a tag will be (min 126). Initially it must be set the firsttaglineheight value as the TE may 35 be between pages (i.e. a partial tag). For normal tag generation county will take the value of tagmaxiine register. diuaccess:- The diuaccess state will generate a request to the DRAM if there are at least 4 spaces in the FIFO. This is indicated by the counter wrrdcounter which is incremented/decremented on writes/reads of the FIFO. As long as wr rdcounter is less than 4 40 (FIFO is 8 high) there must be 4 locations free. A control signal called tddiu.radrvalid is WO 2004/050369 PCT/AU2003/001616 465 generated for the duration of the DRAM burst access. Addresses are sent in bursts of 1. The counter burstcount controls this signal, (will involve modification to existing TE code.) If there is an odd number of tags in line then the last DRAM read will contain a tag in the first 128 bits and padding in the final 128 bits. 5 fifoload:- This state controls the addressing to the DRAM. Counters countx and county are used to monitor whether the TE is processing a line of dots within a row of tags. When countx is zero it means all tag dots for this row are complete. When county is zero it means the TE is on the last line of dots (prior to Y scaling) for this row of tags. When a row of tags is complete the sense of rtdtagsense is inverted (odd/ even). The rawtagdataadr is compared to the teendoftagdata 10 address. If rawtagdataadr = endoftagdata the doneband signal is set, the finishedband signal is pulsed, and the FSM enters the rtdstal state until the doneband signal is reset to zero by the PCU by which time the rawtagdata, endoftagedata and firsttaglineheight registers are setup with new values to restart the TE. This state is used to count the 64-bit reads from the DIU. Each time diutdrvalid is high rtddatacount is incremented by 1. The compare of rtd datacount = 15 rtd_num is necessary to find out when either all 4*64-bit data has been received or n*64-bit data (depending on a match of rawtagdataadr = endoftagdata in the middle of a set of 4*64-bit values being returned by the DIU. rtd_stall:- This state waits for the the doneband signal to be reset (see page 458 for a description of how this occurs). Once reset the FSM returns to the idle state. This states also performs the 20 same count on the diudata read as above in the case where diu_tdrvalid has not gone high by the time the addressing is complete and the end of band data has been reached i.e. rawtagdataadr = endoftagdata 26.7.5 TDI state machine The tag data state machine has two processing phases. The first processing phase is to encode 25 the fixed tag data stored in the 128-bit (2 x 64-bit) tag data register. The second is to encode tag data as it is required by the tag encoder. When the Tag Encoder is started up, the fixed tag data is already preloaded in the 128 bit tag data record. if encodeFixed is set, then the 2 codewords stored in the lower bits of the tag data record need to be encoded: 40 bits if dataRedun = 0, and 56 bits if dataRedun = 1. If encodeFixed 30 is clear, then the lower 120 bits of the tag data record must be passed to the encoded tag data interface without being encoded. When encodeFixed is set, the symbols derived from codeword 0 are written to codeword 6 and the symbols derived from codeword 1 are written to codeword 7. The data symbols are stored first and then the remaining redundancy symbols are stored afterwards, for a total of 15 symbols. 35 Thus, when dataRedun = 0, the 5 symbols derived from bits 0-19 are written to symbols 0-4, and the redundancy symbols are written to symbols 5-14. When dataRedun = 1, the 7 symbols derived from bits 0-27 are written to symbols 0-6, and the redundancy symbols are written to symbols 7-14. When encodeFixed is clear, the 120 bits of fixed data is copied directly to codewords 6 and 7. 40 The TDI State Flow diagram is shown in Figure 202. An explanation of the states follows.
WO 2004/050369 PCT/AU2003/001616 466 idle:- In the idle state wait for the tag encoder go signal - topgo = 1. The first task is to either store or encode the Fixed data. Once the Fixed data is stored or encoded/stored the donefixed flag is set. If there is no variable data the FSM returns to the idle state hence the reason to check the donefixed flag before advancing i.e. only store/encode the fixed data once. 5 fixeddata:- In the fixeddata state the FSM must decode whether to directly store the fixed data in the ETDi or if the fixed data needs to be either (15:5) (40-bits) or (15:7) (56-bits) RS encoded or 2D decoded. The values stored in registers encodefixed and dataredun and decode2den determine what the next state should be. bypasstoetdi:- The bypasstoetdi takes 120-bits of fixed data(pre-encoded) from the 10 tag data(127:0) register and stores it in the 15*8 (by 2 for simultaneous reads) buffers. The data is passed from the tag data register through 3 levels of muxing levell, level2, level3) where it enters the RSO/RS1 encoders (which are now in a straight through mode (i.e. contro/_5 and control_7 are zero hence the data passes straight from the input to the output). The MSBs of the etdwradr must be high to store this data as codewords 6,7. 15 etd_bufswitch:- This state is used to set the tdvalid signal and pulse the etdadv tag signal which in turn is used to switch the read write sense of the ETDi buffers (wrsb0). The firsttime signal is used to identify the first time a tag is encoded. If zero it means read the tag data from the RTDi FIFO and encode. Once encoded and stored the FSM returns to this state where it evaluates the sense of tdvalid. First time around it will be zero so this sets tdvalid and returns to 20 the readtagdata state to fill the 2nd ETDi buffer. After this the FSM returns to this state and waits for the lastdotintag signal to arrive. In between tags when the lastdotingtag signal is received the etdadv tag is pulsed and the FSM goes to the readtagdata state. However if the lastdotintag signal arrives at the end of a line there is an extra I cycle delay introduced in generating the etdadv tag pulse (via etdadv tag endofline) due to the pipelining in the TFS. This allows all the 25 previous tag to be read from the correct buffer and seamless transfer to the other buffer for the next line. readtagdata:- The readtagdata state waits to receive a rtdavail signal from the raw tag data interface which indicates there is raw tag data available. The tag data register is 128-bits so it takes 2 pulses of the rtdrd signal to get the 2*64-bits into the tag data register. If the rtdavail 30 signal is set rtdrd is pulsed for 1 cycle and the FSM steps onto the loadtagdata state. Initially the flag first64bits will be zero. The 64-bits of rtd are assigned to the tag data[63:0] and the flag first64bits is set to indicate the first raw tag data read is complete. The FSM then steps back to the read tagdata state where it generates the second rtdrd pulse. The FSM then steps onto the loadtagdata state for where the second 64-bits of rawtag data are assigned to tag data[128:64]. 35 loadtagdata:- The loadtagdata state writes the raw tag data into the tag data register from the RTDi FIFO. The first64bits flag is reset to zero as the tag data register now contains 120/112 bits of variable data. A decode of whether to (15:5) or (15:7) RS encode or 2D decode this data decides the next state. rs_15_5:- The rs_15 5 (Reed Solomon (15:5) mode) state either encodes 40-bit Fixed data or 40 120-bit Variable data and provides the encoded tag data write address and write enable WO 2004/050369 PCT/AU2003/001616 467 (etd-wradr and etdwe respectively). Once the fixed tag data is encoded the donefixed flag is set as this only needs to be done once per page. The variabledatapresent register is then polled to see if there is variable data in the tags. If there is variable data present then this data must be read from the RTDi and loaded into the tag data register. Else the tdvalid flag must be set and 5 FSM returns to the idle state. control_5 is a control bit for the RS Encoder and controls feedforward and feedback muxes that enable (15:5) encoding. The rs_15_5 state also generates the control signals for passing 120-bits of variable tag data to the RS encoder in 4-bit symbols per clock cycle. rs counter is used both to control the level mux and act as the 15-cycle counter of the RS Encoder. This logic cycles for a total of 3*15 cycles to 10 encode the 120-bits. rs_15 7:- The rs_15_7 state is similar to the rs_15_5 state except the levellmux has to select 7 4-bit symbols instead of 5. decode_2d_155, decode_2d_15_7:- The decode_2d states provides the control signals for passing the 120-bit variable data to the 2D decoder. The 2 Isbs are decoded to create 4 bits. The 15 4 bits from each decoder are combined and stored in the ETDi. Next the 2 MSBs are decoded to create 4 bits. Again the 4 bits from each decoder are combined and stored in the ETDi. As can be seen from Figure n page488 on page Error! Bookmark not defined. there are 3 stages of muxing between the Tag Data register and the RS encoders or 2D decoders. Levels 1-2 are controlled by leve/l1mux and leve/2_mux which are generated within the TDi FSM as is the 20 write address to the ETDi buffers (etd wr adr) Figures 203 through 208 illustrate the mappings used to store the encoded fixed and variable tag data in the ETDI buffers. 26.7.6 Reed Solomon (RS) Encoder 26.7.7 Introduction 25 A Reed Solomon code is a non binary, block code. If a symbol consists of m bits then there are q = 2m possible symbols defining the code alphabet. In the TE, m = 4 so the number of possible symbols is q = 16. An (n,k) RS code is a block code with k information symbols and n code-word symbols. RS codes have the property that the code word n is limited to at most q+1 symbols in length. 30 In the case of the TE, both (15,5) and (15,7) RS codes can be used. This means that up to 5 and 4 symbols respectively can be corrected. Only one type of RS coder is used at any particular time. The RS coder to be used is determined by the registers TE dataredun and TE decode2den: * TEdataredun = 0 and TEdecode2den = 0, then use the (15,5) RS coder 35 * TEdataredun = 1 and TEdecode2den = 0, then use the (15,7) RS coder For a (15,k) RS code with m = 4, k 4-bit information symbols applied to the coder produce 15 4-bit codeword symbols at the output. In the TE, the code is systematic so the first k codeword symbols are the same the as the k input information symbols. A simple block diagram can be seen in. 40 26.7.8 110 Specification WO 2004/050369 PCT/AU2003/001616 468 A I/O diagram of the RS encoder can be seen in. 26.7.9 Proposed implementation In the case of the TE, (15,5) and (15,7) codes are to be used with 4-bits per symbol. The primitive polynomial is p(x) = x 4 + x + 1 5 In the case of the (15,5) code, this gives a generator polynomial of g(x) = (x+a)(x+a 2 )(x+as)(x+a 4 )(x+a)(x+a6)(x+a7)(x+a )(x+a9)(x+al0) g(x) = xa + a+2a + a~x + aYx+ aYx+ a'x+ a 2X 4 + ax 3 + ax2 + ax + a10 g(x) = x 0 + g 9 x 9 + g 8 x 8 + g 7 x 7 + gx 6 + g 5 x 5 + g 4 x 4 + g 3 x 3 + g 2 x 2 + gjx 10 +9g In the case of the (15,7) code, this gives a generator polynomial of h(x) = (x+a)(x+a 2 )(x+a 3 )(x+a 4 )(x+a)(x+a 6 )(x+a)(xa") h(x) = x' + a 4 x'+ a 2 xe + a 4 x 5 + a 2 x 4 + a 1 3 Xs + a'x 2 + ax + a 6 h(x) = x8 + h 7 x 7 + h 6 x 6 + h 5 x 5 + h 4 x 4 + hax 3 + h 2 x 2 + h 1 x + ho 15 The output code words are produced by dividing the generator polynomial into a polynomial made up from the input symbols. This division is accomplished using the circuit shown in Figure 211. The data in the circuit are Galois Field elements so addition and multiplication are performed using special circuitry. These are explained in the next sections. 20 The RS coder can operate either in (15,5) or (15,7) mode. The selection is made by the registers TE dataredun and TE decode2den. When operating in (15,5) mode control_7 is always zero and when operating in (15,7) mode control 5 is always zero. Firstly consider (15,5) mode i.e. TEdataredun is set to zero. 25 For each new set of 5 input symbols, processing is as follows: The 4-bits of the first symbol do are fed to the input port rsdatain(3:0) and control_5 is set to 0. mux2 is set so as to use the output as feedback. control_5 is zero so mux4 selects the input (rsdata in) as the output (rs data out). Once the data has settled (<< I cycle), the shift registers are clocked. The next symbol d, is then applied to the input, and again after the data has settled 30 the shift registers are clocked again. This is repeated for the next 3 symbols d 2 , d 3 and d 4 . As a result, the first 5 outputs are the same as the inputs. After 5 cycles, the shift registers now contain the next 10 required outputs. control 5 is set to 1 for the next 10 cycles so that zeros are fed back by mux2 and the shift register values are fed to the output by mux3 and mux4 by simply clocking the registers. 35 A timing diagram is shown below. Secondly consider (15,7) mode i.e. TEdataredun is set to one. In this case processing is similar to above except that control_7 stays low while 7 symbols (do, d ... d 6 ) are fed in. As well as being fed back into the circuit, these symbols are fed to the output. After these 7 cycles, control 7 is set to 1 and the contents of the shift registers are fed to the 40 output.
WO 2004/050369 PCT/AU2003/001616 469 A timing diagram is shown below. The enable signal can be used to start/reset the counter and the shift registers. The RS encoders can be designed so that encoding starts on a rising enable edge. After 15 symbols have been output, the encoder stops until a rising enable edge is detected. As a result 5 there will be a delay between each codeword. Alternatively, once the enable goes high the shift registers are reset and encoding will proceed until it is told to stop. rsdatain must be supplied at the correct time. Using this method, data can be continuously output at a rate of I symbol per cycle, even over a few codewords. Alternatively, the RS encoder can request data as it requires. 10 The performance criterion that must be met is that the following must be carried out within 63 cycles e load one tag's raw data into TE tagdata * encode the raw tag data e store the encoded tag data in the Encoded Tag Data Interface 15 In the case of the raw fixed tag data at the start of a page, there is no definite performance criterion except that it should be encoded and stored as fast as possible. 26.7.10 Galois Field elements and their representation A Galois Field is a set of elements in which we can do addition, subtraction, multiplication and division without leaving the set. 20 The TE uses RS encoding over the Galois Field GF(2 4 ). There are 24 elements in GF(2 4 ) and they are generated using the primitive polynomial p(x) = x 4 + x + 1. The 16 elements of GF(2 4 ) can be represented in a number of different ways. Table 179 shows three possible representations - the power, polynomial and 4-tuple representation. Table 179. GF(2 4 ) representations 25 power Polynomial 4-tuple representation Representation representation (aC al a2 a3) 0 0 (0000) 1 1 (1000) A x (0100) a2 rnrnrnnrnnrnnX 2 (0 0 1 0) as
X
3 (0001) a 4 1 + x (1 100) aC x + x 2 (01 10) ab x 2 + x 3 (00 1 1) C7 1 + x 0000000 + x 3 (1 1 01) a 1 + x 2 (1 0 1 0) (01 01) WO 2004/050369 PCT/AU2003/001616 470 x0000000-0 xI C1+x+x 2 (1110) a. x+x+x (0111) a 1 2 +x~x 2 +x 3 (1 1 1 1) a 13 1 +x+ x3 (1011) a 14 1 +x 3 (1001) 26.7.11 Multiplication of GF(2 4 ) elements The multiplication of two field elements a' and ab is defined as - a ,b = ,(a+b)modulo 15 Thus 5 a2 3 s 25. = 10 15 6 12 3 So if we have the elements in exponential form, multiplication is simply a matter of modulo 15 addition. 10 If the elements are in polynomial/tuple form, the polynomials must be multiplied and reduced mod x' + x + 1. Suppose we wish to multiply the two field elements in GF(2 4 ): aa = a 3 x 3 + a 2 x 2 + a 1 xI + ao a = b 3 x 3 + b 2 x2 + b 1 x' + bo 15 where ai, bi are in the field (0,1) (i.e. modulo 2 arithmetic) Multiplying these out and using x 4 + x + 1 = 0 we get: aa+b = [(aob 3 + a 1 b 2 + a 2 b 1 + a 3 bo) + a 3 b 3 ]x 3 + [(aob 2 + a 1 b 1 + a 2 bo) + a 3 b 3 + (a 3 b 2 + a2ba)]X2 + [(aob 1 + abo) + (a 3 b 2 + a 2 bs) + (a 1 b 3 + a 2 b 2 + a 3 b 1 )]x 20 + [(aobo + a 1 b 3 + a 2 b 2 + a 3 b 1 )] a.a+b = [aob 3 + a 1 b 2 + a 2 b 1 + a 3 (bo + b3 + [aob 2 + a 1 b 1 + a 2 (bO + b 3 ) + a 3 (b 2 + b 3 ) ]x 2 + [aob 1 + a 1 (bo + b 3 ) + a 2 (b 2 + b 3 ) + a 3 (b 1 + b 2 ) lx + [aobO + a 1 b 3 + a 2 b 2 + a 3 b 1 ] 25 If we wish to multiply an arbitrary field element by a fixed field element we get a more simple form. Suppose we wish to multiply ab by a 3 . In this case a3 = x 3 so (aO al a2 a3) = (0 0 0 1). Substituting this into the above equation gives a' = (bo + bs*3 + (b2 + bs)x2 + (b1 + b2)x + b1 30 This can be implemented using simple XOR gates as shown in Figure 214 26.7.12 Addition of GF(2 4 ) elements If the elements are in their polynomial/tuple form, polynomials are simply added. Suppose we wish to add the two field elements in GF(2 4
):
WO 2004/050369 PCT/AU2003/001616 471 (a = a 3 x 3 + a 2 x 2 + a 1 x + ao cb = b 3 X + b 2 x2 + b 1 x + be where ai, bi are in the field (0,1) (i.e. modulo 2 arithmetic) a = aa + ab = (a 3 + ba)x 3 + (a 2 + b 2 )x 2 + (a 1 + b 1 )x + (ao + bo) 5 Again this can be implemented using simple XOR gates as shown in Figure 215 26.7.13 Reed Solomon Implementation The designer can decide to create the relevant addition and multiplication circuits and instantiate them where necessary. Alternatively the feedback multiplications can be combined as follows. Consider the multiplication 10 (Xa.Cb =C or in terms of polynomials (a 3 x 3 + a 2 x 2 + a 1 x + ao).(bax 3 + b 2 x 2 + b 1 x + bo) = (c 3 x 3 + c 2 x 2 + c 1 x + co) If we substitute all of the possible field elements in for aa and express ( in terms of ab, we get the 15 table of results shown in Table 180. Table 180. a' multiplied by all field elements, expressed in terms of ab aa a3x3 + a2x2 + a1x + aO c3x3 + c2x2 + clx + cO ixed aO al a2 a3) cO c1 c2 c3 ield, element' 0 (0000) 1 (1 000) bo b 1 b 2 b3 a (0 1 00) b 3 bo+b 3 b 1 b 2 2 0010) b 2 b 2 +b 3 bo+ba b1 as (000 1) b 1 b 1 +b 2 b 2 +b 3 bO+b3 a 4 (1 1 0 0) bO+b 3 bo+b 1 +b 3 b 1 +b 2 b 2 +b 3 a5 (0 11 0) b 2 +b 3 bO+b 2 bo+b 1 +b 3 b1+b2 a (0 0 1 1) b 1 +b 2 b 1 +b 3 bO+b 2 bo+b1+bs cc 7 (1 1 0 1) bo+b 1 +b 3 bo+b 2 +b 3 b 1 +b 3 bO+b2 a (1 0 1 0) bo+b 2 b 1 +b 2 +b 3 bo+b 2 +b 3 b 1 +b 3 U9 (0 1 0 1) b 1 +b 3 bo+b 1 +b 2 +b 3 b 1 +b 2 +b 3 bo+b 2 +b 3 a10 (1 1 1 0) bo+b 2 +b 3 bo+b 1 +b 2 bo+b 1 +b 2 +b 3 b 1 +b 2 +b 3 all (01 11) b 1 +b 2 +b 3 bo +b 1 bo+b,+b 2 bo+b1+b2 +b3 a 12 (1 1 1 1) bo+b 1 +b 2 +b 3 bo bO+b 1 bo+b1+b2 Oc (1 0 1 1) bo+b 1 +b 2 b 3 bo bo+b1 c 14 (1 001) bO+b 1 b 2 b 3 bo WO 2004/050369 PCT/AU2003/001616 472 the following signals are required: * bo, b 1 , b 2 , b 3 , * ( bo+b 1 ), (bo+b 2 ), (bo+b 3 ), (b 1 +b 2 ), (b 1 +b 3 ), (b 2 +b 3 ), e (b 0 +b 1 +b 2 ), (bo+b 1 +b 3 ), (bo+b 2 +b 3 ), (b 1 +b 2 +b 3 ), 5'- (bo+b 1 +b 2 +b 3 ) The implementation of the circuit can be seen in Figure . The main components are XOR gates, 4-bit shift registers and multiplexers. The RS encoder has 4 input lines labelled 0,1,2 & 3 and 4 output lines labelled 0,1,2 & 3. This labelling corresponds to the subscripts of the polynomial/4-tuple representation. The mapping of 10 4-bit symbols from the TE tagdata register into the RS is as follows: - the LSB in the TE tagdata is fed into line - the next most significant LSB is fed into line - the next most significant LSB is fed into line2 - the MSB is fed into line3 15 The RS output mapping to the Encoded tag data interface is similiar. Two encoded symbols are stored in an 8-bit address. Within these 8 bits: - line is fed into the LSB (bit 0/4) - line is fed into the next most significant LSB (bit 1/5) - line2 is fed into the next most significant LSB (bit 2/6) 20 - line3 is fed into the MSB (bit 3/7) 267.14 2D Decoder The 2D decoder is selected when TEdecode2den = 1. It operates on variable tag data only. its function is to convert 2-bits into 4-bits according to Table 181.. 25 Table 181. Operation of 2D decoder input output 00 0001 01 0010 10 0100 11 1000 26.7.15 Encoded tag data interface The encoded tag data interface contains an encoded fixed tag data store interface and an encoded variable tag data store interface, as shown in Figure 217. 30 The two reord units simply reorder the 9 input bits to map low-order codewords into the bit selection component of the address as shown in Table 182. Reordering of write addresses is not necessary since the addresses are already in the correct format. Table 182. Reord unit WO 2004/050369 PCT/AU2003/001616 473 bit# input output bit interpretation bit interpretation 8 A select 1 of 8 codewords A select 1 of 4 codeword tables 7 B B 6 C D select 1 of 15 symbols 5 D select I of 15 symbols E 4 E F 3 F G 2 G C select 1 of 8 bits 1 H select 1 of 4 bits H 0 i The encoded fixed data interface is a single 15 x 8-bit RAM with 2 read ports and 1 write port. As it is only written to during page setup time (it is fixed for the duration of a page) there is no need for simultaneous read/write access. However the fixed data store must be capable of decoding 5 two simultaneous reads in a single cycle.Figure 218 shows the implementation of the fixed data store. The encoded variable tag data interface is a double buffered 3 x 15 x 8-bit RAM with 2 read ports and 1 write port. The double buffering allows one tag's data to be read (two reads in a single cycle) while the next tag's variable data is being stored. Write addressing is 6 bits: 2 bits of 10 address for selecting 1 of 3, and 4 bits of address for selecting 1 of 15. Read addressing is the same with the addition of 3 more address bits for selecting 1 of 8. Figure 219 shows the implementation of the encoded variable tag data store. Double buffering is implemented via two sub-buffers. Each time an AdvTag pulse is received, the sense of which sub buffer is being read from or written to changes. This is accomplished by a 1-bit flag called wrsbO. 15 Although the initial state of wrsbO is irrelevant, it must invert upon receipt of an AdvTag pulse. The structure of each sub-buffer is shown in Figure 220. 26.8 TAG FORMAT STRUCTURE (TFS) INTERFACE 26.8.1 Introduction The TFS specifies the contents of every dot position within a tags border i.e.: 20 e is the dot part of the background? 0 is the dot part of the data? The TFS is broken up into Tag Line Structures (TLS) which specify the contents of every dot position in a particular line of a tag. Each TLS consists of three tables -A, B and C (see Figure 221). 25 For a given line of dots, all the tags on that line correspond to the same tag line structure. Consequently, for a given line of output dots, a single tag line structure is required, and not the WO 2004/050369 PCT/AU2003/001616 474 entire TFS. Double buffering allows the next tag line structure to be fetched from the TFS in DRAM while the existing tag line structure is used to render the current tag line. The TFS interface is responsible for loading the appropriate line of the tag format structure as the tag encoder advances through the page. It is also responsible for producing table A and table B 5 outputs for two consecutive dot positions in the current tag line. e There is a TLS for every dot line of a tag. * All tags that are on the same line have the exact same TLS. * A tag can be up to 384 dots wide, so each of these 384 dots must be specified in the TLS. e The TLS information is stored in DRAM and one TLS must be read into the TFS Interface 10 for each line of dots that are outputted to the Tag Plane Line Buffers. * Each TLS is read from DRAM as 5 times 256-bit words with 214 padded bits in the last 256-bit DRAM read. 26.8.2 I/O Specification Table 183. Tag Format Structure Interface Port List 15 signal name signal type description Pclk In SoPEC system clock prstn In Active-low, synchronous reset in pclk domain top-go In Go signal from TE top level DRAM diu-data[63:0] In Data from DRAM diutfsrack In Data acknowledge from DRAM diutfsrvalid In Data valid from DRAM tfs-diu-rreq Out Read request to DRAM tfs-diu-radr[21:5] Out Read address to DRAM tag encoder top level topadvtagline In Pulsed after the last line of a row of tags toptagaltsense In For even tag rows = 0 i.e. 0,2,4.. For odd tag rows = 1 i.e. 1,3,5... toplastdotintag In Last dot in tag is currently being processed topdotposvalid In Current dot position is a tag dot and its structure data and tag data is available toptagdotnum[7:0] In Counts from zero up to TE tagmaxdotpairs (min. =1, max. = 192) tfsivalid Out TLS tables A, B and C, ready for use tfsi-ta-dot[1:0] Out Even entry from Table A corresponding to toptagdotnum tfsi-ta-dotl [1:0] Out Odd entry from Table A corresponding to toptagdotnum WO 2004/050369 PCT/AU2003/001616 475 tag encoder top level (PCU read decoder) tfs_te_tfsstartadr[23:0] Out TFS tfsstartadr register tfs_te_tfsendadr[23:0] Out TFS tfsendadr register tfstetfsfirstlineadr[23:0] Out TFS tfsfirstlineadr register tfs_tecurrtfsadr[23:0] Out TFS currtfsadr register TDI tfsi-tdi-adr[8:0] Out Read address for dotO (even dot) tfsi-tdi adr[8:0] Out Read address for dot1 (odd dot) 26.8.2.1 State machine The state machine is responsible for generating control signals for the various TFS table units, and to load the appropriate line from the TFS. The states are explained below. idle:- Wait for topgo to become active. Pulse adv_fsline for 1 cycle to reset tawradr and tbwradr 5 registers. Pulsing adv_tfs_line will switch the read/write sense of Table B so switching Table A here as well to keep things the same i.e. wrtaO = NOT(wrtaO). diuaccess:- In the diuaccess state a request is sent to the DIU. Once an ack signal is received Table A write enable is asserted and the FSM moves to the t/s load state. t/s_load:- The DRAM access is a burst of 5 256-bit accesses, ultimately returned by the DIU as 10 5*(4*64bit) words. There will be 192 padded bits in the last 256-bit DRAM word. The first 12 64 bit words reads are for Table A, words 12 to 15 and some of 16 are for Table B while part of read 16 data is for Table C. The counter readnum is used to identify which data goes to which table. The table B data is stored temporarily in a 288-bit register until the tls update state hence tbwe does not become active until readnum = 16). 15 * The DIU data goes directly into Table A (12 * 64). * The DIU data for Table B is loaded into a 288-bit register. * The DIU data goes directly into Table C. t/s update:- The 288-bits in Table B need to written to a 32*9 buffer. The Us_update state takes 20 care of this using the readnum counter. tisnext- This state checks the logic level of tfsvalid and switches the read/write senses of Table A (wrtaO) and Table B a cycle later (using the advifs line pulse). The reason for switching Table A a cycle early is to make sure the toplevel address via tagdotnum is pointing to the correct buffer. Keep in mind the top jevel is working a cycle ahead of Table A and 2 cycles ahead of 25 Table B. If tfsValid is 1, the state machine waits until the advTagLine signal is received. When it is received, the state machine pulses advTFSLine (to switch read/write sense in tables A, B, C), and starts reading the next line of the TFS from currTFSAdr. If ifsValid is 0, the state machine pulses advTFSLine (to switch read/write sense in tables A, B, C) 30 and then jumps to the tls_tfsvalidset state where the signal ifs Valid is set to I (allowing the tag WO 2004/050369 PCT/AU2003/001616 476 encoder to start, or to continue if it had been stalled). The state machine can then start reading the next line of the TFS from currTFSAdr. tis_tfsvalidnext:- Simply sets the ffsvalid signal and returns the FSM to the diuaccess state. If an advTagLine signal is received before the next line of the TFS has been read in, tfsValid is 5 cleared to 0 and processing continues as outlined above. 26.8.2.2 Bandstore wrapping Both TD and TFS storage in DRAM can wrap around the bandstore area. The bounds of the band store are described by inputs from the CDU shown in Table . The TD and TFS DRAM interfaces therefore support bandstore wrapping. If the TD or TFS DRAM interface increments an address it 10 is checked to see if it matches the end of bandstore address. If so, then the address is mapped to the start of the bandstore. The TFS state flow diagram is shown in below. 26.8.3 Generating a tag from Tables A, B and C The TFS contains an entry for each dot position within the tag's bounding box. Each entry 15 specifies whether the dot is part of the constant background pattern or part of the tag's data component (both fixed and variable). The TFS therefore has TagHeight x TagWidth entries, where TagHeight is the height of the tag in dot-lines and TagWidth is the width of the tag in dots. The TFS entries that specify a single dot line of a tag are known as a Tag Line Structure. 20 The TFS contains a TLS for each of the 1600 dpi lines in the tag's bounding box. Each TLS contains three contiguous tables, known as tables A, B and C. Table A contains 384 2-bit entries i.e. one entry for each dot in a single line of a tag up to the maximum width of a tag. The actual number of entries used should match the size of the bounding box for the tag in the dot dimension, but all 384 entries must be present. 25 Table B contains 32 9-bit data address that refer to (in order of appearance) the data dots present in the particular line. Again, all 32 entries must be present, even if fewer are used. Table C contains two 5-bit pointers into table B and is followed by 22 unused bits. The total length of each TLS is therefore 34 32-bit words. Each output dot value is generated as follows: Each entry in Table A consists of 2-bits - bitO and 30 bitl. These 2-bits are interpreted according to Table 184, Table 185 and Table 186. Table 184. Interpretation of bitO from entry in Table A bitO interpretation 0 the output bit comes directly from bit1 (see Table ). 1 the output bit comes from a data bit. Biti is used in conjunction with Tag Line Structure Table B to determine which data bit will be output. Table 185. Interpretation of bit1 from entry in table A when bitO = 0 bit I Interpretation WO 2004/050369 PCT/AU2003/001616 477 0 ]output 0 1 output 1 Table 186. Interpretation of bit1 from entry in table A when bitO = I bit 1 interpretation 0 output data bit pointed to by current index into Table B. I output data bit pointed to by current index into Table B, and advance index by 1. If bitO = 0 then the output dot for this entry is part of the constant background pattern. The dot 5 value itself comes from bit1 i.e. if bit1 = 0 then the output is 0 and if bit1 = 1 then the output is 1. If bitO = 1 then the output dot for this entry comes from the variable or fixed tag data. Bit1 is used in conjunction with Tables B and C to determine data bits to use. To understand the interpretation of bit1 when bitO = 1 we need to know what is stored in Table B. Table B contains the addresses of all the data bits that are used in the particular line of a tag in 10 order of appearance. Therefore, up to 32 different data bits can appear in a line of a tag. The address of the first data dot in a tag will be given by the address stored in entry 0 of Table B. As we advance along the various data dots we will advance through the various Table B entries. Each Table B entry is 9-bits long and each points to a specific variable or fixed data bit for the tag. Each tag contains a maximum of 120 fixed and 360 variable data bits, for a total of 480 data bits. 15 To aid address decoding, the addresses are based on the RS encoded tag data. Table lists the interpretation of the 9-bit addresses. Table 187. Interpretation of 9-bit tag data address in Table B bit pos name description 8 CodeWordSelect Select I of 8 codewords. Codewords 0, 1, 2, 3, 4, 5 are variable data. Codewords 6, 7 are fixed data. 6 5 SymbolSelect Select 1 of 15 symbols (1111 invalid) 4 3 2 1 BitSelect Select 1 of 4 bits from the selected symbols 0 If the fixed data is supplied to the TE in an unencoded form, the symbols derived from codeword 0 20 of fixed data are written to codeword 6 and the symbols derived from fixed data codeword 1 are written to codeword 7. The data symbols are stored first and then the remaining redundancy WO 2004/050369 PCT/AU2003/001616 478 symbols are stored afterwards, for a total of 15 symbols. Thus, when 5 data symbols are used, the 5 symbols derived from bits 0-19 are written to symbols 0-4, and the redundancy symbols are written to symbols 5-14. When 7 data symbols are used, the 7 symbols derived from bits 0-27 are written to symbols 0-6, and the redundancy symbols are written to symbols 7-14 5 However, if the fixed data is supplied to the TE in a pre-encoded form, the encoding could theoretically be anything. Consequently the 120 bits of fixed data is copied to codewords 6 and 7 as shown in Table 188. Table 188. Mapping of fixed data to codeword/symbols when no redundancy encoding input bits output symbol output range codeword 0-19 0-4 6 20-39 0-4 7 40-59 5-9 6 60-79 5-9 7 80-99 10-14 6 100-119 10-14 7 10 It is important to note that the interpretation of bit1 from Table A (when bitO = 1) is relative. A 5-bit index is used to cycle through the data address in Table B. Since the first tag on a particular line may or may not start at the first dot in the tag, an initial value for the index into Table B is needed. Subsequent tags on the same line will always start with an index of 0, and any partial tag at the end of a line will simply finish before the entire tag has been rendered. The initial index required 15 due to the rendering of a partial tag at the start of a line is supplied by Table C. The initial index will be different for each TLS and there are two possible initial indexes since there are effectively two types of rows of tags in terms of initial offsets. Table C provides the appropriate start index into Table B (2 5-bit indices). When rendering even rows of tags, entry 0 is used as the initial index into Table B, and when rendering odd rows of 20 tags, entry 1 is used as the initial index into Table B. The second and subsequent tags start at the left most dots position within the tag, so can use an initial index of 0. 26.8.4 Architecture A block diagram of the Tag Format Structure Interface can be seen in Figure 223. 26.8.4.1 Table A interface 25 The implementation of table A is two 16 x 64-bit RAMs with a small amount of control logic, as shown in Figure 224. While one RAM is read from for the current line's table A data (4 bits representing 2 contiguous table A entries), the other RAM is being written to with the next line's table A data (64-bits at a time). Note:- The Table A data to be printed (if each LSB = 0) must be passed to the toplevel 2 cycles 30 after the read of Table A due to the 2-stage pipelining in the TFS from registering Table A and Table B outputs hence this extra registering stage for the generation of ta_dotO_1 cyclelater and tadotl_1cyclelater.
WO 2004/050369 PCT/AU2003/001616 479 Each time an AdvTFSLine pulse is received, the sense of which RAM is being read from or written to changes. This is accomplished by a 1-bit flag called wrtaO. Although the initial state of wrtaO is irrelevant, it must invert upon receipt of an AdvTFSLine pulse. A 4-bit counter called taWrAdr keeps the write address for the 12 writes that occur after the start of each line (specified by the 5 AdvTFSLine control input). The tawe (table A write enable) input is set whenever the data in is to be written to table A. The taWrAdr address counter automatically increments with each write to table A. Address generation for tawe and taWrAdr is shown in Table 189. 26.8.4.2 Table C interface A block diagram of the table C interface is shown below in Figure 226. 10 The address generator for table C contains a 5 bit address register adr that is set to a new address at the start of processing the tag (either of the two table C initial values based on tagAltSense at the start of the line, and 0 for subsequent tags on the same line). Each cycle two addresses into table B are generated based on the two 2-bit inputs (InO and in1). As shown in Section 189, the output address tbRdAdrO is always adr and tbRdAdrl is one of adr and adr+1, 15 and at the end of the cycle adr takes on one of adr, adr+1, and adr+2. Table 189. AdrGen lookup table inputs outputs inO inl adrOSel adrISe adrSel 00 00 X8 X adr 00 01 X adr adr 00 10 Xadr 00 11 adr adr+1 01 00 adr X adr 01 01 adr adr adr 01 10 adr X adr 01 11 adr adr adr+1 10 00 X adr 10 01 X adr adr 10 10 X X adr 10 11 X adr adr+1 11 00 adr X adr+1 11 01 adr adr+1 adr+1 11 10 adr X adr+1 11 11 adr adr+1 adr+2 26.8.4.3 Table B interface 18 X = don't care state.
WO 2004/050369 PCT/AU2003/001616 480 The table B interface implementation generates two encoded tag data addresses (tfsiadrO, tfsi_adrl) based on two table B input addresses (tbRdAdrO, tbRdAdrl). A block diagram of table B can be seen in Figure 227. Table B data is initially loaded into the 288-bit table B temporary register via the TFS FSM. Once 5 all 288-bit entries have been loaded from DRAM, the data is written in 9-bit chunks to the 32*9 register arrays based on tbwradr. Each time an AdvTFSLine pulse is received, the sense of which sub buffer is being read from or written to changes. This is accomplished by a 1-bit flag called wrtbO. Although the initial state of wrtbO is irrelevant, it must invert upon receipt of an AdvTFSLine pulse. 10 Note:- The output addresses from Table B are registered. 27 Tag FIFO Unit (TFU) 27.1 OVERVIEW The Tag FIFO Unit (TFU) provides the means by which data is transferred between the Tag Encoder (TE) and the HCU. By abstracting the buffering mechanism and controls from both units, 15 the interface is clean between the data user and the data generator. The TFU is a simple FIFO interface to the HCU. The Tag Encoder will provide support for arbitrary Y integer scaling up to 1600 dpi. X integer scaling of the tag dot data is performed at the output of the FIFO in the TFU. There is feedback to the TE from the TFU to allow stalling of the TE during a line. The TE interfaces to the TFU with a data width of 8 bits. The TFU interfaces to the HCU with 20 a data width of 1 bit. The depth of the TFU FIFO is chosen as 16 bytes so that the FIFO can store a single 126 dot tag. 27.1.1 Interfaces between TE, TFU and HCU 27.1.1.1 TE-TFU Interface The interface from the TE to the TFU comprises the following signals: 25 e teffuwdata, 8-bit write data. * tetfuwdatavalid, write data valid. * te_tfu_wradvine, accompanies the last valid 8-bit write data in a line. The interface from the TFU to TE comprises the following signal: * ffute oktowrite, indicating to the TE that there is space available in the TFU FIFO. 30 The TE writes data to the TFU FIFO as long as the TFU's tfuteoktowrite output bit is set. The TE write will not occur unless data is accompanied by a data valid signal. 27.1.1.2 TFU-HCU Interface The interface from the TFU to the HCU comprises the following signals: * tfuhcutdata, 1-bit data. 35 * tfu_hcu_avail, data valid signal indicating that there is data available in the TFU FIFO. The interface from HCU to TFU comprises the following signal: * hcu fu_ ready, indicating to the TFU to supply the next dot. 27.1.1.2.1 X scaling Tag data is replicated a scale factor (SF) number of times in the X direction to convert the final 40 output to 1600 dpi. Unlike both the CFU and SFU, which support non-integer scaling, the scaling WO 2004/050369 PCT/AU2003/001616 481 is integer only. Replication in the X direction is performed at the output of the TFU FIFO on a dot by-dot basis. To account for the case where there may be two SoPEC devices, each generating its own portion of a dot-line, the first dot in a line may not be replicated the total scale-factor number of times by 5 an individual TFU. The dot will ultimately be scaled-up correctly with both devices doing part of the scaling, one on its lead-out and the other on its lead in. Note two SoPEC TEs may be involved in producing the same byte of output tag data straddling the printhead boundary. The HCU of the left SoPEC will accept from its TE the correct amount of dots, ignoring any dots in the last byte that do not apply to its printhead. The TE of the right 10 SoPEC will be programmed the correct number of dots into the tag and its output will be byte aligned with the left edge of the printhead. 27.2 DEFINITIONS OF I/O Table 190. TFU Port List Port Name Pins 11/0 Description Clocks and Resets Pclk 1 In SoPEC Functional clock. Prstn 1 In Global reset signal. PCU Interface data and control signals Pcu adr[4:2 2 In PCU address bus. Only 3 bits are required to decode the address space for this block. Pcudataout[31:0] 32 In Shared write data bus from the PCU. Tfu_pcu datain[31:0] 32 Out Read data bus from the TFU to the PCU. Pcu_rwn 1 In Common read/not-write signal from the PCU. Pcu_tfusel 1 In Block select from the PCU. When cu_tfu_sel is high both pcu adr and cu dataout are valid. Tfu_pcurdy 1 Out Ready signal to the PCU. When tfupcu_rdy is high it indicates the last cycle of the access. For a write cycle this means pcu dataout has been registered by the block and for a read cycle this means the data on ffu_pcudatain is valid. TE Interface data and control WO 2004/050369 PCT/AU2003/001616 482 signals Te-tfuwdata[7:0] 8 In Write data for TFU FIFO. Te_tfuwdatavalid 1 In Write data valid signal. Te_tfuwradvline 1 In Advance line signal strobed when the last byte in a line is placed on tetfu wdata fu__teoktowrite 1 Out Ready signal indicating TFU has space available in it's FIFO and is ready to be written to. HCU Interface data and control signals Hcutfuadvdot 1 In Signal indicating to the TFU that the HCU is ready to accept the next dot of data from TFU. tfu_hcutdata 1 Out Data from the TFU FIFO. tfu_hcu_avail I Out Signal indicating valid data available From TFU FIFO. 27.3 CONFIGURATION REGISTERS Table 191. TFU Configuration Registers Address register name #bits value description TFUBase + on reset Control registers Ox00 Reset 1 1 A write to this register causes a reset of the TFU. This register can be read to indicate the reset state: 0 - reset in progress 1 - reset not in progress. Ox04 Go 1 see Writing 1 to this register starts the TFU. text Writing 0 to this register halts the TFU. When Go is deasserted the state machines go to their idle states but all counters and configuration registers keep their values. When Go is asserted all counters are reset, but configuration registers keep their values (i.e. they don't get reset).
WO 2004/050369 PCT/AU2003/001616 483 The TFU must be started before the TE is started. This register can be read to determine if the TFU is running (1 = running, 0 = stopped). Setup registers (constant during processing of page) 0x08 XScale 8 1 Tag scale factor in X direction. Ox0C XFracScale 8 1 Tag scale factor in X direction for the first dot in a line (must be programmed to be less than or equal to XSca/e ) 0x10 TEByteCount 12 0 The number of bytes to be accepted from the TE per line. Once this number of bytes have been received subsequent bytes are ignored until there is a strobe on the te tfu wradvine 0x14 HCUDotCount 16 0 The number of (optionally) x-scaled dots per line to be supplied to the HCU. Once this number has been reached the remainder of the current FIFO byte is ignored. 27.4 DETAILED DESCRIPTION The FIFO is a simple 16-byte store with read and write pointers, and a contents store, Figure 229. 16 bytes is sufficient to store a single 126 dot tag. Each line a total of TEByteCount bytes is read into the FIFO. All subsequent bytes are ignored 5 until there is a strobe on the tetfuwradv/ine signal, whereupon bytes for the next line are stored. On the HCU side, a total of HCUDotCount dots are produced at the output. Once this count is reached any more dots in the FIFO byte currently being processed are ignored. For the first dot in the next line the start of line scale factor, XFracScale, is used. The behaviour of these signals and the control signals between the TFU and the TE and HCU is 10 detailed below. // Concurrently Executed Code: // TE always allowed to write when there's either (a) room or (b) no room and all // bytes for that line have been received. 15 if ((FifoCntnts != FifoMax) OR (FifoCntnts == FifoMax and ByteToRx == 0)) then tfu te oktowrite = 1 else tfu te oktowrite = 0 20 WO 2004/050369 PCT/AU2003/001616 484 // Data presented to HCU when there is (a) data in FIFO and (b) the HCU has not // received all dots for a line ' if (FifoCntnts 1= 0) AND (BitToTx 1= 0)then 5 tfu hcu avail = I else tfu hcu avail = 0 // Output mux of FIFO data 10 tfu hcu tdata = Fifo[FifoRdPnt] [Rd~it] // Sequentially Executed Code: if (te tfu wdatavalid == 1) AND (FifoCntnts FifoMax) AND (ByteToRx 1= 0) then 15 Fifo[FifoWrPnt] = te tfu wdata FifoWrPnt ++ FifoContents ++ ByteToRx - 20 if (te tfu wradvline == 1) then ByteToRx = TEByteCount if (hcu tfu advdot == 1 and FifoCntnts 1= 0) then BitToTx ++ 25 if (RepFrac == 1) then RepFrac = Xscale if (RdBit = 7) then RdBit = 0 FifoRdPnt ++ 30 FifoContents else RdBit++ else RepFrac- 35 if(BitToTx == 1) then { RepFrac = XFracScale RdBit = 0 FifoRdPnt ++ FifoContents- 40 BitToTx = HCUDotCount WO 2004/050369 PCT/AU2003/001616 485 What is not detailed above is the fact that, since this is a circular buffer, both the fifo read and write-pointers wrap-around to zero after they reach two. Also not detailed is the fact that if there is a change of both the read and write-pointer in the same cycle, the fifo contents counter remains 5 unchanged. 28 alftoner Compositor Unit (HCU) 28.1 OVERVIEW The Halftoner Compositor Unit (HCU) produces dots for each nozzle in the destination printhead taking account of the page dimensions (including margins). The spot data and tag data are 10 received in bi-level form while the pixel contone data received from the CFU must be dithered to a bi-level representation. The resultant 6 bi-level planes for each dot position on the page are then remapped to 6 output planes and output dot at a time (6 bits) to the next stage in the printing pipeline, namely the dead nozzle compensator (DNC). 28.2 DATA FLOW 15 Figure 230 shows a simple dot data flow high level block diagram of the HCU. The HCU reads contone data from the CFU, bi-level spot data from the SFU, and bi-level tag data from the TFU. Dither matrices are read from the DRAM via the DIU. The calculated output dot (6 bits) is read by the DNC. The HCU is given the page dimensions (including margins), and is only started once for the page. 20 It does not need to be programmed in between bands or restarted for each band. The HCU will stall appropriately if its input buffers are starved. At the end of the page the HCU will continue to produce 0 for all dots as long as data is requested by the units further down the pipeline (this allows later units to conveniently flush pipelined data). The HCU performs a linear processing of dots calculating the 6-bit output of a dot in each cycle. 25 The mapping of 6 calculated bits to 6 output bits for each dot allows for such example mappings as compositing of the spotO layer over the appropriate contone layer (typically black), the merging of CMY into K (if K is present in the printhead), the splitting of K into CMY dots if there is no K in the printhead, and the generation of a fixative output bitstream. 28.3 DRAM STORAGE REQUIREMENTS 30 SoPEC allows for a number of different dither matrix configurations up to 256 bytes wide. The dither matrix is stored in DRAM. Using either a single or double-buffer scheme a line of the dither matrix must be read in by the HCU over a SoPEC line time. SoPEC must produce 13824 dots per line for A4/Letter printing which takes 13824 cycles. The following give the storage and bandwidths requirements for some of the possible 35 configurations of the dither matrix. * 4 Kbyte DRAM storage required for one 64x64 (preferred) byte dither matrix * 6.25 Kbyte DRAM storage required for one 80x80 byte dither matrix * 16 Kbyte DRAM storage required for four 64x64 byte dither matrices * 64 Kbyte DRAM storage required for one 256x256 byte dither matrix WO 2004/050369 PCT/AU2003/001616 486 It takes 4 or 8 read accesses to load a line of dither matrix into the dither matrix buffer, depending on whether we're using a single or double buffer (configured by DoubleLineBuff register). 28.4 IMPLEMENTATION A block diagram of the HCU is given in Figure 231. 5 28.4.1 Definition of 1/0 Table 192. HCU port list and description Port name Pins I/O Description Clocks and reset Pclk 1 In ISystem clock. prst_n 1 In System reset, synchronous active low. PCU interface pcuhcuse 1 In Block select from the PCU. When pcuhcuselis high both pcu adr and pcu dataout are valid. pcurwn 1 In Common read/not-write signal from the PCU. pcu-adr[7:2] 6 In PCU address bus. Only 6 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. hcupcu-rdy 1 Out Ready signal to the PCU. When hcu pcu rdy is high it indicates the last cycle of the access. For a write cycle this means pcudataout has been registered by the block and for a read cycle this means the data on hcupcu datain is valid. hcu._pcu-datain[31:0] 32 Out Read data bus to the PCU. DIU interface hcu-diu-rreq 1 Out HCU read request, active high. A read request must be accompanied by a valid read address. diu hcu rack 1 In Acknowledge from DIU, active high. Indicates that a read request has been accepted and the new read address can be placed on the address bus, hcudiuradr. hcu-diuradr[21:5] 17 Out HCU read address. 17 bits wide (256-bit aligned word). diu hcu rvalid 1 In Read data valid, active high. Indicates that valid read data is now on the read data bus, diu data. diudata[63:0] 64 In Read data from DIU. CFU interface cfuhcuavail 1 In Indicates valid data present on cfuhcuc[3-0]data lines. cfuhcu_cOdata[7:0] 8 In Pixel of data in contone plane 0. cfuhcu_cldata[7:0] 8 In Pixel of data in contone plane 1. cfuhcuc2data[7:0] 8 In Pixel of data in contone plane 2.
WO 2004/050369 PCT/AU2003/001616 487 cfuhcuc3data[7:0] 8 in Pixel of data in contone plane 3. hcu cfu advdot 1 Out Informs the CFU that the HCU has captured the pixel data on cfuhcu c[3-0]data lines and the CFU can now place the next pixel on the data lines. SFU interface sfu_hcu_avail 1 In Indicates valid data present on sfuhcusdata. sfuhcusdata 1 In Bi-level dot data. hcu_sfuadvdot 1 Out Informs the SFU that the HCU has captured the dot data on sfuhcusdata and the SFU can now place the next dot on the data line. TFU interface fu_hcuavail 1 In Indicates valid data present on tfuhcutdata. (fu_hcutdata 1 In Tag dot data. hcutfuadvdot 1 Out Informs the TFU that the HCU has captured the dot data on ffuhcutdata and the TFU can now place the next dot on the data line. DNC interface dnc-hcu ready I In Indicates that DNC is ready to accept data from the HCU. hcu dnc avail 1 Out Indicates valid data present on hcudnc data. hcu-dnc-data[5:0] 6 Out Output bi-level dot data in 6 ink planes. 28.4.2 Configuration Registers The configuration registers in the HCU are programmed via the PCU interface. Refer to section 21.8.2 on page 351 for the description of the protocol and timing diagrams for reading and writing registers in the HCU. Note that since addresses in SoPEC are byte aligned and the PCU 5 only supports 32-bit register reads and writes, the lower 2 bits of the PCU address bus are not required to decode the address space for the HCU. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of hcu pcu detain. The configuration registers of the HCU are listed in Table 193. Table 193. HCU Registers 10 Address Register Name #bits Value Description (HCUbase +) on Reset Control registers Ox00 Reset 1 OxI A write to this register causes a reset of the HCU. Ox04 Go 1 Ox0 Writing I to this register starts the HCU. Writing 0 WO 2004/050369 PCT/AU2003/001616 488 to this register halts the HCU. When Go is asserted all counters, flags etc. are cleared or given their initial value, but configuration registers keep their values. When Go is deasserted the state-machines go to their idle states but all counters and configuration registers keep their values. The HCU should be started after the CFU, SFU, TFU, and DNC. This register can be read to determine if the HCU is running (1 = running, 0 = stopped). Setup registers (constant for during processing) Ox10 AvailMask 4 OxO Mask used to determine which of the dotgen units etc. are to be checked before a dot is generated by the HCU within the specified margins for the specified color plane. If the specified dotgen unit is stalled, then the HCU will also stall. See Table for bit allocation and definition. Ox14 TMMask 4 OxO Same as Avai/Mask, but used in the top margin area before the appropriate target page is WO 2004/050369 PCT/AU2003/001616 489 reached. Ox18 PageMarginY 32 OxOOO The first line considered _ 0000 to be off the page. OxIC MaxDot 16 OxOOOO This is the maximum dot number - 1 present across a page. For example if a page contains 13824 dots, then MaxDot will be 13823. Ox20 TopMargin 32 OxOOO The first line on a page to 0000 be considered within the target page for contone and spot data. (0 = first printed line of page) 0x24 BottomMargin 32 0x0000 The first line in the target 0000 bottom margin for contone and spot data (i.e. first line after target page). Ox28 LeftMargin 16 OxOOO The first dot on a line within the target page for contone and spot data. Ox2C RightMargin 16 OxFFF The first dot on a line F within the target right margin for contone and spot data. Ox30 TagTopMargin 32 OxOOO The first line on a page to 0000 be considered within the target page for tag data. (0 = first printed line of page) 0x34 TagBottomMargin 32 OxOOO The first line in the target 0000 bottom margin for tag data (i.e. first line after target page). Ox38 TagLeftMargin 16 OxOOOO The first dot on a line within the target page for tag data. Ox3C TagRightMargin 16 OxFFF The first dot on a line WO 2004/050369 PCT/AU2003/001616 490 F within the target right margin for tag data. Ox44 StartDMAdr[21:5] 17 OxO_ Points to the first 256-bit 0000 word of the first line of the dither matrix in DRAM. Ox48 EndDMAdr[21:5] 17 OxO_ Points to the last address 0000 of the group of four 256 bit reads (or 8 if single buffering) that reads in the last line of the dither matrix. Ox4C LineIncrement 5 0x2 The number of 256-bit words in DRAM from the start of one line of the dither matrix and the start of the next line, i.e. the value by which the DRAM address is incremented at the start of a line so that it points to the start of the next line of the dither matrix. Ox50 DMInitindexCO 8 Ox00 If using the single-buffer scheme this register represents the initial index within 256-byte dither matrix line buffer for contone plane 0. If using double-buffer scheme, only the 7 Isbs are used. Ox54 DMLwrlndexCO 8 OxOO If using the single-buffer scheme this register represents the lower index within 256-byte dither matrix line buffer for contone plane 0. If using double-buffer scheme, only the 7 Isbs are used. Ox58 DMUprindexCO 8 Ox3F If using the single-buffer WO 2004/050369 PCT/AU2003/001616 491 scheme this register represents the upper index within 256-byte dither matrix line buffer for contone plane 0. After reading the data at this location the index wraps to DMLwrIndexCO. If using double-buffer scheme, only the 7 Isbs are used. Ox5C DMInitindexC1 8 OxOO If using the single-buffer scheme this register represents the initial index within 256-byte dither matrix line buffer for contone plane 1. If using double-buffer scheme, only the 7 Isbs are used. Ox60 DMLwrIndexC1 8 OxO If using the single-buffer scheme this register represents the lower index within 256-byte dither matrix line buffer for contone plane 1. If using double-buffer scheme, only the 7 Isbs are used. Ox64 DMUprlndexC1 8 Ox3F If using the single-buffer scheme this register represents the upper index within 256-byte dither matrix line buffer for contone plane 1. After reading the data at this location the index wraps to DMLwrIndexCl. If using double-buffer scheme, only the 7 Isbs are used. Ox68 DMinitIndexC2 8 Ox00 if using the single-buffer WO 2004/050369 PCT/AU2003/001616 492 scheme this register represents the initial index within 256-byte dither matrix line buffer for contone plane 2. If using double-buffer scheme, only the 7 Isbs are used. Ox6C DMLwrindexC2 8 OxO If using the single-buffer scheme this register represents the lower index within 256-byte dither matrix line buffer for contone plane 2. If using double-buffer scheme, only the 7 Isbs are used. Ox70 DMUprIndexC2 8 Ox3F If using the single-buffer scheme this register represents the upper index within 256-byte dither matrix line buffer for contone plane 2. After reading the data at this location the index wraps to DMLwrIndexC2. If using double-buffer scheme, only the 7 Isbs are used. Ox74 DMInitindexC3 8 OxO If using the single-buffer scheme this register represents the initial index within 256-byte dither matrix line buffer for contone plane 3. If using double-buffer scheme, only the 7 Isbs are used. Ox78 DMLwrlndexC3 8 OxOO If using the single-buffer scheme this register represents the lower index within 256-byte dither matrix line buffer for WO 2004/050369 PCT/AU2003/001616 493 contone plane 3. If using double-buffer scheme, only the 7 Isbs are used. Ox7C DMUprlndexC3 8 Ox3F If using the single-buffer scheme this register represents the upper index within 256-byte dither matrix line buffer for contone plane 3. After reading the data at this location the index wraps to DMLwrIndexC3. If using double-buffer scheme, only the 7 lsbs are used. Ox80 DoubleLineBuf 1 Ox1 Selects the dither line buffer mode to be single or double buffer. 0 - single line buffer mode 1 - double line buffer mode Ox84 to 0x98 IOMappingLo 6x32 OxOOO The dot reorg mapping for 0000 output inks 0 to 5. For each ink's 64-bit IOMapping value, IOMappingLo represents the low order 32 bits. Ox9C to OxBO IOMappingHi 6x32 OxOOO The dot reorg mapping for 0000 output inks 0 to 5. For each ink's 64-bit IOMapping value, IOMappingHi represents the high order 32 bits. OxB4 to OxCO cpConstant 4x8 OxOO The constant contone value to output for contone plane N when printing in the margin areas of the page. This value will typically be 0.
WO 2004/050369 PCT/AU2003/001616 494 OxC4 sConstant 1 Ox0 The constant bi-level value to output for spot when printing in the margin areas of the page. This value will typically be 0. OxC8 tConstant 1 Ox0 The constant bi-level value to output for tag data when printing in the margin areas of the page. This value will typically be 0. OxCC DitherConstant 8 OxFF The constant value to use for dither matrix when the dither matrix is not available, i.e. when the signal dmavail is 0. This value will typically be OxFF so that cpConstant can easily be Ox00 or OxFF without requiring a dither matrix (DitherConstant is primarily used for threshold dithering in the margin areas). Debug registers (read only) OxDO HcuPortsDebug 14 N/A Bit 13 = tfuhcuavail Bit 12 = hcu ffu advdot Bit 11 = sfu hcu avail Bit 10 = hcu sfu advdot Bit 9 = cfu hcu avai Bit 8 = hcu cfu advdot Bit 7 = dnchcuready Bit 6 = hcu dnc avail Bits 5-0 = hcu dnc data 0xD4 HcuDotgenDebug 15 N/A Bit 14 = after top margin Bit 13 = WO 2004/050369 PCT/AU2003/001616 495 intag target page Bit 12 = intargetpage Bit 11 = tp avail Bit 10 = s avail Bit 9 = cp_avail Bit 8 = dm-avai Bit 7 = advdot Bits 5-0 = [tp, s,cp3,cp2, cp 1,cpO] (i.e. 6 bit input to dot reorg units) OxD8 HcuDitherDebug1 17 N/A Bit 17 = advdot Bit 16 = dm avail Bit 15-8 = cp1dither_val Bits 7-0 = cp0_dither val OxDC HcuDitherDebug2 17 N/A Bit 17 = advdot Bit 16 = dm avai/ Bit 15-8 = cp3-dither-val Bits 7-0 = cp2_dither_vail 28.4.3 Control unit The control unit is responsible for controlling the overall flow of the HCU. It is responsible for determining whether or not a dot will be generated in a given cycle, and what dot will actually be generated - including whether or not the dot is in a margin area, and what dither cell values 5 should be used at the specific dot location. A block diagram of the control unit is shown in Figure 232. The inputs to the control unit are a number of avail flags specifying whether or not a given dotgen unit is capable of supplying 'real' data in this cycle. The term 'real' refers to data generated from external sources, such as contone line buffers, bi-level line buffers, and tag plane buffers. Each 10 dotgen unit informs the control unit whether or not a dot can be generated this cycle from real data. It must also check that the DNC is ready to receive data. The contone/spot margin unit is responsible for determining whether the current dot coordinate is within the target contonelspot margins, and the tag margin unit is responsible for determining whether the current dot coordinate is within the target tag margins. 15 The dither matrix table interface provides the interface to DRAM for the generation of dither cell values that are used in the halftoning process in the contone dotgen unit. 28.4.3.1 Determine advdot The HCU does not always require contone planes, bi-level or tag planes in order to produce a page. For example, a given page may not have a bi-level layer, or a tag layer. In addition, the 20 contone and bi-level parts of a page are only required within the contone and bi-level page margins, and the tag part of a page is only required within the tag page margins. Thus output dots WO 2004/050369 PCT/AU2003/001616 496 can be generated without contone, bi-level or tag data before the respective top margins of a page has been reached, and Os are generated for all color planes after the end of the page has been reached (to allow later stages of the printing pipeline to flush). Consequently the HCU has an A vailMask register that determines which of the various input avail 5 flags should be taken notice of during the production of a page from the first line of the target page, and a TMMask register that has the same behaviour, but is used in the lines before the target page has been reached (i.e. inside the target top margin area). The dither matrix mask bit TMask[O] is the exception, it applies to all margins areas not just the top margin. Each bit in the Avail/Mask refers to a particular avail bit: if the bit in the Avai/Mask register is set, then the 10 corresponding avail bit must be 1 for the HCU to advance a dot. The bit to avail correspondence is shown in Table 194. Care should be taken with TMMask - if the particular data is not available after the top margin has been reached, then the HCU will stall. Note that the avail bits for contone and spot colors are ANDed with in-target page after the target page area has been reached to allow dot production in the contone/spot margin areas without needing any data in the CFU and 15 SFU. The avail bit for tag color is ANDed with in tag target_page after the target tag page area has been reached to allow dot production in the tag margin areas without needing any data in the TFU. Table 194. Correspondence between bit in AvailMask and avail flag bit # in AvailMask avail flag description 0 dm avail dither matrix data available 1 cpavail contone pixels available 2 s_avail spot color available 3 tp_avail tag plane available 20 Each of the input avail bits is processed with its appropriate mask bit and the after topmargin flag (note the dither matrix is the exception it is processed with in-target page). The output bits are ANDed together along with Go and output buff full (which specifies whether the output buffer is ready to receive a dot in this cycle) to form the output bit advdot. We also generate 25 wradvdot. In this way, if the output buffer is full or any of the specified avail flags is clear, the HCU will stall. When the end of the page is reached, inpage will be deasserted and the HCU will continue to produce 0 for all dots as long as the DNC requests data. A block diagram of the determine advdot unit is shown in Figure 233. The advance dot block also determines if current page needs dither matrix, it indicates to the 30 dither matrix table interface block via the dm_readenable signal. If no dither is required in the margins or in the target page then dm_readenable will be 0 and no dither will be read in for this page. 28.4.3.2 Position unit The position unit is responsible for outputting the position of the current dot (currpos, curr line) 35 and whether or not this dot is the last dot of a line (advline). Both curr pos and currline are set to WO 2004/050369 PCT/AU2003/001616 497 0 at reset or when Go transitions from 0 to 1. The position unit relies on the advdot input signal to advance through the dots on a page. Whenever an advdot pulse is received, curr pos gets incremented. If curry pos equals maxdot then an advIlne pulse is generated as this is the last dot in a line, curr line gets incremented, and the currjpos is reset to 0 to start counting the dots for 5 the next line. The position unit also generates a filtered version of advline called dmadviine to indicate to the dither matrix pointers to increment to the next line. The dm_adv/ine is only incremented when dither is required for that line. if ((aftertop margin AND avail mask[O]) OR tm mask[O]) then 10 dm advline = advline else dm advline = 0 28.4.3.3 Margin unit The responsibility of the margin unit is to determine whether the specific dot coordinate is within 15 the page at all, within the target page or in a margin area (see Figure 234). This unit is instantiated for both the contone/spot margin unit and the tag margin unit. The margin unit takes the current dot and line position, and returns three flags. * the first, in_page is 1 if the current dot is within the page, and 0 if it is outside the page. * the second flag, in target page, is 1 if the dot coordinate is within the target page area of 20 the page, and 0 if it is within the target top/left/bottom/right margins. * the third flag, aftertop_margin, is 1 if the current dot is below the target top margin, and 0 if it is within the target top margin. A block diagram of the margin unit is shown in Figure 235. 28.4.3.4 Dither matrix table interface 25 The dither matrix table interface provides the interface to DRAM for the generation of dither cell values that are used in the halftoning process in the contone dotgen unit. The control flag dm_readenable enables the reading of the dither matrix table line structure from DRAM. If dmreadenable is 0, the dither matrix is not specified in DRAM and no DRAM accesses are attempted. The dither matrix table interface has an output flag dm_avail which specifies if the 30 current line of the specified matrix is available. The HCU can be directed to stall when dmavail is 0 by setting the appropriate bit in the HCU's A vailMask or TMMask registers. When dmavail is 0 the value in the DitherConstant register is used as the dither cell values that are output to the contone dotgen unit. The dither matrix table interface consists of a state machine that interfaces to the DRAM interface, 35 a dither matrix buffer that provides dither matrix values, and a unit to generate the addresses for reading the buffer. Figure 236 shows a block diagram of the dither matrix table interface. 28.4.3.5 Dither data structure in DRAM The dither matrix is stored in DRAM in 256-bit words, transferred to the HCU in 64-bit words and consumed by the HCU in bytes. Table 195 shows the 64-bit words mapping to 256-bit word 40 addresses, and Table 196 shows the 8-bits dither value mapping in the 64-bits word.
WO 2004/050369 PCT/AU2003/001616 498 Table 195. Dither Data stored in DRAM Address[21:5] Data[255:0] 00000 D3 D2 D1 DO [255:192] [191:128] [127:64] [63:0] 00001 D7 D6 D5 D4 [255:192] [191:128] [127:64] [63:0] 00010 D1I DIO D9 D8 [255:192] [191:128] [127:64] [63:0] 00011 D15 D14 D13 D12 (255:192] [191:128] [127:64] {63:0] 00100 D19 D18 D17 D16 [255:192] [191:128] [127:64] [63:0] etc When the HCU first requests data from DRAM, the 64-bits word transfer order will be 5 DO,DI,D2,D3. On the second request the transfer order will be D4,D5,D6,D7 and so on for other requests. Table 196. Dither data stored in HCUs line buffer Dither index[7:0] Data[7:0] Dither index[7:0] Data[7:0] Dither index[7:0] Data[7:0] 00 DO[7:0] 10 D2[7:01 20 D4[7:0] 01 DO[15:8] 11 D2[15:8] 21 D4[15:8] 02 DO[23:16] 12 D2[23:16] 22 D4[23:16] 03 DO[31:24] 13 D2[32:24] 23 D4[31:24] 04 DO[39:32] 14 D2[39:32] 24 D4[39:32] 05 DO[47:40] 15 D2[47:40] 25 D4[47:40] 06 DO[55:48] 16 D2[55:48] 26 D4[55:48] 07 DO[63:56] 17 D2[63:56] 27 D4[63:56] 08 D1[7:0] 18 D3[7:0] 28 D5[7:0] 09 DI[15:8] 19 D3[15:8] 29 D5[15:8] OA D1 [23:16] IA D3[23:16] 2A D5[23:16] OB D1[31:24] 1B D3[31:24] 2B D5[31:24] OC D1 [39:32] 1C D3[39:32] 2C D5[39:32] OD D1 [47:40] 1D D3[47:40] 2D D5[47:40] OE D1 [55:48] 1E D3[55:48] 2E D5155:48] OF D1 [63:56] 1 F D3[63:56] 2F D5[63:56] etc. etc.
WO 2004/050369 PCT/AU2003/001616 499 28.4.3.5.1 Dither matrix buffer The state machine loads dither matrix table data a line at a time from DRAM and stores it in a buffer. A single line of the dither matrix is either 256 or 128 8-bit entries, depending on the programmable bit Doub/eLineBuf. If this bit is enabled, a double-buffer mechanism is employed 5 such that while one buffer is read from for the current line's dither matrix data (8 bits representing a single dither matrix entry), the other buffer is being written to with the next line's dither matrix data (64-bits at a time). Alternatively, the single buffer scheme can be used, where the data must be loaded at the end of the line, thus incurring a delay. The single/double buffer is implemented using a 256 byte 3-port register array, two reads, one 10 write port, with the reads clocked at double the system clock rate (320MHz) allowing 4 reads per clock cycle. The dither matrix buffer unit also provides the mechanism for keeping track of the current read and write buffers, and providing the mechanism such that a buffer cannot be read from until it has been written to. In this case, each buffer is a line of the dither matrix, i.e. 256 or 128 bytes. 15 The dither matrix buffer maintains a read and write pointer for the dither matrix. The output value dmavai/ is derived by comparing the read and write pointers to determine when the dither matrix is not empty. The write pointer wradr is incremented each time a 64-bit word is written to the dither matrix buffer and the read pointer rd ptr is incremented each time dmadvline is received. If double_linebuf is 0 the rdptr will increment by 2, otherwise it will increment by 1. If the dither 20 matrix buffer is full then no further writes will be allowed (buff full =1), or if the buffer is empty no further buffer reads are allowed (buff emp=1). The read addresses are byte aligned and are generated by the read address generator. A single dither matrix entry is represented by 8 bits and an entry is read for each of the four contone planes in parallel. If double buffer is used (doubleline buf=1) the read address is derived from 7 25 bit address from the read address generator and 1-bit from the read pointer. If double_linebuf=0 then the read address is the full 8-bits from the read address generator. if (double line buf == 1 )then read_port[7:0] {rdptr[0],rd_adr[6:Of 0]) concatenation 30 else read-port[7:0J = rd adr[7:01 28.4.3.5.2 Read address generator For each contone plane there is a initial, lower and upper index to be used when reading dither 35 cell values from the dither matrix double buffer. The read address for each plane is used to select a byte from the current 256-byte read buffer. When Go gets set (0 to I transition), or at the end of a line, the read addresses are set to their corresponding initial index. Otherwise, the read address generator relies on advdot to advance the addresses within the inclusive range specified the lower and upper indices, represented by the following pseudocode: 40 WO 2004/050369 PCT/AU2003/001616 500 if (advdot == 1) then if (advline == 1) then rd adr = dm init index elsif (rdadr == dmupr_index) then 5 rd adr = dm lwr index else rd adr ++ else rd adr = rd adr 10 28.4.3.5.3 State machine The dither matrix is read from DRAM in single 256-bit accesses, receiving the data from the DIU over 4 clock cycles (64-bits per cycle).The protocol and timing for read accesses to DRAM is described in section 20.9.1 on page 269. Read accesses to DRAM are implemented by means of the state machine described in Figure 238. 15 All counters and flags should be cleared after reset or when Go transitions from 0 to 1. While the Go bit is 1, the state machine relies on the dmreadenable bit to tell it whether to attempt to read dither matrix data from DRAM. When dmreadenable is clear, the state machine does nothing and remains in the idle state. When dmreadenable is set, the state machine continues to load dither matrix data, 256-bits at a time (received over 4 clock cycles, 64 bits per cycle), while there 20 is space available in the dither matrix buffer, (buff full !=1). The read address and linestartadr are initially set to startdmadr. The read address gets incremented after each read access. It takes 4 or 8 read accesses to load a line of dither matrix into the dither matrix buffer, depending on whether we're using a single or double buffer. A count is kept of the accesses to DRAM. When a read access completes and access count equals 3 or 25 7, a line of dither matrix has just been loaded from and the read address is updated to linestart adr plus lineincrement so it points to the start of the next line of dither matrix. (line-startadr is also updated to this value). If the read address equals end dmadr then the next read address will be startdmadr, thus the read address wraps to point to the start of the area in DRAM where the dither matrix is stored. 30 The write address for the dither matrix buffer is implemented by means of a modulo-32 counter that is initially set to 0 and incremented when diuhcurvalid is asserted. Figure 237 shows an example of setting startdmadr and enddmadr values in relation to the line increment and double line buffer settings. The calculation of enddmadr is // end dm adr calculation 35 dm-height = Dither matrix height in lines if (double line buf == 1) / end dm adr[21:51 = start dm adr[21:5] + (((dmheight 1)*line inc) + 3) << 5) else WO 2004/050369 PCT/AU2003/001616 501 end dm adr[21:51 = start_dm adr[21:51 + (((dmheight 1)*line inc) + 7) << 5) 28.4.4 Contone dotgen unit The contone dotgen unit is responsible for producing a dot in up to 4 color planes per cycle. The 5 contone dotgen unit also produces a cpavailflag which specifies whether or not contone pixels are currently available, and the output hcucfu_advdot to request the CFU to provide the next contone pixel in up to 4 color planes. The block diagram for the contone dotgen unit is shown in Figure 239. A dither unit provides the functionality for dithering a single contone plane. The contone image is 10 only defined within the contone/spot margin area. As a result, if the input flag in target page is 0, then a constant contone pixel value is used for the pixel instead of the contone plane. The resultant contone pixel is then halftoned. The dither value to be used in the halftoning process is provided by the control data unit. The halftoning process involves a comparison between a pixel value and its corresponding dither value. If the 8-bit contone value is greater than 15 or equal to the 8-bit dither matrix value a 1 is output. If not, then a 0 is output. This means each entry in the dither matrix is in the range 1-255 (0 is not used). Note that constant use is dependant on the in-target page signal only, if in target page is 1 then the cfuhcu_c*_data should be allowed to pass through, regardless of the stalling behaviour or the avail mask[1] setting. This allows a constant value to be setup on the CFU output data, and 20 the use of different constants while inside and outside the target page. The hcu_cfu.advdot will always be zero if the avail mask[1] is zero. 28.4.5 Spot dotgen unit The spot dotgen unit is responsible for producing a dot of bi-level data per cycle. It deals with bi level data (and therefore does not need to halftone) that comes from the LBD via the SFU. Like 25 the contone layer, the bi-level spot layer is only defined within the contone/spot margin area. As a result, if input flag in-target page is 0, then a constant dot value (typically this would be 0) is used for the output dot. The spot dotgen unit also produces a savaliflag which specifies whether or not spot dots are currently available for this spot plane, and the output hcusfuadvdot to request the SFU to 30 provide the next bi-level data value. The spot dotgen unit can be represented by the following pseudocode: s avail = sfu hcu avail if (intargetpage 1 AND availmask[2] == 0 )OR 35 (intarget_page 0) then hcu sfu advdot = 0 else hcu sfu advdot = advdot 40 if (in target page == 1) then WO 2004/050369 PCT/AU2003/001616 502 sp = sfu_hcu_sdata else sp = sp_constant Note that constant use is dependant on the in target page signal only, if in target page is 1 then 5 the sfuhcudata should be allowed to pass through, regardless of the stalling behaviour or the avail_mask setting. This allows a constant value to be setup on the SFU output data, and the use of different constants while inside and outside the target page. The hcusfuadvdot will always be zero if the avalmask[2] is zero. 28.4.6 Tag dotgen unit 10 This unit is very similar to the spot dotgen unit (see Section 28.4.5) in that it deals with bi-level data, in this case from the TE via the TFU. The tag layer is only defined within the tag margin area. As a result, if input flag in tag target page is 0, then a constant dot value, tp-constant (typically this would be 0), is used for the output dot. The tagplane dotgen unit also produces a tpavail flag which specifies whether or not tag dots are currently available for the tagplane, and 15 the output hcuffuadvdot to request the TFU to provide the next bi-level data value. The hcu_tfuadvdot generation is similar to the SFU and CFU, except it depends only on in-target page and advdot. It does not take into account the avail mask when inside the target page. 28.4.7 Dot reorg unit 20 The dot reorg unit provides a means of mapping the bi-level dithered data, the spotO color, and the tag data to output inks in the actual printhead. Each dot reorg unit takes a set of 6 1-bit inputs and produces a single bit output that represents the output dot for that color plane. The output bit is a logical combination of any or all of the input bits. This allows the spot color to be placed in any output color plane (including infrared for testing purposes), black to be merged 25 into cyan, magenta and yellow (in the case of no black ink in the Memjet printhead), and tag dot data to be placed in a visible plane. An output for fixative can readily be generated by simply combining desired input bits. The dot reorg unit contains a 64-bit lookup to allow complete freedom with regards to mapping. Since all possible combinations of input bits are accounted for in the 64 bit lookup, a given dot 30 reorg unit can take the mapping of other reorg units into account. For example, a black plane reorg unit may produce a I only if the contone plane 3 or spot color inputs are set (this effectively composites black bi-level over the contone). A fixative reorg unit may generate a 1 if any 2 of the output color planes is set (taking into account the mappings produced by the other reorg units). If dead nozzle replacement is to be used (see section 29.4.2 on page 506), the dot reorg can be 35 programmed to direct the dots of the specified color into the main plane, and 0 into the other. If a nozzle is then marked as dead in the DNC, swapping the bits between the planes will result in 0 in the dead nozzle, and the required data in the other plane. If dead nozzle replacement is to be used, and there are no tags, the TE can be programmed with the position of dead nozzles and the resultant pattern used to direct dots into the specified nozzle 40 row. If only fixed background TFS is to be used, a limited number of nozzles can be replaced. If WO 2004/050369 PCT/AU2003/001616 503 variable tag data is to be used to specify dead nozzles, then large numbers of dead nozzles can be readily compensated for. The dot reorg unit can be used to average out the nozzle usage when two rows of nozzles share the same ink and tag encoding is not being used. The TE can be programmed to produce a 5 regular pattern (e.g. 0101 on one line, and 1010 on the next) and this pattern can be used as a directive as to direct dots into the specified nozzle row. Each reorg unit contains a 64-bit lOMapping value programmable as two 32-bit HCU registers, and a set of selection logic based on the 6-bit dot input (26 = 64 bits), as shown in Figure 240. The mapping of input bits to each of the 6 selection bits is as defined in Table 197. 10 Table 197. Mapping of input bits to 6 selection bits address bit tied to likely of lookup interpretation 0 bi-level dot from contone layer 0 cyan 1 bi-level dot from contone layer 1 magenta 2 bi-level dot from contone layer 2 yellow 3 bi-level dot from contone layer 3 black bi-level spotO dot black 5 bi-level tag dot infra-red 28.4.8 Output buffer The output buffer de-couples the stalling behaviour of the feeder units from the stalling behaviour of the DNC. The larger the buffer the greater de-coupling. Currently the output buffer size is 2, but 15 could be increased if needed at the cost of extra area. If the Go bit is set to 0 no read or write of the output buffer is permitted. On a low to high transition of the Go bit the contents of the output buffer are cleared. The output buffer also implements the interface logic to the DNC. If there is data in the output buffer the hcudncavail signal will be 1, otherwise is will be 0. If both hcudncavail and 20 dnc hcu ready are I then data is read from the output buffer. On the write side if there is space available in the output buffer the logic indicates to the control unit via the output buff full signal. The control unit will then allow writes to the output buffer via the wradvdot signal. If the writes to the output buffer are after the end of a page (indicated by in_.page equal to 0) then all dots written into the output buffer are set to zero. 25 28.4.8.1 HCU to DNC interface Figure 241 shows the timing diagram and representative logic of the HCU to DNC interface. The hcudnc avail signal indicate to the DNC that the HCU has data available. The dnchcuready signal indicates to the HCU that the DNC is ready to accept data. When both signals are high data is transferred from the HCU to the DNC. Once the HCU indicates it has data available (setting the 30 hcudnc avail signal high) it can only set the hcudncavail low again after a dot is accepted by the DNC. 28.4.9 Feeder to HCU interfaces WO 2004/050369 PCT/AU2003/001616 504 Figure 242 shows the feeder unit to HCU interface timing diagram, and Figure 243 shows representative logic of the interface with the register positions. sfuhcudata and sfuhcuavail are always registered while the sfuhcuadvdot is not. The hcusfu avail signal indicates to the 5 HCU that the feeder unit has data available, and sfu_hcu_advdot indicates to the feeder unit that the HCU has captured the last dot. The HCU can never produce an advance dot pulse while the avail is low. The diagrams show the example of the SFU to HCU interface, but the same interface is used for the other feeder units TFU and CFU. 29 Dead Nozzle Compensator (DNC) 10 29.1 OVERVIEW The Dead Nozzle Compensator (DNC) is responsible for adjusting Memjet dot data to take account of non-functioning nozzles in the Memjet printhead. Input dot data is supplied from the HCU, and the corrected dot data is passed out to the DWU. The high level data path is shown by the block diagram in Figure 244. 15 The DNC compensates for a dead nozzles by performing the following operations: * Dead nozzle removal, i.e. turn the nozzle off * Ink replacement by direct substitution i.e. K -> K * Ink replacement by indirect substitution i.e. K -> CMY * Error diffusion to adjacent nozzles 20 * Fixative corrections The DNC is required to efficiently support up to 5% dead nozzles, under the expected DRAM bandwidth allocation, with no restriction on where dead nozzles are located and handle any fixative correction due to nozzle compensations. Performance must degrade gracefully after 5% dead nozzles. 25 29.2 DEAD NOZZLE IDENTIFICATION Dead nozzles are identified by means of a position value and a mask value. Position information is represented by a 10-bit delta encoded format, where the 10-bit value defines the number of dots between dead nozzle columns' 9 . With the delta information it also reads the 6-bit dead nozzle mask (dn mask) for the defined dead nozzle position. Each bit in the dnmask corresponds to an ink plane. 30 A set bit indicates that the nozzle for the corresponding ink plane is dead. The dead nozzle table format is shown in Figure 245. The DNC reads dead nozzle information from DRAM in single 256-bit accesses. A 10-bit delta encoding scheme is chosen so that each table entry is 16 bits wide, and 16 entries fit exactly in each 256-bit read. Using 10-bit delta encoding means that the maximum distance between dead nozzle columns is 1023 dots. It is possible that dead nozzles may be spaced further than 1023 dots from each other, 35 so a null dead nozzle identifier is required. A null dead nozzle identifier is defined as a 6-bit dnmask of all zeros. These null dead nozzle identifiers should also be used so that: 19 for a 10-bit delta value of d, if the current column n is a dead nozzle column then the next dead nozzle column is given by n + (d + 1).
WO 2004/050369 PCT/AU2003/001616 505 e the dead nozzle table is a multiple of 16 entries (so that it is aligned to the 256-bit DRAM locations) * the dead nozzle table spans the complete length of the line, i.e. the first entry dead nozzle table should have a delta from the 5 first nozzle column in a line and the last entry in the dead nozzle table should correspond to the last nozzle column in a line. Note that the DNC deals with the width of a page. This may or may not be the same as the width of the printhead (the PHI may introduce some margining to the page so that its dot output matches the width of the printhead). Care must be taken when programming the dead nozzle 10 table so that dead nozzle positions are correctly specified with respect to the page and printhead. 29.3 DRAM STORAGE AND BANDWIDTH REQUIREMENT The memory required is largely a factor of the number of dead nozzles present in the printhead (which in turn is a factor of the printhead size). The DNC is required to read a 16-bit entry from the dead nozzle table for every dead nozzle. Table 198 shows the DRAM storage and average 2 0 15 bandwidth requirements for the DNC for different percentages of dead nozzles and different page sizes. Table 198. Dead Nozzle storage and average bandwidth requirements Page size % Dead Dead nozzle table Nozzles Memory Bandwidth (KBytes) (bits/cycle) A4a 5% 1.4c 0.8 10% 2.7 1.6 15% 4.1 2.4 A35 5% 1.9 0.8 10% 3.8 1.6 15% 5.7 2.4 a. Bi-lithic printhead has 13824 nozzles per color providing full bleed printing for A4/Letter b. Bi-lithic printhead has 19488 nozzles per color providing full bleed printing for A3 20 c. 16 bits x 13824 nozzles x 0.05 dead d. (16 bits read / 20 cycles) = 0.8 bits/cycle 29.4 NOZZLE COMPENSATION DNC receives 6 bits of dot information every cycle from the HCU, 1 bit per color plane. When the dot position corresponds to a dead nozzle column, the associated 6-bit dnmask indicates which 25 ink plane(s) contains a dead nozzle(s). The DNC first deletes dots destined for the dead nozzle. It then replaces those dead dots, either by placing the data destined for the dead nozzle into an 2aAverage bandwidth assumes an even spread of dead nozzles. Clumps of dead nozzles may cause delays due to insufficient available DRAM bandwidth. These delays will occur every line causing an accumulative delay over a page.
WO 2004/050369 PCT/AU2003/001616 506 adjacent ink plane (direct substitution) or into a number of ink planes (indirect substitution). After ink replacement, if a dead nozzle is made active again then the DNC performs error diffusion. Finally, following the dead nozzle compensation mechanisms the fixative, if present, may need to be adjusted due to new nozzles being activated, or dead nozzles being removed. 5 29.4.1 Dead nozzle removal If a nozzle is defined as dead, then the first action for the DNC is to turn off (zeroing) the dot data destined for that nozzle. This is done by a bit-wise ANDing of the inverse of the dnmask with the dot value. 29.4.2 Ink replacement 10 Ink replacement is a mechanism where data destined for the dead nozzle is placed into an adjacent ink plane of the same color (direct substitution, i.e. K -> Kaitemate), or placed into a number of ink planes, the combination of which produces the desired color (indirect substitution, i.e. K -> CMY). Ink replacement is performed by filtering out ink belonging to nozzles that are dead and then adding back in an appropriately calculated pattern. This two step process allows 15 the optional re-inclusion of the ink data into the original dead nozzle position to be subsequently error diffused. In the general case, fixative data destined for a dead nozzle should not be left active intending it to be later diffused. The ink replacement mechanism has 6 ink replacement patterns, one per ink plane, programmable by the CPU. The dead nozzle mask is ANDed with the dot data to see if there are 20 any planes where the dot is active but the corresponding nozzle is dead. The resultant value forms an enable, on a per ink basis, for the ink replacement process. If replacement is enabled for a particular ink, the values from the corresponding replacement pattern register are ORed into the dot data. The output of the ink replacement process is then filtered so that error diffusion is only allowed for the planes in which error diffusion is enabled. The output of the ink replacement logic 25 is ORed with the resultant dot after dead nozzle removal. See Figure n page565 on page Error! Bookmark not defined. for implementation details. For example if we consider the printhead color configuration C,M,Y,K 1
,K
2 ,IR and the input dot data from the HCU is b1 01100. Assuming that the K 1 ink plane and IR ink plane for this position are dead so the dead nozzle mask is bOO0101. The DNC first removes the dead nozzle by 30 zeroing the K 1 plane to produce bl01000. Then the dead nozzle mask is ANDed with the dot data to give b000100 which selects the ink replacement pattern for K 1 (in this case the ink replacement pattern for K 1 is configured as bOO0010, i.e. ink replacement into the K 2 plane). Providing error diffusion for K 2 is enabled, the output from the ink replacement process is bOO001 0. This is ORed with the output of dead nozzle removal to produce the resultant dot b1 01010. As can be seen the 35 dot data in the defective K 1 nozzle was removed and replaced by a dot in the adjacent K 2 nozzle in the same dot position, i.e. direct substitution. In the example above the K 1 ink plane could be compensated for by indirect substitution, in which case ink replacement pattern for K 1 would be configured as b1 11000 (substitution into the CMY WO 2004/050369 PCT/AU2003/001616 507 color planes), and this is ORed with the output of dead nozzle removal to produce the resultant dot b1 11000. Here the dot data in the defective K 1 ink plane was removed and placed into the CMY ink planes. 29.4.3 Error diffusion 5 Based on the programming of the lookup table the dead nozzle may be left active after ink replacement. In such cases the DNC can compensate using error diffusion. Error diffusion is a mechanism where dead nozzle dot data is diffused to adjacent dots. When a dot is active and its destined nozzle is dead, the DNC will attempt to place the data into an adjacent dot position, if one is inactive. If both dots are inactive then the choice is arbitrary, and 10 is determined by a pseudo random bit generator. If both neighbor dots are already active then the bit cannot be compensated by diffusion. Since the DNC needs to look at neighboring dots to determine where to place the new bit (if required), the DNC works on a set of 3 dots at a time. For any given set of 3 dots, the first dot received from the HCU is referred to as dot A, and the second as dot B, and the third as dot C. 15 The relationship is shown in Figure 246. For any given set of dots ABC, only B can be compensated for by error diffusion if B is defined as dead. A I in dot B will be diffused into either dot A or dot C if possible. If there is already a 1 in dot A or dot C then a 1 in dot B cannot be diffused into that dot. The DNC must support adjacent dead nozzles. Thus if dot A is defined as dead and has 20 previously been compensated for by error diffusion, then the dot data from dot B should not be diffused into dot A. Similarly, if dot C is defined as dead, then dot data from dot B should not be diffused into dot C. Error diffusion should not cross line boundaries. If dot B contains a dead nozzle and is the first dot in a line then dot A represents the last dot from the previous line. In this case an active bit on a 25 dead nozzle of dot B should not be diffused into dot A. Similarly, if dot B contains a dead nozzle and is the last dot in a line then dot C represents the first dot of the next line. In this case an active bit on a dead nozzle of dot B should not be diffused into dot C. Thus, as a rule, a 1 in dot B cannot be diffused into dot A if * a 1 is already present in dot A, 30 * dot A is defined as dead, e or dot A is the last dot in a line. Similarly, a 1 in dot B cannot be diffused into dot C if * a 1 is already present in dot C, * dot C is defined as dead, 35 e or dot C is the first dot in a line. If B is defined to be dead and the dot value for B is 0, then no compensation needs to be done and dots A and C do not need to be changed. If B is defined to be dead and the dot value for B is 1, then B is changed to 0 and the DNC attempts to place the 1 from B into either A or C: WO 2004/050369 PCT/AU2003/001616 508 " If the dot can be placed into both A and C, then the DNC must choose between them. The preference is given by the current output from the random bit generator, 0 for "prefer left" (dot A) or 1 for "prefer right" (dot C). 5 * if dot can be placed into only one of A and C, then the 1 from B is placed into that position. " If dot cannot be placed into either one of A or C, then the DNC cannot place the dot in either position. 10 Table 199. Error Diffusion Truth Table when dot B is dead Input Output A B C Rand'a A B C OR OR Dead Cdead OR OR A last in line C first in line 0 0 0 X Ainput 0 C input 0 0 1 X Ainput 0 Cinput 0 1 0 0 1'b 0 C input 0 1 0 1 Ainput 0 1 0 1 1 X 1 0 Cinput 1 0 0 X Ainput 0 C input 1 0 1 X Ainput 0 C input 1 1 0 X Ainput 0 1 1 1 1 Ainput 0 C input Table 199 shows the truth table for DNC error diffusion operation when dot B is defined as dead. a. Output from random bit generator. Determines direction of error diffusion (0 = left, I = right) b. Bold emphasis is used to show the DNC inserted a 1 15 The random bit value used to arbitrarily select the direction of diffusion is generated by a 32-bit maximum length random bit generator. The generator generates a new bit for each dot in a line regardless of whether the dot is dead or not. The random bit generator can be initialized with a 32-bit programmable seed value. 29.4.4 Fixative correction 20 After the dead nozzle compensation methods have been applied to the dot data, the fixative, if present, may need to be adjusted due to new nozzles being activated, or dead nozzles being removed. For each output dot the DNC determines if fixative is required (using the FixativeRequiredMask register) for the new compensated dot data word and whether fixative is activated already for that dot. For the DNC to do so it needs to know the color plane that has WO 2004/050369 PCT/AU2003/001616 509 fixative, this is specified by the FixativeMask1 configuration register. Table 200 indicates the actions to take based on these calculations. Table 200. Truth table for fixative correction Fixative Present Fixative required Action 1 1 Output dot as is. 1 0 Clear fixative plane. 0 1 Attempt to add fixative. 0 0 Output dot as is. 5 The DNC also allows the specification of another fixative plane, specified by the FixativeMask2 configuration register, with FixativeMask1 having the higher priority over FixativeMask2. When attempting to add fixative the DNC first tries to add it into the planes defined by FixativeMaskl. However, if any of these planes is dead then it tries to add fixative by placing it into the planes defined by FixativeMask2. 10 Note that the fixative defined by FixativeMask1 and FixativeMask2 could possibly be multi-part fixative, i.e. 2 bits could be set in FixativeMaskl with the fixative being a combination of both inks. 29.5 IMPLEMENTATION A block diagram of the DNC is shown in Figure 247. 29.5.1 Definitions of 1/O 15 Table 201. DNC port list and description Port name Pins I/O Description Clocks and Resets PcIk 1 In System Clock. prstIn 1 In System reset, synchronous active low. PCU interface pcu-dnc_sel 1 In Block select from the PCU. When pcu dncsel is high both pcu adr and pcu dataout are valid. pcurwn I In Common read/not-write signal from the PCU. pcu-adr[6:2] 5 In PCU address bus. Only 5 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. dnc_pcurdy 1 Out Ready signal to the PCU. When dnc pcurdy is high it indicates the last cycle of the access. For a write cycle this means pcu dataout has been registered by the block and for a read cycle this means the data on dnc pcu datain is valid. dncpcu-datain[31:0] 32 Out Read data bus to the PCU. DIU interface WO 2004/050369 PCT/AU2003/001616 510 dnc diu-rreq 1 Out DNC unit requests DRAM read. A read request must be accompanied by a valid read address. dnc diu radr[21:5] 17 Out Read address to DIU, 256-bit word aligned. diu dncrack 1 In Acknowledge from DIU that read request has been accepted and new read address can be placed on dncdiuradr diu dnc rvalid I In Read data valid, active high. Indicates that valid read data is now on the read data bus, diu data. diudata[63:0] 64 In Read data from DIU. HCU interface dnchcu ready 1 Out Indicates that DNC is ready to accept data from the HCU. hcu dnc avail 1 In Indicates valid data present on hcu dnc data. hcudnc-data[5:0] 6 In Output bi-level dot data in 6 ink planes. DWU interface dwu dnc ready 1 In Indicates that DWU is ready to accept data from the DNC. dncdwuavail 1 Out Indicates valid data present on dnc dwu data. dncdwu-data[5:0] 6 Out Output bi-level dot data in 6 ink planes. 29.5.2 Configuration registers The configuration registers in the DNC are programmed via the PCU interface. Refer to section 21.8.2 on page 351 for the description of the protocol and timing diagrams for reading and writing registers in the DNC. Note that since addresses in SoPEC are byte aligned and the PCU only 5 supports 32-bit register reads and writes, the lower 2 bits of the PCU address bus are not required to decode the address space for the DNC. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of dnc pcu datain. Table 202 lists the configuration registers in the DNC. 10 Table 202. DNC configuration registers Address Register name #bits Value on Description (DNCbase +) reset Control registers Ox00 Reset 1 OxI A write to this register causes a reset of the DNC. Ox04 Go 1 Ox0 Writing 1 to this register starts the DNC. Writing 0 to this register halts the DNC. When Go is asserted all counters, flags etc. are cleared or given their initial WO 2004/050369 PCT/AU2003/001616 511 value, but configuration registers keep their values. When Go is deasserted the state machines go to their idle states but all counters and configuration registers keep their values. This register can be read to determine if the DNC is running (1 = running, 0 = stopped). Setup registers (constant during processing) Ox10 MaxDot 16 OxO00 This is the maximum dot number - 1 present across a page. For example if a page contains 13824 dots, then MaxDot will be 13823. Note that this number may or may not be the same as the number of dots across the printhead as some margining may be introduced in the PHI. Ox1 4 LSFR 32 0x0000_ The current value of the LFSR register 0000 used as the 32-bit maximum length random bit generator. Users can write to this register to program a seed value for the 32-bit maximum length random bit generator. Must not be all Is for taps implemented in XNOR form. (it is expected that writing a seed value will not occur during the operation of the LFSR). This LSFR value could also have a possible use as a random source in program code. Ox20 FixativeMask1 6 OxO0 Defines the higher priority fixative plane(s). Bit 0 represents the settings for plane 0, bit 1 for plane 1 etc. For each bit: I = the ink plane contains fixative. 0 = the ink plane does not contain fixative. Ox24 FixativeMask2 6 0x00 Defines the lower priority fixative WO 2004/050369 PCT/AU2003/001616 512 plane(s). Bit 0 represents the settings for plane 0, bit I for plane 1 etc. Used only when FixativeMask1 planes are dead. For each bit: 1 = the ink plane contains fixative. o = the ink plane does not contain fixative. Ox28 FixativeRequired 6 Ox00 Identifies the ink planes that require Mask fixative. Bit 0 represents the settings for plane 0, bit I for plane I etc. For each bit: 1 = the ink plane requires fixative. o = the ink plane does not require fixative (e.g. ink is self-fixing) 0x30 DnTableStartAdr[ 17 0x0_0000 Start address of Dead Nozzle Table in 21:5] DRAM, specified in 256-bit words. Ox34 DnTableEndAdr[ 17 Ox0_0000 End address of Dead Nozzle Table in 21:5] DRAM, specified in 256-bit words, i.e. the location containing the last entry in the Dead Nozzle Table. The Dead Nozzle Table should be aligned to a 256-bit boundary, if necessary it can be padded with null entries. Ox40 - 0x54 PlaneReplacePat 6x6 OxOO Defines the ink replacement pattern for tern[5:0] each of the 6 ink planes. PlaneReplacePattern[0] is the ink replacement pattern for plane 0, PlaneReplacePattern[1] is the ink replacement pattern for plane 1, etc. For each 6-bit replacement pattern for a plane, a 1 in any bit positions indicates the alternative ink planes to be used for this plane. Ox58 DiffuseEnable 6 Ox3F Defines whether, after ink replacement, error diffusion is allowed to be performed on each plane. Bit 0 represents the settings for plane 0, bit 1 for plane 1 etc. For each bit: WO 2004/050369 PCT/AU2003/001616 513 1 = error diffusion is enabled 0 = error diffusion is disabled Debug registers (read only) 0x60 DncOutputDebug 8 N/A Bit 7 = dwudncready Bit 6 = dnc dwu avail Bits 5-0 = dnc dwu data 0x64 DncReplaceDeb 14 N/A Bit 13 = edu ready ug Bit 12 = iruavail Bits 11-6 = iru dn mask Bits 5-0 = iru data 0x68 DncDiffuseDebu 14 N/A Bit 13 = dwudnc_ready g Bit 12 = dncdwuavail Bits 11-6 = edu dn mask Bits 5-0 = edu data 29.5.3 Ink replacement unit Figure 248 shows a sub-block diagram for the ink replacement unit. 29.5.3.1 Control unit The control unit is responsible for reading the dead nozzle table from DRAM and making it 5 available to the DNC via the dead nozzle FIFO. The dead nozzle table is read from DRAM in single 256-bit accesses, receiving the data from the DIU over 4 clock cycles (64-bits per cycle). The protocol and timing for read accesses to DRAM is described in section 20.9.1 on page 269. Reading from DRAM is implemented by means of the state machine shown in Figure 249. All counters and flags should be cleared after reset. When Go transitions from 0 to 1 all counters 10 and flags should take their initial value. While the Go bit is 1, the state machine requests a read access from the dead nozzle table in DRAM provided there is enough space in its FIFO. A modulo-4 counter, rdcount, is used to count each of the 64-bits received in a 256-bit read access. It is incremented whenever diu_dnc_rvalid is asserted. When Go is 1, dntableradr is set to dntablestartadr. As each 64-bit value is returned, indicated by diu dnc_rvalid being 15 asserted, dntableradr is compared to dntableendadr * if rdcount equals 3 and dntable radr equals dntableendadr, then dntableradr is updated to dntablestartadr. * if rdcount equals 3 and dntableradr does not equal dntableendadr, then dntableradr is incremented by 1. 20 A count is kept of the number of 64-bit values in the FIFO. When diudncrval/d is 1 data is written to the FIFO by asserting wren, and fifocontents and fifowradr are both incremented. When fifocontents[3:01 is greater than 0 and eduready is 1, dnchcuready is asserted to indicate that the DNC is ready to accept dots from the HCU. If hcudnc avail is also 1 then a dotadv pulse is sent to the GenMask unit, indicating the DNC has accepted a dot from the HCU, 25 and iruavail is also asserted. After Go is set, a single preload pulse is sent to the GenMask unit once the FIFO contains data.
WO 2004/050369 PCT/AU2003/001616 514 When a rd adv pulse is received from the GenMask unit, fifo_rd adr[4:0 is then incremented to select the next 16-bit value. If fifordadr[1:0J = 11 then the next 64-bit value is read from the FIFO by asserting rd_en, and fifocontents[3:0] is decremented. 29.5.3.2 Dead nozzle FIFO 5 The dead nozzle FIFO conceptually is a 64-bit input, and 16-bit output FIFO to account for the 64 bit data transfers from the DIU, and the individual 16-bit entries in the dead nozzle table that are used in the GenMask unit. In reality, the FIFO is actually 8 entries deep and 64-bits wide (to accommodate two 256-bit accesses). On the DRAM side of the FIFO the write address is 64-bit aligned while on the GenMask side the 10 read address is 16-bit aligned, i.e. the upper 3 bits are input as the read address for the FIFO and the lower 2 bits are used to select 16 bits from the 64 bits (1st 16 bits read corresponds to bits 15 0, second 16 bits to bits 31-16 etc.). 29.5.3.3 GenMask unit The GenMask unit generates the 6-bit dnmask that is sent to the replace unit. It consists of a 10 15 bit delta counter and a mask register. After Go is set, the GenMask unit will receive a preload pulse from the control unit indicating the first dead nozzle table entry is available at the output of the dead nozzle FIFO and should be loaded into the delta counter and mask register. A rdadv pulse is generated so that the next dead nozzle table entry is presented at the output of the dead nozzle FIFO. The delta counter is 20 decremented every time a dotadv pulse is received. When the delta counter reaches 0, it gets loaded with the current delta value output from the dead nozzle FIFO, i.e. bits 15-6, and the mask register gets loaded with mask output from the dead nozzle FIFO, i.e. bits 5-0. A rdadv pulse is then generated so that the next dead nozzle table entry is presented at the output of the dead nozzle FIFO. 25 When the delta counter is 0 the value in the mask register is output as the dn_mask, otherwise the dn mask is all Os. The GenMask unit has no knowledge of the number of dots in a line, it simply loads a counter to count the delta from one dead nozzle column to the next. Thus as described in section 29.2 on page 504 the dead nozzle table should include null identifiers if necessary so that the dead nozzle 30 table covers the first and last nozzle column in a line. 29.5.3.4 Replace unit Dead nozzle removal and ink replacement are implemented by the combinatorial logic shown in Figure 250. Dead nozzle removal is performed by bit-wise ANDing of the inverse of the dnmask with the dot value. 35 The ink replacement mechanism has 6 ink replacement patterns, one per ink plane, programmable by the CPU. The dead nozzle mask is ANDed with the dot data to see if there are any planes where the dot is active but the corresponding nozzle is dead. The resultant value forms an enable, on a per ink basis, for the ink replacement process. If replacement is enabled for a particular ink, the values from the corresponding replacement pattern register are ORed into the WO 2004/050369 PCT/AU2003/001616 515 dot data. The output of the ink replacement process is then filtered so that error diffusion is only allowed for the planes in which error diffusion is enabled. The output of the ink replacement process is ORed with the resultant dot after dead nozzle removal. If the dot position does not contain a dead nozzle then the dnmask will be all Os and the 5 dot, hcudncdata, will be passed through unchanged. 29.5.4 Error Diffusion Unit Figure 251 shows a sub-block diagram for the error diffusion unit. 29.5.4.1 Random Bit Generator The random bit value used to arbitrarily select the direction of diffusion is generated by a 10 maximum length 32-bit LFSR. The tap points and feedback generation are shown in Figure 252. The LFSR generates a new bit for each dot in a line regardless of whether the dot is dead or not, i.e shifting of the LFSR is enabled when advdot equals 1. The LFSR can be initialised with a 32 bit programmable seed value, randomseed. This seed value is loaded into the LFSR whenever a write occurs to the RandomSeed register. Note that the seed value must not be all Is as this 15 causes the LFSR to lock-up. 29.5.4.2 Advance Dot Unit The advance dot unit is responsible for determining in a given cycle whether or not the error diffuse unit will accept a dot from the ink replacement unit or make a dot available to the fixative correct unit and on to the DWU. It therefore receives the dwu dnc ready control signal from the 20 DWU, the iruavailflag from the ink replacement unit, and generates dncdwu_avai and eduready control flags. Only the dwudncready signal needs to be checked to see if a dot can be accepted and asserts edu ready to indicate this. If the error diffuse unit is ready to accept a dot and the ink replacement unit has a dot available, then a advdot pulse is given to shift the dot into the pipeline in the diffuse 25 unit. Note that since the error diffusion operates on 3 dots, the advance dot unit ignores dwu_dnc ready initially until 3 dots have been accepted by the diffuse unit. Similarly dncdwuaval is not asserted until the diffuse unit contains 3 dots and the ink replacement unit has a dot available. 29.5.4.3 Diffuse Unit 30 The diffuse unit contains the combinatorial logic to implement the truth table from Table . The diffuse unit receives a dot consisting of 6 color planes (1 bit per plane) as well as an associated 6 bit dead nozzle mask value. Error diffusion is applied to all 6 planes of the dot in parallel. Since error diffusion operates on 3 dots, the diffuse unit has a pipeline of 3 dots and their corresponding dead nozzle mask values. 35 The first dot received is referred to as dot A, and the second as dot B, and the third as dot C. Dots are shifted along the pipeline whenever advdot is 1. A count is also kept of the number of dots received. It is incremented whenever advdot is 1, and wraps to 0 when it reaches maxdot. When the dot count is 0 dot C corresponds to the first dot in a line. When the dot count is I dot A corresponds to the last dot in a line.
WO 2004/050369 PCT/AU2003/001616 516 In any given set of 3 dots only dot B can be defined as containing a dead nozzle(s). Dead nozzles are identified by bits set in irudnmask. If dot B contains a dead nozzle(s), the corresponding bit(s) in dot A, dot C, the dead nozzle mask value for A, the dead nozzle mask value for C, the dot count, as well as the random bit value are input to the truth table logic and the dots A, B and C 5 assigned accordingly. If dot B does not contain a dead nozzle then the dots are shifted along the pipeline unchanged. 29.5.5 Fixative Correction Unit The fixative correction unit consists of combinatorial logic to implement fixative correction as defined in Table 203. For each output dot the DNC determines if fixative is required for the new 10 compensated dot data word and whether fixative is activated already for that dot. FixativePresent = ((FixativeMask1 FixativeMask2) & edu data) != 0 FixativeRequired (FixativeRequiredMask & edudata) != 0 15 It then looks up the truth table to see what action, if any, needs to be taken. Table 203. Truth table for fixative correction Fixative Present Fixative Action Output required 1 1 Output dot as is. dnc dwu data = edudata 1 0 Clear fixative plane. dncdwudata = (edu-data) & -(FixativeMask1 I FixativeMask2) 0 1 Attempt to add fixative. if (FixativeMask1 & DnMask) != 0 dncdwudata = (edu data) | (FixativeMask2 & -DnMask) else dncdwudata = (edu data) (FixativeMask1) 0 0 Output dot as is. dnc dwu data = edu data When attempting to add fixative the DNC first tries to add it into the plane defined by FixativeMask1. However, if this plane is dead then it tries to add fixative by placing it into the 20 plane defined by FixativeMask2. Note that if both FixativeMaskl and FixativeMask2 are both all Os then the dot data will not be changed. 30 Dotline Writer Unit (DWU) 30.1 OVERVIEW The Dotline Writer Unit (DWU) receives 1 dot (6 bits) of color information per cycle from the DNC. 25 Dot data received is bundled into 256-bit words and transferred to the DRAM. The DWU (in conjunction with the LLU) implements a dot line FIFO mechanism to compensate for the physical placement of nozzles in a printhead, and provides data rate smoothing to allow for local complexities in the dot data generate pipeline.
WO 2004/050369 PCT/AU2003/001616 517 30.2 PHYSICAL REQUIREMENT IMPOSED BY THE PRINTHEAD The physical placement of nozzles in the printhead means that in one firing sequence of all nozzles, dots will be produced over several print lines. The printhead consists of 12 rows of nozzles, one for each color of odd and even dots. Odd and even nozzles are separated by D 2 5 print lines and nozzles of different colors are separated by D 1 print lines. See Figure 254 for reference. The first color to be printed is the first row of nozzles encountered by the incoming paper. In the example this is color 0 odd, although is dependent on the printhead type (see [10] for other printhead arrangments). Paper passes under printhead moving downwards. For example if the physical separation of each half row is 80pm equating to D 1
=D
2 =5 print lines at 10 1600dpi. This means that in one firing sequence, color 0 odd nozzles will fire on dotline L, color 0 even nozzles will fire on dotline L-D 1 , color 1 odd nozzles will fire on dotline L-D-D 2 and so on over 6 color planes odd and even nozzles. The total number of lines fired over is given as 0+5+5.....+5= 0 + 1 1x5 =55. See Figure 255 for example diagram. It is expected that the physical spacing of the printhead nozzles will be 80gm (or 5 dot lines), 15 although there is no dependency on nozzle spacing. The DWU is configurable to allow other line nozzle spacings. Table 204. Relationship between Nozzle color/sense and line firing Color Even line encountered first Odd line encountered first Sense line sense line Color 0 Even L even L-5 Odd L-5 odd L Color 1 Even L-1 0 even L-1 5 Odd L-15 odd L-10 Color 2 Even L-20 even L-25 Odd L-25 odd L-20 Color 3 Even L-30 even L-35 Odd L-35 odd L-30 Color 4 Even L-40 even L-45 Odd L-45 odd L-40 Color 5 Even L-50 even L-55 Odd L-55 odd L-50 30.3 LINE RATE DE-COUPLING 20 The DWU block is required to compensate for the physical spacing between lines of nozzles. It does this by storing dot lines in a FIFO (in DRAM) until such time as they are required by the LLU for dot data transfer to the printhead interface. Colors are stored separately because they are needed at different times by the LLU. The dot line store must store enough lines to compensate for the physical line separation of the printhead but can optionally store more lines to allow system WO 2004/050369 PCT/AU2003/001616 518 level data rate variation between the read (printhead feed) and write sides (dot data generation pipeline) of the FIFOs. A logical representation of the FIFOs is shown in Figure 256, where N is defined as the optional number of extra half lines in the dot line store for data rate de-coupling. 5 30.4 DOT LINE STORE STORAGE REQUIREMENTS For an arbitrary page width of d dots (where d is even), the number of dots per half line is d/2. For interline spacing of D2 and inter-color spacing of D1, with C colors of odd and even half lines, the number of half line storage is (C - 1) (D 2
+D
1 ) + D1. For N extra half line stores for each color odd and even, the storage is given by (N * C * 2). 10 The total storage requirement is ((C - 1) (D2+D1) + D1 + (N * C * 2)) * d/2 in bits. Note that when determining the storage requirements for the dot line store, the number of dots per line is the page width and not necessarily the printhead width. The page width is often the dot margin number of dots less than the printhead width. They can be the same size for full bleed printing. 15 For example in an A4 page a line consists of 13824 dots at 1600 dpi, or 6912 dots per half dot line. To store just enough dot lines to account for an inter-line nozzle spacing of 5 dot lines it would take 55 half dot lines for color 5 odd, 50 dot lines for color 5 even and so on, giving 55+50+45... 10+5+0= 330 half dot lines in total. If it is assumed that N=4 then the storage required to store 4 extra half lines per color is 4 x 12=48, in total giving 330+48=378 half dot lines. Each 20 half dot line is 6912 dots, at I bit per dot give a total storage requirement of 6912 dots x 378 half dot lines / 8 bits = Approx 319 Kbytes. Similarly for an A3 size page with 19488 dots per line, 9744 dots per half line x 378 half dot lines / 8 = Approx 899 Kbytes. Table 205. Storage requirement for dot line store Page size Nozzle Lines required (N=0) Storage (N=0) Lines required Storage (N=4) Spacing Kbytes (N=4) Kbytes A4 4 264 223 312 263 5 330 278 378 319 A3 4 264 628 312 742 5 330 785 378 899 25 The potential size of the dot line store makes it unfeasible to be implemented in on-chip SRAM, requiring the dot line store to be implemented in embedded DRAM. This allows a configurable dotline store where unused storage can be redistributed for use by other parts of the system. 30.5 NOZZLE ROW SKEW Due to construction limitations of the bi-lithic printhead it is possible that nozzle rows may be 30 misaligned relative to each other. Odd and even rows, and adjacent color rows may be horizontally misaligned by up to 2 dot positions. Vertical misalignment can also occur but is compensated for in the LLU and not considered here. The DWU is required to compensate for the horizontal misalignment.
WO 2004/050369 PCT/AU2003/001616 519 Dot data from the HCU (through the DNC) produces a dot of 6 colors all destined for the same physical location on paper. If the nozzle rows in the printhead are aligned as shown in Figure 254 then no adjustment of the dot data is needed. A conceptual misaligned printhead is shown in Figure 257. The exact shape of the row alignment 5 is arbitrary, although is most likely to be sloping (if sloping, it could be sloping in either direction). The DWU is required to adjust the shape of the dot streams to take account of the join between printhead ICs. The introduction of the join shape before the data is written to the DRAM means that the PHI sees a single crossover point in the data since all lines are the same length and the crossover point (since all rows are of equal length) is a vertical line - i.e. the crossover is at the 10 same time for all even rows, and at the same time for all odd rows as shown in Figure 258. To insert the shape of the join into the dot stream, for each line we must first insert the dots for non-printable area 1, then the printable area data (from the DNC), and then finally the dots for non-printable area 2. This can also be considered as: first produce the dots for non-printable area I for line n, and then a repetition of: 15 e produce the dots for the printable area for line n (from the DNC) e produce the dots for the non-printable area 2 (for line n) followed by the dots of non printable area 1 (for line n+1) The reason for considering the problem this way is that regardless of the shape of the join, the shape of non-printable area 2 merged with the shape of non-printable area 1 will always be a 20 rectangle since the widths of non-printable areas I and 2 are identical and the lengths of each row are identical. Hence step 2 can be accomplished by simply inserting a constant number (MaxNozzleSkew) of 0 dots into the stream. For example, if the color n even row non-printable area 1 is of length X, then the length of color n even row non-printable area 2 will be of length MaxNozzleSkew -X. The split between non 25 printable areas 1 and 2 is defined by the NozzleSkew registers. Data from the DNC is destined for the printable area only, the DWU must generate the data destined for the non-printable areas, and insert DNC dot data correctly into the dot data stream before writing dot data to the fifos. The DWU inserts the shape of the misalignment into the dot stream by delaying dot data destined to different nozzle rows by the relative misalignment skew 30 amount. 30.6 LOCAL BUFFERING An embedded DRAM is expected to be of the order of 256 bits wide, which results in 27 words per half line of an A4 page, and 54 words per half line of A3. This requires 27 words x 12 half colors (6 colors odd and even) = 324 x 256-bit DRAM accesses over a dotline print time, equating to 6 35 bits per cycle (equal to DNC generate rate of 6 bits per cycle). Each half color is required to be double buffered, while filling one buffer the other buffer is being written to DRAM. This results in 256 bits x 2 buffers x 12 half colors i.e. 6144 bits in total. The buffer requirement can be reduced, by using 1.5 buffering, where the DWU is filling 128 bits while the remaining 256 bits are being written to DRAM. While this reduces the required buffering 40 locally it increases the peak bandwidth requirement to the DRAM. With 2x buffering the average WO 2004/050369 PCT/AU2003/001616 520 and peak DRAM bandwidth requirement is the same and is 6 bits per cycle, alternatively with 1.5x buffering the average DRAM bandwidth requirement is 6 bits per cycle but the peak bandwidth requirement is 12 bits per cycle. The amount of buffering used will depend on the DRAM bandwidth available to the DWU unit. 5 Should the DWU fail to get the required DRAM access within the specified time, the DWU will stall the DNC data generation. The DWU will issue the stall in sufficient time for the DNC to respond and still not cause a FIFO overrun. Should the stall persist for a sufficiently long time, the PHI will be starved of data and be unable to deliver data to the printhead in time. The sizing of the dotline store FIFO and internal FIFOs should be chosen so as to prevent such a stall happening. 10 30.7 DOTLINE DATA IN MEMORY The dot data shift register order in the printhead is shown in Figure 254 (the transmit order is the opposite of the shift register order). In the example the type 0 printhead IC transmit order is increasing even color data followed by decreasing odd color data. The type 1 printhead IC transmit order is decreasing odd color data followed by increasing even color data. For both 15 printhead ICs the even data is always increasing order and odd data is always decreasing. The PHI controls which printhead IC data gets shifted to. From this it is beneficial to store even data in increasing order in DRAM and odd data in decreasing order. While this order suits the example printhead, other printheads exist where it would be beneficial to store even data in decreasing order, and odd data in increasing order, 20 hence the order is configurable. The order that data is stored in memory is controlled by setting the ColorLineSense register. The dot order in DRAM for increasing and decreasing sense is shown in Figure 260 and Figure 261 respectively. For each line in the dot store the order is the same (although for odd lines the numbering will be different the order will remain the same). Dot data from the DNC is always 25 received in increasing dot number order. For increasing sense dot data is bundled into 256-bit words and written in increasing order in DRAM, word 0 first, then word 1, and so on to word N, where N is the number of words in a line. For decreasing sense dot data is also bundled into 256-bit words, but is written to DRAM in decreasing order, i.e. word N is written first then word N-1 and so on to word 0. For both 30 increasing and decreasing sense the data is aligned to bit 0 of a word, i.e. increasing sense always starts at bit 0, decreasing sense always finishes at bit 0. Each half color is configured independently of any other color. The ColorBaseAdr register specifies the position where data for a particular dotline FIFO will begin writing to. Note that for increasing sense colors the ColorBaseAdr register specifies the address of the first word of first 35 line of the fifo, whereas for decreasing sense colors the ColorBaseAdr register specifies the address of last word of the first line of the FIFO. Dot data received from the DNC is bundled in 256-bit words and transferred to the DRAM. Each line of data is stored consecutively in DRAM, with each line separated by ColorLinelnc number of words.
WO 2004/050369 PCT/AU2003/001616 521 For each line stored in DRAM the DWU increments the line count and calculates the DRAM address for the next line to store. This process continues until ColorFifoSize number of lines are stored, after which the DRAM address will wrap back to the ColorBaseAdr address. 5 As each line is written to the FIFO, the DWU increments the FifoFi/Level register, and as the LLU reads a line from the FIFO the FifoFil/Level register is decremented. The LLU indicates that it has completed reading a line by a high pulse on the //u_dwu_linerd line. When the number of lines stored in the FIFO is equal to the MaxWriteAhead value the DWU will indicate to the DNC that it is no longer able to receive data (i.e. a stall) by deasserting the 10 dwudnc ready signal. The ColorEnable register determines which color planes should be processed, if a plane is turned off, data is ignored for that plane and no DRAM accesses for that plane are generated. 30.8 SPECIFYING DOT FIFOs The dot line FIFOs when accessed by the LLU are specified differently than when accessed by 15 the DWU. The DWU uses a start address and number of lines value to specify a dot FIFO, the LLU uses a start and end address for each dot FIFO. The mechanisms differ to allow more efficient implementations in each block. As a result of limitations in the LLU the dot FIFOs must be specified contiguously and increasing in DRAM. See section 31.6 on page 537 for further information. 20 30.9 IMPLEMENTATION 30.9.1 Definitions of 1/O Table 206. DWU I/O Definition Port name Pins 1/O Description Clocks and Resets Pclk 1 In System Clock prstn I In System reset, synchronous active low DNC Interface dwu dnc ready 1 Out Indicates that DWU is ready to accept data from the DNC. dncdwuavail 1 In Indicates valid data present on dnc_dwu data. dncdwu data[5:0] 6 In Input bi-level dot data in 6 ink planes. LLU Interface dwu llu line wr 1 Out DWU line write. Indicates that the DWU has completed a full line write. Active high Ilfu dwu line rd 1 In LLU line read. Indicates that the LLU has completed a line read. Active high. PCU Interface pcudwusel 1 In Block select from the PCU. When pcu dwu sel is WO 2004/050369 PCT/AU2003/001616 522 high both pcu adr and pcu dataout are valid. pcu-rwn 1 In Common read/not-write signal from the PCU. pcu-adr[7:2] 6 In PCU address bus. Only 6 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. dwupcurdy I Out Ready signal to the PCU. When dwu pcu_rdy is high it indicates the last cycle of the access. For a write cycle this means pcu dataout has been registered by the block and for a read cycle this means the data on dwupcu datain is valid. dwupcu-datain[31:0] 32 Out Read data bus to the PCU. DIU Interface dwu diu-wreq 1 Out DWU requests DRAM write. A write request must be accompanied by a valid write address together with valid write data and a write valid. dwu-diu-wadr[21:5] 17 Out Write address to DIU 17 bits wide (256-bit aligned word) diu dwu-wack I In Acknowledge from DIU that write request has been accepted and new write address can be placed on dwu diuwadr dwu-diu-data[63:0] 64 Out Data from DWU to DIU. 256-bit word transfer over 4 cycles First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word Third 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word dwudiuwvalid 1 Out Signal from DWU indicating that data on dwu diu data is valid. 30.9.2 DWU partition 30.9.3 Configuration registers The configuration registers in the DWU are programmed via the PCU interface. Refer to section 21.8.2 on page 351 for a description of the protocol and timing diagrams for reading and writing 5 registers in the DWU. Note that since addresses in SoPEC are byte aligned and the PCU only supports 32-bit register reads and writes, the lower 2 bits of the PCU address bus are not required to decode the address space for the DWU. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of dwu pcu data. Table 207 lists the configuration registers in the DWU. 10 Table 207. DWU registers description WO 2004/050369 PCT/AU2003/001616 523 Address Reg!ster #bits Reset description DWUbase+ Control Registers Ox00 Reset 1 0xI Active low synchronous reset, self de activating. A write to this register will cause a DWU block reset. 0x04 Go I Ox0 Active high bit indicating the DWU is programmed and ready to use. A low to high transition will cause DWU block internal states to reset (configuration registers are not reset). Dot Line Store Configuration 0x08.- Ox34 ColorBaseA 12x1 7 OxOOO 00 Specifies the base address (in words) in dr[l 1:0][21: memory where data from a particular 5] half color (N) will be placed. For increasing sense colors the ColorBase Adr register specifies the address of the first word of first line of the fifo, whereas for decreasing sense colors the ColorBaseAdr register specifies .the address of last word of the first line of the fifo. Ox38 - Ox64 ColorFifoSiz 12x8 Ox00 Indicates the number of lines in the e(l 1:0] FIFO before the line increment will wrap around in memory. Bus 0,1 - Even, Odd line color 0 Bus 2,3 - Even, Odd line color 1 Bus 4,5 - Even, Odd line color 2 Bus 6,7 - Even, Odd line color 3 Bus 8,9 - Even, Odd line color 4 Bus 10,11 - Even, Odd line color 5 0x68 ColorLineSe 2 x2 Specifies whether data written to DRAM nse for this half color is increasing or decreasing sense 0 - Decreasing sense 1 - Increasing sense Bit 0 Defines even color sense, Bit 1 Defines odd color sense. Ox6C ColorEnable 6 Ox3F indicates whether a particular color is WO 2004/050369 PCT/AU2003/001616 524 active or not. When inactive no data is written to DRAM for that color. 0 - Color off I - Color on One bit per color, bit 0 is Color 0 and so on. 0x70 MaxWriteAh 8 0x00 Specifies the maximum number of lines ead that the DWU can be ahead of the LLU 0x74 LineSize 16 OxOO 0 Indicates the number of dots per line produced by the DWU. Ox78 MaxNozzle 4 Ox0 Specifies the number of dot-pairs the Skew DWU needs to generate to flush the data skew buffers. Corresponds to the non-printable area of the printhead. Ox7C - OxA8 NozzleSkew 12x4 OxO Specifies the relative skew of dot data nozzle rows in the printhead. Valid range is 0 (no skew) through to 12. Units represent dot-pairs, a skew of 1 for a row represents two dots on the page. Bus 0,1 - Even, Odd line color 0 Bus 2,3 - Even, Odd line color 1 Bus 4,5 - Even, Odd line color 2 Bus 6,7 - Even, Odd line color 3 Bus 8,9 - Even, Odd line color 4 Bus 10,11 - Even, Odd line color 5 OxAC ColorLineln 8 Ox00 Specifies the number of words (256-bit c words) per dot line - 1. Working Registers 0xBO LineDotCnt 16 OxOO 0 Indicates the number of remaining dots in the current line. (Read Only) OxB4 FifoFilILevel 8 Ox00 Number of lines in the FIFO, written to but not read. (Read Only) A low to high transition of the Go register causes the internal states of the DWU to be reset. All configuration registers will remain the same. The block indicates the transition to other blocks via the dwugopulse signal. 30.9.4 Data skew 5 The data skew block inserts the shape of the printhead join into the dot data stream by delaying dot data by the relative nozzle skew amount (given by nozzleskew). It generates zero fill data WO 2004/050369 PCT/AU2003/001616 525 introduced introduced into the dot data stream to achieve the relative skew (and also to flush dot data from the delay registers). The data skew block consists of 12 12-bit shift registers, one per color odd and even. The shift registers are in groups of 6, one group for even colors, and one for odd colors. Each time a valid 5 data word is received from the DNC the dot data is shifted into either the odd or even group of shift registers. The oddevensel register determines which group of shift registers are valid for that cycle and alternates for each new valid data word. When a valid word is received for a group of shift registers, the shift register is shifted by one location with the new data word shifted into the registers (the top word in the register will be discarded). 10 When the dot counter determines that the data skew block should zero fill (zero fill), the data skew block will shift zero dot data into the shift registers until the line has completed. During this time the DNC will be stalled by the de-assertion of the dwudncready signal. The data skew block selects dot data from the shift registers and is passed to the buffer address generator block. The data bits selected is determined by the configured index values in the 15 NozzleSkew registers. // determine when data is valid data-valid = (((dnc dwu avail == 1)OR(zero fill == 1)) AND (dwu ready ==l)) // implement the zero fill mux 20 if (zero-fill == 1) then dot data in = 0 else dot data in dnc dwu data // the data delay buffers 25 if (dwugo-pulse ==1) then data delay[1:0] [11:0) [5:01 = 0 // reset all delay buffer odd=l,even=O odd-even sel = 0 elsif (data valid == 1) then { 30 odd even sel = -odd even sel // update the odd/even buffers, with shift datadelay [odd evensel] [11:l1 [5:01= data delay[oddevensel] [10:0] [5:0] // shift data datadelay[odd evensel] [0] [5:0] = dot data in[5:0] 35 // shift in new data // select the correct output data for (i=0;i<6; i++) { // skew selector skew = nozzleskew[ {i,odd evensel} ] 40 // temporary variable WO 2004/050369 PCT/AU2003/001616 526 // data select array, include data delay and input dot data dataselect[12:0] = {data delay[odd evensel] [11:0], dotdatain} 5 // mux output the data word to next block (13 to 1 mux) dot-data[i] = data select[skew] [i] } 10 30.9.5 Fifo fill level The DWU keeps a running total of the number of lines in the dot store FIFO. Each time the DWU writes a line to DRAM (determined by the DIU interface subblock and signalled via linewr) it increments the fi/level and signals the line increment to the LLU (pulse on dwullu_linewr). Conversely if it receives an active flu_dwu_line rd pulse from the LLU, the fil/level is 15 decremented. If the f/i/level increases to the programmed max level (max write-ahead) then the DWU stalls and indicates back to the DNC by de-asserting the dwudncready signal. If one or more of the DIU buffers fill, the DIU interface signals the fill level logic via the buffu// signal which in turn causes the DWU to de-assert the dwudncready signal to stall the DNC. The buf full signals will remain active until the DIU services a pending request from the full buffer, 20 reducing the buffer level. When the dot counter block detects that it needs to insert zero fill dots (zero-fill equals 1) the DWU will stall the DNC while the zero dots are being generated (by de-asserting dwudnc ready), but will allow the data skew block to generate zero fill data (the dwuready signal). 25 dwudncready = -((buffull== 1) OR (filllevel == max write ahead ) OR (zero fill == 1)) dwuready -((buffull== 1) OR (filllevel == max write ahead )) The DWU does not increment the fill level until a complete line of dot data is in DRAM not just a 30 complete line received from the DNC. This ensures that the LLU cannot start reading a partial line from DRAM before the DWU has finished writing the line. The fill level is reset to zero each time a new page is started, on receiving a pulse via the dwu gopulse signal. The line fifo fill level can be read by the CPU via the PCU at any time by accessing the 35 FifoFillLevel register. 30.9.6 Buffer address generator 30.9.6.1 Buffer address generator description The buffer address generator subblock is responsible for accepting data from the data skew block and writing it to the DIU buffers in the correct order.
WO 2004/050369 PCT/AU2003/001616 527 The buffer address and active bit-write for a particular dot data write is calculated by the buffer address generator based on the dot count of the current line, programmed sense of the color and the line size. All configuration registers should be programmed while the Go bit is set to zero, once complete 5 the block can be enabled by setting the Go bit to one. The transition from zero to one will cause the internal states to reset. If the colorlinesense signal for a color is one (i.e. increasing) then the bit-write generation is straight forward as dot data is aligned with a 256-bit boundary. So for the first dot in that color, the bit 0 of the wrbit bus will be active (in buffer word 0), for the second dot bit 1 is active and so on 10 to the 25 5 th dot where bit 63 is active (in buffer word 3). This is repeated for all 256-bit words until the final word where only a partial number of bits are written before the word is transferred to DRAM. If colorline-sense signal for a color is zero (i.e. decreasing) the bit-write generation for that color is adjusted by an offset calculated from the pre-programmed line length (linesize). The offset 15 adjusts the bit write to allow the line to finish on a 256-bit boundary. For example if the line length was 400, for the first dot received bit 7 (line length is halved because of odd/even lines of color) of the wrbit is active (buffer word 3), the second bit 6 (buffer word 3), to the 2 0 0 1h dot of data with bit 0 of wr bit active (buffer word 0). 30.9.6.2 Bit-write decode 20 The buffer address generator contains 2 instances of the bit-write decode, one configured for odd dot data the other for even. The counter (either up or down counter) used to generate the addresses is selected by the colorlinesense signal. Each block determines if it is active on this cycle by comparing its configured type with the current dot count address and the dataactive signal. 25 The wr bit bus is a direct decoding of the lower 6 count bits (count[6:1]), and the DIU buffer address is the remaining higher bits of the counter (count[10:7]). The signal generation is given as follows: // determine the counter to use if (color line sense == 1 30 count = upcnt[10:0] else count = dn cnt [10:01 // determine if active, based on instance type wr-en = data-active & (count [o] ^ odd-even type) 35 // odd =1, even =D // determine the bit write value wr bit[63:0] = decode(count[6:1]) // determine the buffer 64-bit address wr adr[3:01 count[10:7] 40 30.9.6.3 Up counter generator WO 2004/050369 PCT/AU2003/001616 528 The up counter increments for each new dot and is used to determine the write position of the dot in the DIU buffers for increasing sense data. At the end of each line of dot data (as indicated by line-fin), the counter is rounded up to the nearest 256-bit word boundary. This causes the DIU buffers to be flushed to DRAM including any partially filled 256-bit words. The counter is reset to 5 zero if the dwugopulse is one. // Up-Counter Logic if (dwu-gopulse == 1) then { upcnt[10:0] = 0 10 elsif (line fin == 1 ) then // round up if (up cnt[8:1] 1= 0) upcnt [10:91 ++ else 15 upcnt[10:9] // bit-selector up cnt [7:0]=0 elsif (data valid == 1) then up cnt [7:0]++ 20 30.9.6.4 Down counter generator The down counter logic decrements for each new dot and is used to determine the write position of the dot in the DUI buffers for decreasing sense data. When the dwu go.pulse bit is one the lower bits (i.e. 8 to 0) of the counter are reset to line size value (/ine size), and the higher bits to 25 zero. The bits used to determine the bit-write values and 64-bit word addresses in the DIU buffers begin at line size and count down to zero. The remaining higher bits are used to determine the DIU buffer 256-bit address and buffer fill level, begin at zero and count up. The counter is active when valid dot data is present, i.e. datavalid equals 1. When the end of line is detected (line-fin equals 1) the counter is rounded to the next 256-bit 30 word, and the lower bits are reset to the line size value. //Down-Counter Logic if (dwugopulse == 1) then dn cnt[8:0] = line size[8:0] dn cnt[10:9] = 0 35 elsif (line fin == I ) then // perform rounding up if (dn cnt[8:1] 1= 0) dn cnt [10: 9]++ else 40 dn cnt[10:9] WO 2004/050369 PCT/AU2003/001616 529 // bit-select is reset dn_cnt[8:0]=line_size[8:0] // bit select bits elsif (data valid == 1) then dn cnt[8:0] - 5 dn cnt[lo:9]++ 30.9.6.5 Dot counter The dot counter simply counts each active dot received from the data skew block. It sets the counter to linesize and decrements each time a valid dot is received. When the count equals 10 zero the line-fin signal is pulsed and the counter is reset to linesize. When the count is less than the max nozzle skew * 2 value the dot counter indicates to the data skew block to zero fill the remainder of the line (via the zero fill signal). Note that the maxnozzle_skew units are dot-pairs as opposed to dots, hence the by 2 multiplication for comparison with the dot counter. 15 The counter is reset to linesize when dwugo_pulse is 1. 30.9.7 DIU buffer The DIU buffer is a 64 bit x 8 word dual port register array with bit write capability. The buffer could be implemented with flip-flops should it prove more efficient. 30.9.8 DIU interface 20 30.9.8.1 DIU interface general description The DIU interface determines when a buffer needs a data word to be transferred to DRAM. It generates the DRAM address based on the dot line position, the color base address and the other programmed parameters. A write request is made to DRAM and when acknowledged a 256-bit data word is transferred. The interface determines if further words need to be transferred and 25 repeats the transfer process. If the FIFO in DRAM has reached its maximum level, or one of the buffers has temporarily filled, the DWU will stall data generation from the DNC. A similar process is repeated for each line until the end of page is reached. At the end of a page the CPU is required to reset the internal state of the block before the next page can be printed. A 30 low to high transition of the Go register will cause the internal block reset, which causes all registers in the block to reset with the exception of the configuration registers. The transition is indicated to subblocks by a pulse on dwu_gopulse signal. 30.9.8.2 Interface controller The interface controller state machine waits in Idle state until an active request is indicated by the 35 read pointer (via the reqactive signal). When an active request is received the machine proceeds to the ColorSelect state to determine which buffers need a data transfer. In the ColorSelect state it cycles through each color and determines if the color is enabled (and consequently the buffer needs servicing), if enabled it jumps to the Request state, otherwise the colorcnt is incremented and the next color is checked.
WO 2004/050369 PCT/AU2003/001616 530 In the Request state the machine issues a write request to the DIU and waits in the Request state until the write request is acknowledged by the DIU (diu_dwuwack). Once an acknowledge is received the state machine clocks through 4 cycles transferring 64-bit data words each cycle and incrementing the corresponding buffer read address. After transferring the data to the DIU the 5 machine returns to the ColorSelect state to determine if further buffers need servicing. On the transition the controller indicates to the address generator (adr update) to update the address for that selected color. If all colors are transferred (color cnt equal to 6) the state machine returns to Idle, updating the last word flags (group fin) and request logic (requpdate). 10 The dwudiu wvalid signal is a delayed version of the bufrden signal to allow for pipeline delays between data leaving the buffer and being clocked through to the DIU block. The state machine will return from any state to Idle if the reset or the dwu go pulse is 1. 30.9.8.3 Address generator The address generator block maintains 12 pointers (color adr[1 1:0]) to DRAM corresponding to 15 current write address in the dot line store for each half color. When a DRAM transfer occurs the address pointer is used first and then updated for the next transfer for that color. The pointer used is selected by the reqsel bus, and the pointer update is initiated by the adr update signal from the interface controller. The pointer update is dependent on the sense of the color of that pointer, the pointer position in a 20 line and the line position in the FIFO. The programming of the colorbaseadr needs to be adjusted depending of the sense of the colors. For increasing sense colors the colorbaseadr specifies the address of the first word of first line of the fifo, whereas for decreasing sense colors the colorbaseadr specifies the address of last word of the first line of the FIFO. For increasing colors, the initialization value (i.e. when dwu go pulse is 1) is the colorbaseadr. 25 For each word that is written to DRAM the pointer is incremented. If the word is the last word in a line (as indicated by last wd from that read pointers) the pointer is also incremented. If the word is the last word in a line, and the line is the last line in the FIFO (indicated by fifoend from the line counter) the pointer is reset to colorbaseadr. In the case of decreasing sense colors, the initialization value (i.e. when dwugo-pulse is 1) is the 30 colorbaseadr. For each line of decreasing sense color data the pointer starts at the line end and decrements to the line start. For each word that is written to DRAM the pointer is decremented. If the word is the last word in a line the pointer is incremented by colorlineinc * 2 + 1. One line length to account for the line of data just written, and another line length for the next line to be written. If the word is the last word in a line, and the line is the last line in the FIFO the pointer is 35 reset to the initialization value (i.e. colorbase adr). The address is calculated as follows: if (dwugoypulse == 1) then color adr[11:0] = color base adr[11:0] [21:5] 40 elsif (adr_update == 1) then { WO 2004/050369 PCT/AU2003/001616 531 // determine the color color = req sel[3:0] // line end and fifo wrap if ((fifo _end[color] == 1) AND (last wd == 1)) then { 5 // line end and fifo wrap color adr[color] = color base adr[color] [21:5] } elsif ( lastwd == 1) then { // just a line end no fifo wrap 10 if (color line sense [color -2] == 1) then // increasing sense color adr[color] ++ else // decreasing sense 15 color adr[color] = color adr[color] + color line inc * 2) + 1 } else { // regular word write 20 if (colorline sense [color % 2] == 1) then // increasing sense color adr[color]++ else // decreasing sense color adr[color]- 25 ) // select the correct address, for this transfer dwu diu wadr = coloradr[reg sel] 30.9.8.4 Line count 30 The line counter logic counts the number of dot data lines stored in DRAM for each color. A separate pointer is maintained for each color. A line pointer is updated dach time the final word of a line is transferred to DRAM. This is determined by a combination of adr update and lastwd signals. The pointer to update is indicated by the reqsel bus. When an update occurs to a pointer it is compared to zero, if it is non-zero the count is 35 decremented, otherwise the counter is reset to colorfifosize. If a counter is zero the fifoend signals is set high to indicates to the address generator block that the line is the last line of this colors fifo. If the dwugopulse signal is one the counters are reset to colorfifosize. 40 if (dwugo pulse == 1) then line cnt[11:0] = color fifosize[11:O] WO 2004/050369 PCT/AU2003/001616 532 elsif ((adr update == 1) AND (lastwd == 1)) then { // determine the pointer to operate on color = req_sel [3:0] // update the pointer 5 if (line cnt[color] == 0) then line cnt[color] = color-fifo size[color] else line cnt[i] - } 10 // count is zero its the last line of fifo for(i=0 ;i <12;i++){ fifo end[i] = (line cnt[i] == 0) } 30.9.8.5 Read Pointer 15 The read pointer logic maintains the buffer read address pointers. The read pointer is used to determine which 64-bit words to read from the buffer for transfer to DRAM. The read pointer logic compares the read and write pointers of each DIU buffer to determine which buffers require data to be transferred to DRAM, and which buffers are full (the buf full signal). 20 Buffers are grouped into odd and even buffers groups. If an odd buffer requires DRAM access the odd spend signals will be active, if an even buffer requires DRAM access the even-pend signals will be active. If both odd and even buffers require DRAM access at exactly the same time, the even buffers will get serviced first. If a group of odd buffers are being serviced and an even buffer becomes pending, the odd group of buffers will be completed before the starting the even group, 25 and vice versa. If any buffer requires a DRAM transfer, the logic will indicate to the interface controller via the req active signal, with the oddevensel signal determining which group of buffers get serviced. The interface controller will check the color enable signal and issue DRAM transfers for all enabled colors in a group. When the transfers are complete it tells the read pointer logic to update 30 the requests pending via requpdate signal. The req se[3:0] signal tells the address generator which buffer is being serviced, it is constructed from the oddeven-set signal and the color cnt[2:0J bus from the interface controller. When data is being transferred to DRAM the word pointer and read pointer for the corresponding buffer are updated. The reqse/ determines which pointer should be incremented. 35 // determine if request is active even if ( wr adr[0] [3:2] != rd adr[0][3:2] evenpend = 1 else evenpend = 0 40 // determine it request is active odd WO 2004/050369 PCT/AU2003/001616 533 if ( wr adr[1] [3:2] != rd adr[l] [3:2] evenpend = 1 else evenpend = 0 5 // determine if any buffer is full if ((wr adr[0] [3:0] - rd adr[0] [3:0]) > 7)OR((wr adr [1][3:0] - rd adr[l [3:0])> 7)) then buf full = 1 // fixed servicing order, only update when controller 10 dictates so if (regupdate == 1) then if (evenpend == 1) then // even always first odd even sel = 0 req_active = 1 15 elsif (odd-pend == 1 ) then // then check odd odd even sel = 0 reqactive = 1 else // nothing active odd even sel = 0 20 req active = 0 // selected requestor req_sel[3:0] = {colorcnt[2:0] , oddeven sel} // concatentation 25 The read address pointer logic consists of 2 2-bit counters and a word select pointer. The pointers are reset when dwu gopulse is one. The word pointer (word ptr) is common to all buffers and is used to read out the 64-bit words from the DIU buffer. It is incremented when buf rd en is active. When a group of buffers are updated the state machine increments the read pointer (rd ptr[odd_evensell) via the group fin signal. A concatenation of the read pointer and the word 30 pointer are use to construct the buffer read address. The read pointers are not reset at the end of each line. // determine which pointer to update if (dwugo_pulse == 1) then rdptr[l:0] = 0 35 wordptr = 0 elsif (bufrd en == 1) then { word_ptr++ // word pointer update elsif (groupfin == 1) then rdptr[oddevensel]++ // update the read 40 pointer // create the address from the pointer,and word reader WO 2004/050369 PCT/AU2003/001616 534 rdadr [oddevensell = {rdptr [odd-evensel1 ,wordptr} // concatenation The read pointer block determines if the word being read from the DIU buffers is the last word of a line. The buffer address generator indicate the last dot is being written into the buffers via the 5 linefin signal. When received the logic marks the 256-bit word in the buffers as the last word. When the last word is read from the DIU buffer and transferred to DRAM, the flag for that word is reflected to the address generator. // line end set the flags if (dwugo-pulse == 1) then 10 last flag[1:0][i:0] = 0 elsif (line fin == 1 ) then // determines the current 256-bit word even been written to lastflag[0] [wradr[0] [2]] =1 / even group flag 15 // determines the current 256-bit word odd been written to last_flag[1] [wradr[l] [2]] = 1 // odd group flag // last word reflection to address generator lastwd = last_ flag[oddeven sell [rdptr[reqsel] [0]] // clear the flag 20 if (group-fin == 1 ) then lastflag [oddevensell [rdptr[regqsel] [0]] = 0 When a complete line has been written into the DIU buffers (but has not yet been transferred to DRAM), the buffer address generator block will pulse the line fin signal. The DWU must wait until 25 all enabled buffers are transferred to DRAM before signaling the LLU that a complete line is available in the dot line store (dwu_//u_linewr signal). When the finefin is received all buffers will require transfer to DRAM. Due to the arbitration, the even group will get serviced first then the odd. As a result the line finish pulse to the LLU is generated from the last flag of the odd group. // must be odd,odd group transfer complete and the last word 30 dwullu line wr = oddevensel AND group fin AND lastwd 31 Line Loader Unit (LLU) 31.1 OVERVIEW The Line Loader Unit (LLU) reads dot data from the line buffers in DRAM and structures the data into even and odd dot channels destined for the same print time. The blocks of dot data are 35 transferred to the PHI and then to the printhead. Figure 267 shows a high level data flow diagram of the LLU in context. 31.2 PHYSICAL REQUIREMENT IMPOSED BY THE PRINTHEAD The DWU re-orders dot data into 12 separate dot data line FIFOs in the DRAM. Each FIFO corresponds to 6 colors of odd and even data. The LLU reads the dot data line FIFOs and sends 40 the data to the printhead interface. The LLU decides when data should be read from the dot data WO 2004/050369 PCT/AU2003/001616 535 line FIFOs to correspond with the time that the particular nozzle on the printhead is passing the current line. The interaction of the DWU and LLU with the dot line FIFOs compensates for the physical spread of nozzles firing over several lines at once. For further explanation see Section 30 Dotline Writer Unit (DWU) and Section 32 PrintHead Interface (PHI). Figure 268 shows the 5 physical relationship of nozzle rows and the line time the LLU starts reading from the dot line store. Within each line of dot data the LLU is required to generate an even and odd dot data stream to the PHI block. Figure 269 shows the even and dot streams as they would map to an example bi lithic printhead. The PHI block determines which stream should be directed to which printhead IC. 10 31.3 DOT GENERATE AND TRANSMIT ORDER The structure of the printhead ICs dictate the dot transmit order to each printhead IC. The LLU reads data from the dot line FIFO, generates an even and odd dot stream which is then re ordered (in the PHI) into the transmit order for transfer to the printhead. The DWU separates dot data into even and odd half lines for each color and stores them in 15 DRAM. It can store odd or even dot data in increasing or decreasing order in DRAM. The order is programmable but for descriptive purposes assume even in increasing order and odd in decreasing order. The dot order structure in DRAM is shown in Figure 261. The LLU contains 2 dot generator units. Each dot generator reads dot data from DRAM and generates a stream of odd or even dots. The dot order may be increasing or decreasing 20 depending on how the DWU was programmed to write data to DRAM. An example of the even and odd dot data streams to DRAM is shown in Figure 270. In the example the odd dot generator is configured to produce odd dot data in decreasing order and the even dot generator produces dot data in increasing order. The PHI block accepts the even and odd dot data streams and reconstructs the streams into 25 transmit order to the printhead. The LLU line size refers to the page width in dots and not necessarily the printhead width. The page width is often the dot margin number of dots less than the printhead width. They can be the same size for full bleed printing. 31.4 LLU START-UP 30 At the start of a page the LLU must wait for the dot line store in DRAM to fill to a configured level (given by FifoReadThreshold) before starting to read dot data. Once the LLU starts processing dot data for a page it must continue until the end of a page, the DWU (and other PEP blocks in the pipeline) must ensure there is always data in the dot line store for the LLU to read, otherwise the LLU will stall, causing the PHI to stall and potentially generate a print error. The 35 FifoReadThreshold should be chosen to allow for data rate mismatches between the DWU write side and the LLU read side of the dot line FIFO. The LLU will not generate any dot data until FifoReadThreshold level in the dot line FIFO is reached. Once the FifoReadThreshold is reached the LLU begins page processing, the FifoReadThreshold is ignored from then on.
WO 2004/050369 PCT/AU2003/001616 536 When the LLU begins page processing it produces dot data for all colors (although some dot data color may be null data). The LLU compares the line count of the current page, when the line count exceeds the ColorRe/Line configured value for a particular color the LLU will start reading from that colors FIFO in DRAM. For colors that have not exceeded the ColorRe/Line value the LLU will 5 generate null data (zero data) and not read from DRAM for that color. ColorRe/Line[N specifies the number of lines separating the Nth half color and the first half color to print on that page. For the example printhead shown in Figure 268, color 0 odd will start at line 0, the remaining colors will all have null data. Color 0 odd will continue with real data until line 5, when color 0 odd and even will contain real data the remaining colors will contain null data. At line 10, color 0 odd 10 and even and color 1 odd will contain real data, with remaining colors containing null data. Every 5 lines a new half color will contain real data and the remaining half colors null data until line 55, when all colors will contain real data. In the example ColorRe/Line[0] =5, ColorRe/Line[1] =0, ColorRelLine[2] =15, ColorRelLine[3] =10 .. etc. It is possible to turn off any one of the color planes of data (via the ColorEnable register), in such 15 cases the LLU will generate zeroed dot data information to the PHI as normal but will not read data from the DRAM. 31.4.1 LLU bandwidth requirements The LLU is required to generate data for feeding to the printhead interface, the rate required is dependent on the printhead construction and on the line rate configured. The maximum data rate 20 the LLU can produce is 12 bits of dot data per cycle, but the PHI consumes at 12 bits every 2 pclk cycles out of 3, i.e. 8 bits per pclk cycle. Therefore the DRAM bandwidth requirement for a double buffered LLU is 8 bits per cycle on average. If 1.5 buffering is used then the peak bandwidth requirement is doubled to 16 bits per cycle but the average remains at 8 bits per cycle. Note that while the LLU and PHI could produce data at the 8 bits per cycle rate, the DWU can only produce 25 data at 6 bits per cycle rate. 31.5 VERTICAL ROW SKEW Due to construction limitations of the bi-lithic printhead it is possible that nozzle rows may be misaligned relative to each other. Odd and even rows, and adjacent color rows may be horizontally misaligned by up to 2 dot positions. Vertical misalignment can also occur between 30 both printhead ICs used to construct the printhead. The DWU compensates for the horizontal misalignment (see Section 30.5), and the LLU compensates for the vertical misalignment. For each color odd and even the LLU maintains 2 pointers into DRAM, one for feeding printhead A (CurrentPtrA) and other for feeding printhead B (CurrentPtrB). Both pointers are updated and incremented in exactly the same way, but differ in their initial value programming. They differ by 35 vertical skew number of lines, but point to the same relative position within a line. At the start of a line the LLU reads from the FIFO using CurrentPtrA until the join point between the printhead lCs is reached (specified by JoinPoint), after which the LLU reads from DRAM using CurrentPtrB. If the JoinPoint coincides with a 256-bit word boundary, the swap over from pointer A to pointer B is straightforward. If the JoinPoint is not on a 256-bit word boundary, the LLU must 40 read the 256-bit word of data from CurrentPtrA location, generate the dot data up to the join point WO 2004/050369 PCT/AU2003/001616 537 and then read the 256-bit word of data from CurrentPtrB location and generate dot data from the join point to the word end. This means that if the JoinPoint is not on a 256-bit boundary then the LLU is required to perform an extra read from DRAM at the join point and not increment the address pointers. 5 31.5.1 Dot line FIFO initialization For each dot line FIFO there are 2 pointers reading from it, each skewed by a number of dot lines in relation to the other (the skew amount could be positive or negative). Determining the exact number of valid lines in the dot line store is complicated by two pointers reading from different positions in the FIFO. It is convenient to remove the problem by pre-zeroing the dot line FIFOs 10 effectively removing the need to determine exact data validity. The dot FIFOs can be initialized in a number of ways, including * the CPU writing Os, e the LBD/SFU writing a set of 0 lines (16 bits per cycle), * the HCU/DNC/DWU being programmed to produce 0 data 15 31.6 SPECIFYING DOT FIFOs The dot line FIFOs when accessed by the LLU are specified differently than when accessed by the DWU. The DWU uses a start address and number of lines value to specify a dot FIFO, the LLU uses a start and end address for each dot FIFO. The mechanisms differ to allow more efficient implementations in each block. 20 The start address for each half color N is specified by the ColorBaseAdr[N] registers and the end address (actually the end address plus 1) is specified by the ColorBaseAdr[N+1]. Note there are 12 colors in total, 0 to 11, the ColorBaseAdr[12] register specifies the end of the color 11 dot FIFO and not the start of a new dot FIFO. As a result the dot FIFOs must be specified contiguously and increasing in DRAM. 25 31.7 IMPLEMENTATION 31.7.1 LLU partition 31.7.2 Definitions of 1/O Table 208. LLU I/O definition Port name Pins I/O Description Clocks and Resets Pclk 1 In System clock prst-n 1 In System reset, synchronous active low PHI Interface lluphi data[1:0][5:0] 2x6 Out Dot Data from LLU to the PHI, each bit is a color plane 5 downto 0. Bus 0 - Even dot data stream Bus I - Odd dot data stream Data is active when corresponding bit is activ WO 2004/050369 PCT/AU2003/001616 538 in I1u_phi avail bus phi-llu-ready[1:0] 2 In Indicates that PHI is ready to accept data from the LLU 0 - Even dot data stream I - Odd dot data stream Ilu phi avail[1:0] 2 Out Indicates valid data present on corresponding Iluphi_ data. 0 - Even dot data stream 1 - Odd dot data stream DIU Interface llu_diurreq 1 Out LLU requests DRAM read. A read request must be accompanied by a valid read address. llu_diuradr[21:5] 17 Out Read address to DIU 17 bits wide (256-bit aligned word). diullurack I In Acknowledge from DIU that read request has been accepted and new read address can be placed on I/u_diuradr diu-data[63:0] 64 In Data from DIU to LLU. Each access is 256-bits received over 4 clock cycles First 64-bits is bits 63:0 of 256 bit word Second 64-bits is bits 127:64 of 256 bit word Third 64-bits is bits 191:128 of 256 bit word Fourth 64-bits is bits 255:192 of 256 bit word diu_llurvalid 1 In Signal from DIU telling LLU that valid read data is on the diu data bus DWU Interface dwullulinewr 1 In DWU line write. Indicates that the DWU has completed a full line write. Active high lu_dwu linerd 1 Out LLU line read. Indicates that the LLU has completed a line read. Active high. PCU Interface pcuIlu-sel 1 In Block select from the PCU. When pcu fluse/ is high both pcu adr and pcu dataout are valid. pcu-rwn 1 In Common read/not-write signal from the PCU. pcu-adr[7:2] 6 In PCU address bus. Only 6 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. llu pcu-rdy 1 Out Ready signal to the PCU. When //upcurdy is high it indicates the last cycle of the access. For WO 2004/050369 PCT/AU2003/001616 539 a write cycle this means pcu dataout has been registered by the block and for a read cycle this means the data on llu_pcu datain is valid. ilupcu-datain[31:0] 32 Out Read data bus to the PCU. 31.7.3 Configuration registers The configuration registers in the LLU are programmed via the PCU interface. Refer to section 21.8.2 on page 351 for a description of the protocol and timing diagrams for reading and writing registers in the LLU. Note that since addresses in SoPEC are byte aligned and the PCU only 5 supports 32-bit register reads and writes, the lower 2 bits of the PCU address bus are not required to decode the address space for the LLU. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of /lupcudatain. Table 209 lists the configuration registers in the LLU. Table 209. LLU registers description 10 Address 'Register #bits Reset description LLU_base + Control Registers Ox00 Reset 1 OxI Active low synchronous reset, self de activating. A write to this register will cause a LLU block reset. 0x04 Go 1 Ox0 Active high bit indicating the LLU is programmed and ready to use. A low to high transition will cause LLU block internal states to reset. Configuration Ox08 - Ox38 ColorBaseAdr[1 2:0][ 13x1 7 OxOOO 00 Specifies the base address (in words) in 21:5] memory where data from a particular half color (N) will be placed. Also specifies the end address + 1 (256 bit words) in memory where fifo data for a particular half color ends. For color N the start address is ColorBaseAdr[N] and the end address +1 is ColorBase Adr[N+1] Ox3C ColorEnable 6 Ox3F Indicates whether a particular color is active or not. When inactive no data is written to DRAM for that color. 0 - Color off WO 2004/050369 PCT/AU2003/001616 540 1 - Color on One bit per color, bit 0 is Color 0 and so on. Ox40 LineSize 16 xOO 0 Indicates the number of dots per line. Ox44 FifoReadThreshold 8 Ox00 Specifies the number of lines that should be in the FIFO before the LLU starts reading. 0x48 - 0x74 ColorRelLine[1 1:0] 12x8 OxO Specifies the relative number of lines to wait from the first before starting to read dot data from the corresponding dot data FIFO Bus 0,1 - Even, Odd line color 0 Bus 2,3 - Even, Odd line color 1 Bus 4,5 - Even, Odd line color 2 Bus 6,7 - Even, Odd line color 3 Bus 8,9 - Even, Odd line color 4 Bus 10,11 - Even, Odd line color 5 0x78 - Ox7C JoinPoint 2x1 6 xOO 0 Specifies the join point in dots between both printhead ICs. Bus 0 - Even dot generator join point Bus 1 - Odd dot generator join point Ox80 - Ox84 JoinWord 2x8 Ox00 Specifies the join point in words between both printhead ICs. Bus 0 - Even dot generator join point Bus 1 - Odd dot generator join point Ox90-OxBC CurrentAdrA[11:0][2 12x17 0x000 0 Current Address pointers associated 1:5] with printhead A Bus 0,1 - Even, Odd line color 0 Bus 2,3 - Even, Odd line color 1 Bus 4,5 - Even, Odd line color 2 Bus 6,7 - Even, Odd line color 3 Bus 8,9 - Even, Odd line color 4 Bus 10,11 - Even, Odd line color 5 Working registers OxCO -CurrentAdrB[11:0][2 12x17 xOO 0 Current Address pointers associated OxEC 1:5] with printhead B Bus 0,1 - Even, Odd line color 0 Bus 2,3 - Even, Odd line color 1 Bus 4,5 - Even, Odd line color 2 WO 2004/050369 PCT/AU2003/001616 541 Bus 6,7 - Even, Odd line color 3 Bus 8,9 - Even, Odd line color 4 Bus 10,11 - Even, Odd line color 5 Working registers Working Registers OxFO FifoFillLevel 8 Ox00 Number of lines in the dot line FIFO, line written in but not read out. (Read Only) A low to high transition of the Go register causes the internal states of the LLU to be reset. All configuration registers will remain the same. The block indicates the transition to other blocks via the lugo.pulse signal. 31.7.4 Dot generator 5 The dot generator block is responsible for reading dot data from the DIU buffers and sending the dot data in the correct order to the PHI block. The dot generator waits for /u_en signal from the fifo fill level block, once active it starts reading data from the 6 DIU buffers and generating dot data for feeding to the PHI. In the LLU there are two instances of the dot generator, one generating odd data and the other 10 generating even data. At any time the ready bit from the PHI could be de-asserted, if this happens the dot generator will stop generating data, and wait for the ready bit to be re-asserted. 31.7.4.1 Dot count In normal operation the dot counter will wait for the //u_en and the ready to be active before 15 starting to count. The dot count will produce data as long as the phi _lu ready is active. If the phi llu ready signal goes low the count will be stalled. The dot counter increments for each dot that is processed per line. It is used to determine the line finish position, and the bit select value for reading from the DIU buffers. The counter is reset after each line is processed (line fin signal). It determines when a line is finished by comparing the dot 20 count with the configured line size divided by 2 (note that odd numbers of dots will be rounded down). // define the line finish if (dotcnt[14:0] == linesize[15:1] )then line fin = 1 25 else line fin = 0 // determine if word is valid dotactive = ( (lluen == 1) AND (phi_lluready == 1) AND (buf emp == 0)) 30 // counter logic if (llu-go-pulse == 1) then dot cnt = 0 elsif ((dot active == 1)AND (line-fin == 1)) then WO 2004/050369 PCT/AU2003/001616 542 dot cnt =0 elsif (dot-active == 1) then dot cnt = dot cnt + 1 else 5 dot cnt = dot cnt // calculate the word select bits bit sel[5:0] dotcnt[5:0] The dot generator also maintains a read buffer pointer which is incremented each time a 64-bit word is processed. The pointer is used to address the correct 64-bit dot data word withirithe DIU 10 buffers. The Fnter is reset when flu go_pulse is 1. Unlike the dot counter the read pointer is not reset each line but rounded up the nearest 256-bit word. This allows for more efficient use of the .DIU buffers at line finish. When the dot counter reaches the join point for the dot generator (joinpoint), it jumps to the next 256 bit word in the DIU buffer but continues to read from the next bit position within that word. If 15 the join point coincides with a word boundary, no 256-bit increment is required. // read pointer logic if (lluTgopulse == 1) then read-adr = 0 elsif ((dot active == 1)AND((dotcnt[7:01 == 255)OR(line fin 20 1)))then // end of line round up read adr[3:2] ++ read adr[1:0] = 0 elsif ((dotactive == 1)AND(dotcnt == 25 joinpoint)AND(dotcnt[5:01 == 63)) then // join point jump 256 bits read adr[1:0] ++ regular increment read adr[3:2] ++ // join 30 point 256 increment elsif ((dotactive == 1) AND(dotcnt == joinpoint)AND(dot_cnt[5:0] 1= 63)) then // join point jump 256 bits, bottom bits remain the same read adr[3:2] ++ // join 35 point 256 increment only elsif ((dotactive == 1)AND(dotcnt[5:0] == 63)) then read adr[3:01 ++ regular increment 31.7.5 Fifo fill level 40 The LLU keeps a running total of the number of lines in the dot line store FIFO. Every time the DWU signals a line end (dwulu_linewr active pulse) it inc events the filleve/. Conversely if the WO 2004/050369 PCT/AU2003/001616 543 LLU detects a line end (line rd pulse) the fillevel is decremented and the line read is signalled to the DWU via the //u_dwulinerd signal. The LLU fill level block is used to determine when the dot line has enough data stored before the LLU should begin to start reading. The LLU at page start is disabled. It waits for the DWU to write 5 lines to the dot line FIFO, and for the fill level to increase. The LLU remains disabled until the fill level has reached the programmed threshold (fifojead thres). When the threshold is reached it signals the LLU to start processing the page by setting lluen high. Once the LLU has started processing dot data for a page it will not stop if the fllevel falls below the threshold, but will stall is fililevel falls to zero. 10 The line fifo fill level can be read by the CPU via the PCU at any time by accessing the FifoFiLevel register. The CPU must toggle the Go register in the LLU for the block to be correctly initialized at page start and the fifo level reset to zero. if (llu go-pulse == 1) then 15 fillievel = 0 elsif ((line rd == 1) AND (dwu llu line wr == 1)) then // do nothing elsif (line rd == 1) then filllevel - 20 elsif (dwu llu line wr == 1), then filllevel ++ // determine the threshold, and set the LLU going if (llugopulse == 1) OR (filllevel == 0 )) then llu en = 0 25 elsif (filllevel == fifo readthreshold ) then llu en = 1 31.7.6 DIU interface 31.7.6.1 DIU interface description The DIU interface block is responsible for determining when dot data needs to be read from 30 DRAM, keeping the dot generators supplied with data and calculating the DRAM read address based on configured parameters, FIFO fill levels and position in a line. The fill level block enables DIU requests by activating Iuen signal. The DIU interface controller then issues requests to the DIU for the LLU buffers to be filled with dot line data (or fill the LLU buffers with null data without requesting DRAM access, if required). 35 At page start the DIU interface determines which buffers should be filled with null data and which should request DRAM access. New requests are issued until the dot line is completely read from DRAM. For each request to the DRAM the address generator calculates where in the DRAM the dot data should be read from. The colorenable bus determines which colors are enabled, the interface 40 never issues DRAM requests for disabled colors.
WO 2004/050369 PCT/AU2003/001616 544 31.7.6.2 Interface controller The interface controller co-ordinates and issues requests for data transfers from DRAM. The state machine waits in Idle state until it is enabled by the LLU controller (//uen) and a request for data transfer is received from the write pointer block. 5 When an active request is received (req active equals 1) the state machine jumps to the ColorSelect state to determine which colors (color cnt) in the group need a data transfer. A group is defined as all odd colors or all even colors. If the color isn't enabled (color enable) the count just increments, and no data is transferred. If the color is enabled, the state machine takes one of two options, either a null data transfer or an actual data transfer from DRAM. A null data transfer 10 writes zero data to the DIU buffer and does not issue a request to DRAM. The state machine determines if a null transfer is required by checking the color start signal for that color. If a null transfer is required the state machine doesn't need to issue a request to the DIU and so jumps directly to the data transfer states (DataO to Data3). The machine clocks through the 4 15 states each time writing a null 64-bit data word to the buffer. Once complete the state machine returns to the ColorSelect state to determine if further transfers are required. If the colorstart is active then a data transfer is required. The state machine jumps to the Request state and issue a request to the DIU controller for DRAM access by setting lufdiiurreq high. The DIU responds by acknowledging the request (diullurack equals 1) and then sending 4 20 64-bit words of data. The transition from Request to DataO state signals the address generator to update the address pointer (adr update). The state machine clocks through DataO to Data3 states each time writing the 64-bit data into the buffer selected by the req_sel bus. Once complete the state machine returns to the ColorSelect state to determine if further transfers are required. When in the ColorSelect state and all data transfers for colors in that group have been serviced 25 (i.e. when colorcnt is 6) the state machine will return to the Idle state. On transition it will update the word counter logic (word dec) and enabled the request logic (requpdate). A reset or llu_go_pulse set to 1 will cause the state machine to jump directly to Idle. The controller will remain in Idle state until it is enabled by the LLU controller via the lu_en signal. This prevents the DIU attempting the fill the DIU buffers before the dot line store FIFO has filled over its 30 threshold level. 31.7.6.3 Color activate The color activate logic maintains an absolute line count indicating the line number currently being processed by the LLU. The counter is reset when the llu_gopulse is 1 and incremented each time a line rd pulse is received. The count value (line cnt) is used to determine when to start 35 reading data for a color. The count is implemented as follows: it ( llugopulse == 1) then line cnt = 0 elsif ( line rd == 1) then 40 line cnt ++ WO 2004/050369 PCT/AU2003/001616 545 The color activate logic compares line count with the relative line value to determine when the LLU should start reading data from DRAM for a particular half color. It signals the interface controller block which colors are active for this dot line in a page (via the color start bus). It is used by the interface controller to determine which DIU buffers require null data. 5 Once the colorstart bit for a color is set it cannot be cleared in the normal page processing process. The bits must be reset by the CPU at the end of a page by transitioning the Go bit and causing a pulse on the lu go_pulse signal. Any color not enabled by the colorenable bus will never have its colorstart bit set. for (i=O; i<12;i++){ 10 if ( llu_go-pulse == 1) then col on[i] = 0 elsif ( colorenable[i %- 6] == 1 ) then col on[i] 0 elsif ( line cnt == color rel line[i]) then 15 col onli] = 1 } // select either odd or even colors if ( odd even sel == 1 ) then // odd selected color start[5:0] 20 {colon[11],colon[9],colon[7],col on[5],colon[3],colon[1 else // even selected color start[5:0] {colon[l0],col_on[8],colon[6],colon[4],colon[2],col_on[O 25 3) 31.7.6.4 Address generator The address generator block maintains 24 pointers (currentadra[11:0] and currentadr b[11:0]) to DRAM corresponding to 2 read addresses in the dot line FIFO for each half color. The 30 current adr a group of pointers are used when the dot generator is feeding printhead channel A, and the currentadr b group of pointers are used when the dot generator is feeding printhead channel B. For each DRAM access the 2 address pointers are updated but only one can be used for an access. The word counter block determines which pointer group should be used to access DRAM, via the pointer select signals (ptrsel). In certain cases (e.g. the join point is not 256-bit 35 aligned and the word is on the join point) the address pointers should not be updated for an access, the word counter block determines the exception cases and indicates to the address generator to skip the update via thejoin stall signal. When a DRAM transfer occurs the address pointer is used first and then updated for the next transfer for the color. The pointer used is selected by the req sel and ptr-sel buses, and the 40 pointer update is initiated by the adr update signal from the interface controller.
WO 2004/050369 PCT/AU2003/001616 546 The address update is calculated as follows (pointer group A logic is shown but the same logic is used to update the B pointer group a clock cycle later): // update the A pointers if (ptra-wren == 1) then // write from the 5 configuration block currentadr-a[ptr-adr] = ptrwr data; elsif ( adr updatea == 1) then { // address update from state machine if ((reqsel == NULL )OR (join stall 1)) then 10 // do nothing else // temporary variable setup nextadr = current adra[req_sel) + 1 startadr = colorbase adr[reqsel] 15 endadr = colorbaseadr[reqsel + 1] // determine how to update the pointer if (next adr == end adr) then currentadr_a[req_sel] = startadr else 20 currentadra[reqsell = nextadr } The correct address to use for a transfer is selected by the ptrsel signals from the word counter block. They indicate which set of address pointers should be used based on the current word being transferred from the DRAM and the configured join point values (join word). 25 // select the address pointer to use for access if (reqsel[01 == 1) then // odd pointer selector if (ptr-sel[l] == 1) then llu diuradr currentadr b[reqrsel] // latter part 30 of line else llu diu radr = current_adr_a [reg sel] // former part of line else // even 35 pointer selector if (ptr-sel[O] == 1) then llu-diuradr = currentadr_btreg sel) // latter part of line else 40 lludiu-radr = currentadr_a[rea sel) / former part of line WO 2004/050369 PCT/AU2003/001616 547 31.7.6.5 Write pointer The write pointer logic maintains the buffer write address pointers, determines when the DIU buffers need a data transfer and signals when the DIU buffers are empty. The write pointer 5 determines the address in the DIU buffer that the data should be transferred to. The write pointer logic compares the read and write pointers of each DIU buffer to determine which buffers require data to be transferred from DRAM, and which buffers are empty (the bufemp signals). Buffers are grouped into odd and even buffers, if an odd buffer requires DRAM access the 10 odd pend signals will be active, if an even buffer requires DRAM access the even pend signals will be active. If both odd and even buffers require DRAM access at exactly the same time, the even buffers will get serviced first. If a group of odd buffers are being serviced and an even buffer becomes pending, the odd group of buffers will be completed before the starting the even group, and vice versa. 15 If any buffer requires a DRAM transfer, the logic will indicate to the interface controller via the req active signal, with the odd evense/ signal determining which group of buffers get serviced. The interface controller will check the color enable signal and issue DRAM transfers for all enabled colors in a group. When the transfers are complete it tells the write pointer logic to update the request pending via req update signal. 20 The reqsel[3:0] signal tells the address generator which buffer is being serviced, it is constructed from the oddeven sel signal and the color cnt[2:0] bus from the interface controller. When data is being transferred to DRAM the word pointer and write pointer for the corresponding buffer are updated. The req_sel determines which pointer should be incremented. The write pointer logic operates the same way regardless of whether the transfer is null or not. 25 // determine which buffers need updates bufemp[1:0] = 0 oddpend = 0 evenpend = 0 30 if ( wradr[0] [3:2] == rdadr[0] [3:2] even_pend = 1 if ( wr adr[1] [3:2] = rd adr(1] [3:2] oddpend = 1 // determine if buffers are empty 35 if ((wradr[0] [3:0] rd adr[0] [3:0])) then bufemp [0] = 1 if ((wr adr[1] [3:0] == rd adr[1] [3:0])) then buf_emp[l] = 1 // fixed servicing order, only update when controller 40 dictates so WO 2004/050369 PCT/AU2003/001616 548 if (regupdate == 1) then if (even_pend == 1) then // even always first odd-even sel = 0 req_active = 1 5 elsif (odd-pend == 1 ) then // then check odd odd-even sel = 0 reqactive = 1 else // nothing active odd even sel = 0 10 reactive = 0 } // selected requestor reqsel[3:01 {color-cnt[2:0],oddevensel) // concatentation 15 The write address pointer logic consists of 2 2-bit counters and a word select pointer. The counters are reset when //u go pulse is one. The word pointer (word ptr) is common to all buffers and is used to write 64-bit words into the DIU buffer. It is incremented when bufrden is active. When a group of buffers are updated the state machine increments the write pointer 20 (wr ptr[oddeven sel]) via the group_ fin signal. A concatenation of the write pointer and the word pointer are use to construct the buffer write address. The write pointers are not reset at the end of each line. // determine which pointer to update 25 if (Ilu.go-pulse == 1) then wrptr[1:0] = 0 word_ptr = 0 elsif (bufrden == 1) then word_ptr++ 30 wrentres-sel] = 1 elsif (groupfin = 1 ) then wrptr[oddeven sel]++ // create the address from the write pointer and word 35 pointer wr adr[odd even sel] = {wrptr[odd even sel],word ptr} / concatenation 31.7.6.6 Word count 40 The word count logic maintains 2 counters to track the number of words transferred from DRAM per line, one counter for odd data, and one counter for even. On receipt of a flu gopulse, the WO 2004/050369 PCT/AU2003/001616 549 counters are initialized to a joinword value (number of words to the join point for that printhead channel) and the pointer select values to zero (ptr_se/). When a group of words are transferred to DRAM as indicated by the word dec signal from the interface controller, the corresponding counter is decremented. The counter to decrement is indicated by the oddevensel signal from 5 the write pointer block (even = 0, odd = 1). When a counter is zero and the ptrsel is zero, the counter is re-initialized to the second join word value and ptrsel is inverted. The counter continues to count down to zero each time a word_dec signal is received. When a counter is zero and the ptrsel is one, it signals the end of a line (the last wd signal) and initializes the counter to the first join point value for the next line 10 transfer. The ptrsel signal is used in the address generator to select the correct address pointer to use for that particular access. // determine which counter to decrement if (llugo-pulse == 1) then 15 wordcnt [0] = join word[O] even count ptrsel[0) 0 even generator starts with pointer A word cnt[l] = joinwordl] odd count ptr sel[1] = 0 odd generator 20 starts with pointer A elsif (word dec == 1) then {need to decrement one word counter if (odd even sel == 0) then even counter update 25 if (word cnt[0] == 0) then wordcnt [0] = join-word[ptr sel[0] re-initialize pointer ptr-sel[0] = -(ptr-sel[O]) if (ptr sel[0]== 1) then determine if 30 this the last word last/wd = t else word-cnt [0] -- // normal decrement 35 else // odd counter update if (word cnt[l] == 0) then word cnt [l] = join-word [ptr-sel[l]] // re-initialize pointer 40 ptrsel El] = ~(ptr-sel El]) WO 2004/050369 PCT/AU2003/001616 550 if (ptr-sel[1]== 1) then // determine if this the last word last wd = 1 else 5 word cnt[1] -- // normal decrement I The word count logic also determines if the current word to be transferred is the join word, and if so it determines if it is aligned on a 256-bit boundary or not. If the join point is aligned to a 10 boundary there is no need to prevent the address counter from incrementing, otherwise the address pointers are stalled for that word transfer Uoirnstall). join stall = (((ptr-sel[0] 0)AND (wordcnt[0] == 0)AND (join point [0] [7:0] != 0)) AND ((ptr sel[1] == 0)AND (wordcnt[l] == 0)AND 15 (joinpoint [1] [7:01 != 0))) The word count logic also determines when a complete line has been read from DRAM, it then signals the fifo fill level logic in both the LLU and DWU (via line rd signal) that a complete line has been read by the LLU (//utdwu_ine-rd). 20 // line finish logic if (llu_gopulse == 1) then line-fin = 0 line rd = 0 elsif ((last wd == 1) AND (line-fin == 0)) then 25 line-fin = 1 // first group lastwd finish pulse line rd = 0 elsif ((lastwd 1) AND (line-fin 1)) then line fin = 0 // second group lastwd 30 finish pulse line rd = 1 else line-fin = line-fin // stay the same line rd = 0 35 32 PrintHead Interface (PHI) 32.1 OVERVIEW The Printhead interface (PHI) accepts dot data from the LLU and transmits the dot data to the printhead, using the printhead interface mechanism. The PHI generates the control and timing signals necessary to load and drive the bi-lithic printhead. The CPU determines the line update 40 rate to the printhead and adjusts the line sync frequency to produce the maximum print speed to WO 2004/050369 PCT/AU2003/001616 551 account for the printhead IC's size ratio and inherent latencies in the syncing system across multiple SoPECs. The PHI also needs to consider the order in which dot data is loaded in the printhead. This is dependent on the construction of the printhead and the relative sizes of printhead ICs used to 5 create the printhead. See Bi-lithic Printhead Reference document for a complete description of printhead types [10]. The printing process is a real-time process. Once the printing process has started, the next printline's data must be transferred to the printhead before the next line sync pulse is received by the printhead. Otherwise the printing process will terminate with a buffer underrun error. 10 The PHI can be configured to drive a single printhead IC with or without synchronization to other SoPECs. For example the PHI could drive a single IC printhead (i.e. a printhead constucted with one IC only), or dual IC printhead with one SoPEC device driving each printhead IC. The PHI interface provides a mechanism for the CPU to directly control the PHI interface pins, allowing the CPU to access the bi-lithic printhead to: 15 e determine printhead temperature * test for and determine dead nozzles for each printhead IC * initialize each printhead IC * pre-heat each printhead IC Figure 277 shows a high level data flow diagram of the PHI in context. 20 32.2 PRINTHEAD MODES OF OPERATION The printhead has 8 different modes of operations (although some modes are re-used). The mode of operation is defined by the state of the output pins phi Isync/ and phi read/ and the internal printhead mode register. The modes of operation are defined in Table 210. Table 210. Printhead modes of operation 25 Name Internal Mode phi re phiIs State Description adl yncl NORMAL XXX 1 1 N/A Normal print mode, dot data is clocked into the printhead shift register, on each falling edge of phi srclk DOTLOAD/ XXX 1 0 phifrc/k=O Dot Load Mode, data stored in the FIREINIT dot shift register is transferred into the dot latch on the falling edge of phiIsyncl, and latched in on the rising edge of phi _syncl phi srck=l Fire load mode. Parameter for generating fire pattern are loaded into generator, data on WO 2004/050369 PCT/AU2003/001616 552 phi phdata[1:0][01 is clocked into the generator on each rising edge of phi frclk NOZZLE RE 001 0 1 N/A Reset Nozzle Test mode. Reset the SET state on nozzle test. CMOSTEST 111 0 1 N/A CMOS test mode. FIREGEN 000 0 1 N/A Fire Initialise mode. The initialised generator creates the fire pattern and shift select pattern. The pattern is clocked into the fire shift register and select shift register on the rising edge of phi frclk TEMPTEST 010 0 0 N/A Temperature test output. NOZZLETE 001 0 0 N/A Nozzle test output. ST The result of a nozzle test is output on phifrclki. 32.3 DATA RATE EQUALIZATION The LLU can generate dot data at the rate of 12 bits per cycle, where a cycle is at the system clock frequency. In order to achieve the target print rate of 30 sheets per minute, the printhead 5 needs to print a line every 100pis (calculated from 300mm @ 65.2 dots/mm divided by 2 seconds 100psec). For a 7:3 constructed printhead this means that 9744 cycles at 320Mhz is quick enough to transfer the 6-bit dot data (at 2 bits per cycle). The input FIFOs are used to de-couple the read and write clock domains as well as provide for differences between consume and fill rates of the PHI and LLU. 10 Nominally the system clock (pclk) is run at 160Mhz and the printhead interface clock dock/) is at 320Mhz. If the PHI was to transfer data at the full printhead interface rate, the transfer of data to the shorter printhead IC would be completed sooner than the longer printhead IC. While in itself this isn't an issue it requires that the LLU be able to supply data at the maximum rate for short duration, this 15 requires uneven bursty access to DRAM which is undesirable. To smooth the LLU DRAM access requirements over time the PHI transfers dot data to the printhead at a pre-programmed rate, proportional to the ratio of the shorter to longer printhead ICs. The printhead data rate equalization is controlled by PrintHeadRate[l:OJ registers (one per printhead IC). The register is a 16 bit bitmap of active clock cycles in a 16 clock cycle window. For 20 example if the register is set to OxFFFF then the output rate to the printhead will be full rate, if it's set to OxFOFO then the output rate is 50% where there is 4 active cycles followed by 4 inactive cycles and so on. If the register was set to OxOOOO the rate would be 0%. The relative data transfer rate of the printhead can be varied from 0-100% with a granularity of 1/16 steps. Table 211. Example rate equalization values for common printheads WO 2004/050369 PCT/AU2003/001616 553 Printhead Ratio A:B Printhead A rate Printhead B rate (%) (%) 8:2 OxFFFF (100%) 0x1111 (25%) 7:3 OxFFFF (100%) 0x5551 (43.7%) 6:4 OxFFFF (100%) 0xF1F2 (68.7%) 5:5 OxFFFF (100%) OxFFFF (100%) If both printhead ICs are the same size (e.g. a 5:5 printhead) it may be desirable to reduce the data rate to both printhead ICs, to reduce the read bandwidth from the DRAM. 5 32.4 DOT GENERATE AND TRANSMIT ORDER Several printhead types and arrangements exists (see [10] for other arrangements). The PHI is capable of driving all possible configurations, but for the purposes of simplicity only one arrangement (arrangement 1 - see [10] for definition) is described in the following examples. The structure of the printhead ICs dictate the dot transmit order to each printhead IC. The PHI 10 accepts two streams of dot data from the LLU, one even stream the other odd. The PHI constructs the dot transmit order streams from the dot generate order received from the LLU. Each stream of data has already been arranged in increasing or decreasing dot order sense by the DWU. The exact sense choice is dependent on the type of printhead ICs used to construct the printhead, but regardless of configuration the odd and even stream should be of opposing sense. 15 The dot transmit order is shown in Figure 281. Dot data is shifted into the printhead in the direction of the arrow, so from the diagram (taking the type 0 printhead IC) even dot data is transferred in increasing order to the mid point first (0, 2, 4, ... , m-6, m-4, m-2), then odd dot data in decreasing order is transferred (m-1, m-3, m-5,...., 5, 3, 1). For the type 1 printhead IC the order is reversed, with odd dots in increasing order transmitted first, followed by even dot data in 20 decreasing order. Note for any given color the odd and even dot data transferred to the printhead ICs are from different dot lines, in the example in the diagram they are separated by 5 dot lines. Table 212 shows the transmit dot order for some common A4 printheads. Different type printheads may have the sense reversed and may have an odd before even transmit order or vice versa. 25 Table 212. Example printhead ICs, and dot data transmit order for A4 (13824 dots) page Size Dots Dot Order Type 0 Printhead IC 8 11160 0,2,4,8.....,5574,5576,5578 5579,5577,5575......7,5,3,1 7 9744 0,2,4,8.....,4866,4868,4870 4871,4869,4867.....7,5,3,1 6 8328 0,2,4,8.....,4158,4160,4162 4163,4161,4159......7,5,3,1 5 6912 0,2,4,8.....,3450,3452,3454 3455,3453,3451......7,5,3,1 5496 0,2,4,8.....,2742,2744,2746 2847,2845,2843......7,5,3,1 WO 2004/050369 PCT/AU2003/001616 554 3 4080 0,2,4,8.....,2034,2036,2038 2039,2037,2035......7,5,3,1 2 2664 0,2,4,8.....,1326,1328,1330 1331,1329,1327......7,5,3,1 Type 1 Printhead IC 8 11160 13823,13821,13819 1332,1334,1336.......13818,138 ...... 1337,1335,1333 20,13822 7 9744 13823,13821,13819 2040,2042,2044.......13818,138 ...... 2045,2043,2041 20,13822 6 8328 13823,13821,13819 2848,2850,2852.......13818,138 ...... 2853,2851,2849 20,13822 5 6912 13823,13821,13819 3456,3458,3460.......13818,138 ...... 3461,3459,3457 20,13822 4 5496 13823,13821,13819 4164,4166,4168.......13818,138 ...... 4169,4167,4165 20,13822 3 4080 13823,13821,13819 4872,4874,4876.......13818,138 ...... ,4877,4875,4873 20,13822 2 2664 13823,13821,13819 5580,5582,5584.......13818,138 ..... ,5585,5583,5581 20,13822 32.4.1 Dual Printhead IC The LLU contains 2 dot generator units. Each dot generator reads dot data from DRAM and generates a stream of dots in increasing or decreasing order. A dot generator can be configured to produce odd or even dot data streams, and the dot sense is also configurable. In Figure 281 5 the odd dot generator is configured to produce odd dot data in decreasing order and the even dot generator produces dot data in increasing order. The LLU takes care of any vertical misalignment between the 2 printhead ICs, presenting the PHI with the appropriate data ready to be transmitted to the printhead. In order to reconstruct the dot data streams from the generate order to the transmit order, the 10 connection between the generators and transmitters needs to be switched at the mid point. At line start the odd dot generator feeds the type I printhead, and the even dot generator feeds the type 0 printhead. This continues until both printheads have received half the number of dots they require (defined as the mid point). The mid point is calculated from the configured printhead size registers (PrintHeadSize). Once both printheads have reached the mid point, the PHI switches the 15 connections between the dot generators and the printhead, so now the odd dot generator feeds the type 0 printhead and the even dot generator feeds the type 1 printhead. This continues until the end of the line. It is possible that both printheads will not be the same size and as a result one dot generator may reach the mid point before the other. In such cases the quicker dot generator is stalled until both 20 dot generators reach the mid point, the connections are switched and both dot generators are restarted.
WO 2004/050369 PCT/AU2003/001616 555 Note that in the example shown in Figure 281 the dot generators could generate an A4 line of data in 6912 cycles, but because of the mismatch in the printhead IC sizes the transmit time takes 9744 cycles. 32.4.2 Single printhead IC 5 In some cases only one printhead IC may be connected to the PHI. In Figure 282 the dot generate and transmit order is shown for a single IC printhead of 9744 dots width. While the example shows the printhead IC connected to channel A, either channel could be used. The LLU generates odd and even dot streams as normal, it has no knowledge of the physical printhead configuration. The PHI is configured with the printhead size (PrintHeadSizefl] register) for 10 channel B set to zero and channel A is set to 9744. Note that in the example shown in Figure 283 the dot generators could generate an 7 inch line of data in 4872 cycles, but because the printhead is using one IC, the transmit time takes 9744 cycles, the same speed as an A4 line with a 7:3 printhead. 32.4.3 Summary of generate and transmit order requirements 15 In order to support all the possible printhead arrangements, the PHI (in conjuction with the LLU/DWU) must be capable of re-ordering the bits according to the following criteria: * Be able to output the even or odd plane first. * Be able to output even and odd planes independently. * Be able to reverse the sequence in which the color planes of a single dot are output to the 20 printhead. 32.5 PRINT SEQUENCE The PHI is responsible for accepting dot data streams from the LLU, restructuring the dot data sequence and transferring the dot data to each printhead within a line time (i.e before the next line sync). 25 Before a page can be printed the printhead iCs must be initialized. The exact initialization sequence is configuration dependent, but will involve the fire pattern generation initialization and other optional steps. The initialization sequence is implemented in software. Once the first line of data has been transferred to the printhead, the PHI will interrupt the CPU by asserting the phi icuprint~rdy signal. The interrupt can be optionally masked in the ICU and the 30 CPU can poll the signal via the PCU or the ICU. The CPU must wait for a print ready signal in all printing SoPECs before starting printing. Once the CPU in the PrintMaster SoPEC is satisfied that printing should start, it triggers the LineSyncMaster SoPEC by writing to the PrintStart register of all printing SoPECs. The transition of the PrintStart register in the LineSyncMaster SoPEC will trigger the start of /syncl pulse 35 generation. The PrintMaster and LineSyncMaster SoPEC are not necessarily the same device, but often are the same. For a more in depth definition see section 12.1.1 Multi-SoPEC systems on page 133. Writing a 1 to the PrintStart register enables the generation of the line sync in the LineSyncMaster which is in turn used to align all SoPECs in a multi-SoPEC system. All printhead signaling is 40 aligned to the line sync. The PrintStart is only used to align the first line sync in a page.
WO 2004/050369 PCT/AU2003/001616 556 When a SoPEC receives a line sync pulse it means that the line previously transferred to the printhead is now printing, so the PHI can begin to transfer the next line of data to the printhead. When the transfer is complete the PHI will wait for the next line sync pulse before repeating the cycle. If a line sync arrives before a complete line is transferred to the printhead (i.e. a buffer 5 error) the PHI generates a buffer underrun interrupt, and halts the block. For each line in a page the PHI must transfer a full line of data to the printhead before the next line sync is generated or received. 32.5.1 Sync pulse control If the PHI is configured as the LineSyncMaster SoPEC it will start generating line sync signals 10 LsyncPre number of pc/k cycles after PrintStart register rising transition is detected. All other signals in the PHI interface are referenced from the rising edge of phi_/sync/ signal. If the SoPEC is in line sync slave mode it will receive a line sync pulse from the LineSyncMaster SoPEC through the phi/lsync/ pin which will be programmed into input mode. The phi /sync/ input pin is treated as an asynchronous input and is passed through a de-glitch circuit of programmable 15 de-glitch duration (LsyncDeglitchCnt). The phi sync/ will remain low for LsyncLow cycles, and then high for LsyncHigh cycles. The phi !syncl profile is repeated until the page is complete. The period of the phi/sync/ is given by LsyncLow + LsyncHigh cycles. Note that the LsyncPre value is only used to vary the time between the generation of the first phi/sync/ and the PageStart indication from the CPU. See 20 Figure 284 for reference diagram. If the SoPEC device is in line sync slave mode, the LsyncHigh register specifies the minimum allowed phi /sync/ period. Any phi_/sync/ pulses received before the LsyncHigh has expired will trigger a buffer underrun error. 32.5.2 Shift register signal control 25 Once the PHI receives the line sync pulse, the sequence of data transfer to the printhead begins. All PHI control signals are specified from the rising edge of the line sync. The phi src/k (and consequently phi ph data) is controlled by the SrcikPre, Src/kPost registers. The Src/kPre specifies the number of pc/k cycles to wait before beginning to transfer data to the printhead. Once data transfer has started, the profile of the phi srclk is controlled by 30 PrintHeadRate register and the status of the PHI input FIFO. For example it is possible that the input FIFO could empty and no data would be transferred to the printhead while the PHI was waiting. After all the data for a printhead is transferred to the PHI, it counts SrclkPost number of pc/k cycles. If a new phi_/sync/ falling edge arrives before the count is complete the PHI will generate a buffer underrun interrupt (phi icuunderrun). 35 32.5.3 Firing sequence signal control The profile of the phi frc/k pulses per line is determined by 4 registers Frc/kPre, Frc/kLow, Frc/kHigh, Frc/kNum. The Frc/kPre register specifies the number of cycles between line sync rising edge and the phi frc/k pulse high. It remains high for Frc/kHigh cycles and then low for Frc/kLow cycles. The number of pulses generated per line is determined by Frc/kNum register.
WO 2004/050369 PCT/AU2003/001616 557 The total number of cycles required to complete a firing sequence should be less than the phiIsyncl period i.e. ((FrclkHigh + FrclkLow) * FrclkNum)+ FrclkPre < (LsyncLow + LsyncHigh). Note that when in CPU direct control mode (PrintHeadCpuCtrl=1) and PrintHeadCpuCtrMode[x] =1, the frclk generator is triggered by the transition of the FireGenSoftTrigger[] bit from 0 to 1. 5 Figure 284 details the timing parameters controlling the PHI. All timing parameters are measured in number of pclk cycles. 32.5.4 Page complete The PHI counts the number of lines processed through the interface. The line count is initialised to the PageLenLine and decrements each time a line is processed. When the line count is zero it 10 pulses the phi icu page finish signal. A pulse on the phi icupage_finish automatically resets the PHI Go register, and can optionally cause an interrupt to the CPU. Should the page terminate abnormally, i.e. a buffer underrun, the Go register will be reset and an interrupt generated. 32.5.5 Line sync interrupt The PHI will generate an interrupt to the CPU after a predefined number of line syncs have 15 occured. The number of line syncs to count is configured by the LineSyncinterrupt register. The interrupt can be disabled by setting the register to zero. 32.6 DOT LINE MARGIN The PHI block allows the generation of margins either side of the received page from the LLU block. This allows the page width used within PEP blocks to differ from the physical printhead 20 size. This allows SoPEC to store data for a page minus the margins, resulting in less storage requirements in the shared DRAM and reduced memory bandwidth requirements. The difference between the dot data line size and the line length generated by the PHI is the dot line margin length. There are two margins specified for any sheet, a margin per printhead IC side. 25 The margin value is set by programming the DotMargin register per printhead IC. It should be noted that the DotMargin register represents half the width of the actual margin (either left or right margin depending on paper flow direction). For example, if the margin in dots is 1 inch (1600 dots), then DotMargin should be set to 800. The reason for this is that the PHI only supports margin creation cases 1 and 3 described below. 30 See example in Figure 284. In the example the margin for the type 0 printhead IC is set at 100 dots (DotMargin==1 00), implying an actual margin of 200 dots. If case one is used the PHI takes a total of 9744 phi srclk cycles to load the dot data into the type 0 printhead. It also requires 9744 dots of data from the LLU which in turn gets read from the 35 DRAM. In this case the first 100 and last 100 dots would be zero but are processed though the SoPEC system consuming memory and DRAM bandwidth at each step. In case 2 the LLU no longer generates the margin dots, the PHI generates the zeroed out dots for the margining. The phi srclk still needs to toggle 9744 times per line, although the LLU only needs to generate 9544 dots giving the reduction in DRAM storage and associated bandwidth.
WO 2004/050369 PCT/AU2003/001616 558 The case 2 senario is not supported by the PHI because the same effect can be supported by means of case 1 and case 3. If case 3 is used the benefits of case 2 are achieved, but the phi srclk no longer needs to toggle the full 9744 clock cycles. The phi srcik cycles count can be reduced by the margin amount (in 5 this case 9744-100=9644 dots), and due to the reduction in phi srclk cycles the phi isyncl period could also be reduced, increasing the line processing rate and consequently increasing print speed. Case 3 works by shifting the odd (or even) dots of a margin from line Y to become the even (or odd) dots of the margin for line Y-4, (Y-5 adjusted due to being printed one line later). This works for all lines with the exception of the first line where there has been no previous line to 10 generate the zeroed out margin. This situation is handled by adding the line reset sequence to the printhead initialization procedure, and is repeated between pages of a document. 32.7 DOT COUNTER For each color the PHI keeps a dot usage count for each of the color planes (called AccumDotCount). If a dot is used in particular color plane the corresponding counter is 15 incremented. Each counter is 32 bits wide and saturates if not reset. A write to the DotCountSnap register causes the AccumDotCount[N] values to be transferred to the DotCount[N] registers (where N is 5 to 0, one per color). The AccumDotCount registers are cleared on value transfer. The DotCount[Nl registers can be written to or read from by the CPU at any time. On reset the counters are reset to zero. 20 The dot counter only counts dots that are passed from the LLU through the PHI to the printhead. Any dots generated by direct CPU control of the PHI pins will not be counted. 32.8 CPU 10 CONTROL The PHI interface provides a mechanism for the CPU to directly control the PHI interface pins, allowing the CPU to access the bi-lithic printhead: 25 * Determine printhead temperature * Test for and determine dead nozzles for each printhead IC * Printhead IC initialization * Printhead pre-heat function The CPU can gain direct control of the printhead interface connections by setting the 30 PrintHeadCpuCtrl register to one. Once enabled the printhead bits are driven directly by the PrintHeadCpuOut control register, where the values in the register are reflected directly on the printhead pins and the status of the printhead input pins can be read directly from the PrintHeadCpuin. The direction of pins is controlled by programming PrintHeadCpuDir register. The register to pin mapping is as follows: 35 Table 213. CPU control and status registers mapping to printhead interface Register Name bits Printhead pin PrintHeadCpuOut 0 phiIsyncl-o 1 phi-frclk_o WO 2004/050369 PCT/AU2003/001616 559 2 Reserved 4:3 phi_phjdatao[0][1:0] 6:5 phiphdata-o[1][1:0] 8:7 phi-srclk[1:0] 9 phi read PrintHeadCpuDir 0 phiIsyncle direction control 1 - output mode 0 - input mode 1 phi-frclk e direction control 1 - output mode 0 - input mode 2 Reserved PrintHeadCpuln 0 phiIsynclji 1 phi-frclk__ 2 Reserved It is important to note that once in PrintHeadCpuCtr/ mode it is the responsibility of the CPU to drive the printhead correctly and not create situations where the printhead could be destroyed such as activating all nozzles together. The phi srclk is a double data rate clock (DDR) and as such will clock data on 5 both edges in the printhead. Note the following procedures are based on current printhead capabilities, and are subject to change. 32.9 IMPLEMENTATION 32.9.1 Definitions of I/O 10 Table 214. Printhead interface I/O definition Port name Pins 1/O Description Clocks and Resets Pclk 1 In System Clock Doclk 1 In Data out clock (2x pclk) used to transfer data to printhead prstn I In System reset, synchronous active low. Synchronous to oc/k dorstn 1 In System reset, synchronous active low. Synchronous to dock General phi icuprintrdy 1 Out Indicates that the first line of data is transferred to the printhead Active high. phiicupagefinish 1 Out Indicates that data for a complete page has transferred. III lActive high WO 2004/050369 PCT/AU2003/001616 560 phiicuunderrun I Out Indicates the PHI has detected a buffer underrun. Active high phi-icu-linesyncint 1 Out Indicates the PHI has detected LineSyncInterrupt number of line syncs. Debug debugdata valid I in Output debug data valid to be muxed on to the PHI pin debugcntrl 1 In Control signal for the PHI to indicate whether or not the debug data valid (and pclk) should be selected by the pin mux. Active high. LLU Interface lluphi-data[1:01[5:0] 2x6 In Dot Data from LLU to the PHI, each bit is a color plane 5 downto 0. Bus 0 - Even dot data stream Bus 1 - Odd dot data stream Data is active when corresponding bit is active in llu_phi avail bus phijllu-ready[1:0] 2 Out Indicates that PHI is ready to accept data from the LLU 0 - Even dot data stream I - Odd dot data stream lluphi avail[1:0] 2 In Indicates valid data present on corresponding Iluphi data. 0 - Even dot data stream I - Odd dot data stream Printhead Interface phi ph data[1:0][1:0] 2x2 Out Dot data output to printhead. Each bus to each printhead contains 2 bits of data Bus 0 - Printhead channel A Bus I - Printhead channel B phi srclk[1:0] 2 Out Dot data shift clock used to clock in printhead data, data is shifted on both edges of clock(i.e. double data rate DDR). Bus 0 - Printhead channel A Bus 1 - Printhead channel B phireadl 1 Out Common printhead mode control. Used in conjunction with phi Isync/ to determine the printhead mode 0 - SoPEC receiving, printhead driving 1 - SoPEC driving, printhead receiving phi_frclk__o 1 Out Common Fire pattern clock needs to toggle once per fire cycle WO 2004/050369 PCT/AU2003/001616 561 phifrclk_e 1 In phifrclk o output enable, when high phi frclk o pin is driving phifrclk_ 1 In phifrc/k_iinput from printhead phiIsyncl-o 1 Out Capture dot data for next print line, output mode phi Isyncl-e I In phisyncl output enable, when high phi_/syncl pin is driving phi-lsyncli 1 In Line Sync Pulse from Master SoPEC PCU Interface pcu_phi-sel 1 In Block select from the PCU. When pcuphi sel is high both pcu adr and pcu dataout are valid. pcurwn 1 In Common read/not-write signal from the PCU. pcu-adr[7:2] 6 In PCU address bus. Only 6 bits are required to decode the address space for this block. pcu-dataout[31:0] 32 In Shared write data bus from the PCU. phipcu rdy 1 Out Ready signal to the PCU. When phi pcurdy is high it indicates the last cycle of the access. For a write cycle this means pcu-dataout has been registered by the block and for a read cycle this means the data on htipcu detain is valid. phipcu_datain[31:0] 32 Out Read data bus to the PCU. 32.9.2 PHI sub-block partition 32.9.3 Configuration registers The configuration registers in the PHI are programmed via the PCU interface. Refer to section 21.8.2 on page 351 for a description of the protocol and timing diagrams for reading and writing 5 registers in the PHI. Note that since addresses in SoPEC are byte aligned and the PCU only supports 32-bit register reads and writes, the lower 2 bits of the PCU address bus are not required to decode the address space for the PHI. When reading a register that is less than 32 bits wide zeros should be returned on the upper unused bit(s) of phi pcu datain. Table 215 lists the configuration registers in the PHI 10 Table 215. PHI registers description Address 'Register f#bits Reset Descriptlon PHI base+ Control Registers Ox00 Reset 1 Ox1 Active low synchronous reset, self de activating. A write to this register will cause a PHI block reset. Ox04 Go 1 Ox0 Active high bit indicating the PHI is programmed and ready to use. A low WO 2004/050369 PCT/AU2003/001616 562 to high transition will cause PHI block internal state to reset. Will be automatically reset if a page finish or a buffer underrun is detected. General Control 0x08 PageLenLine 32 OxOOO Specifies the number of dot lines in a _0000 page. Indicates the number of lines left to process in this page while the PHI is running (Working register) OxOc PrintStart 1 Ox0 A high level enables printing to start via the generation of line syncs in a master, and acceptance of line syncs in a slave. Can be set in advance of the print ready signal. Ox1 0-Ox1 4 DotMargin[1:0] 2x16 OxOOO Specifies for each printhead IC, the Width of the margin in dots divided by 2. Value must be divisible by 2 (i.e. the low bit must be 0) 0 - Printhead IC Channel A 1 - Printhead IC Channel B 0x18-Ox2C DotCount[5:0] 6x32 OxOOO Indicates the number of Dots used for 0000 a particular color, where N specifies a color from 0 to 5. Value valid after a write access to DotCountSnap 0x30 DotCountSnap 1 Ox0 Write access causes the AccumDotCount values to be transferred to the DotCount registers. The AccumDotCount are reset afterwards.(Reads as zero) 0x34 PhiHeadSwap 1 Ox0 Controls which signals are connected to printhead channels A and B 0 - Normal, specifies bit 0 is channel A, bit 1 is channel B 1 - Swapped, specifies bit 0 is channel B, bit 1 is channel A. Ox38 PhiMode 1 Ox0 Indicates whether the PHI is operating in master or slave mode WO 2004/050369 PCT/AU2003/001616 563 0 - Slave Mode 1 - Master Mode Ox3C-0x40 PhiSerialOrder 2x1 OxO Specifies the serialization order of dots before transfer to the printhead. Bus 0 - Printhead Channel A Bus I - Printhead Channel B If set to zero the order is dot[1:0], then dot[3:21 then dot[5:4]. If set to one then the order is dot[5:4], dot[3:2], dot[1:0]. Ox44-0x48 PrintHeadSize 2x16 0x0000 Specifies the number of non-margin dots in the printhead ICs (must be even). If margining is to be used then the configured PrintHeadSize should be adjusted by the dot margin value i.e. PrintHeadSize = (Physical PrintHeadSize - (DotMargin * 2)). Value must be divisible by 2 (i.e. the low bit must be 0) Bus 0 - Specifies printhead on Channel A Bus 1 - Specifies printhead on Channel B CPU Direct PHI Control (See Table 213.) Ox4C PrintHeadCpul 3 Ox0 PHI interface pins input status. Only n active in direct CPU mode (Read Only Register) 0x50 PrintHeadCpuD 3 Ox0 PHI interface pins direction control. ir Only active in direct CPU mode Ox54 PrintHeadCpu 10 xOO PHI interface pins output control. Only Out active in direct CPU mode Ox58 PrintHeadCpuC 1 OxI Control direct access CPU access to trl the PHI pins 0 - Normal Mode 1 - Direct CPU Control mode Ox5C Print- 1 Ox0 Specifies if the pin is controlled by the HeadCpuCtrIM PrintHeadCpuOut register or by the ode Fire generator logic. Only active when PrintHeadCpuCtrl is I and pin is in output mode.
WO 2004/050369 PCT/AU2003/001616 564 Bit 0 - controls the frolk pin When the bit is 0 - Pin is controlled by PrintHeadCpuOut 1 - Pin is controlled by Fire Generator Logic Line Sync Control 0x60 LsyncHigh 24 OxOO_0 In Master mode specifies the number 000 of pck cycles phiisyncl should remain high. In Slave mode specifies the minimum number of pc/k cycles between Lsync pulses. Lsync pulses of a shorter period will cause the PHI to halt due to buffer underrun. Ox64 LsyncLow 16 OxOOO Number of pc/k cycles philsyncl should remain low. Ox68 LsyncPre 16 OxOOO Number of pc/k cycles between PrintStart rising transition and the generated phi Isyncl falling edge Ox6C LsyncDeglitchC 4 Ox3 Number of pc/k cycles to filter the nt incoming Lsync pulse from the master. Only used in slave mode. Ox70 LineSynclnterru 16 OxOOO Number of line syncs to occur before pt generating an interrupt. When set to zero interrupt is disabled. Shift Register Control 0x74 SrclkPre 14 0x0000 Number of pck cycles between phi_/syncl falling edge and phisrclk pulse generation, or printhead data transfer 0x78 SrclkPost 14 OxOOO Number of pc/k cycles allowed margin from last srclk pulse in a line to before next line sync Ox7C-0x80 PrintHeadRate[ 2x16 OxFFFF Specifies the active to inactive ratio of 1:0] phisrclk for the printhead ICs. A 1 indicates Active. Bus 0 - Printhead IC channel A Bus 1 - Printhead IC channel B WO 2004/050369 PCT/AU2003/001616 565 0x84 DotOrderMode I Ox0 Specifies the dot transmit order to the printhead Channel A. Printhead Channel B is always the opposing order. 0 - Even before Odd dots 1 - Odd before Even dots Fire Control 0x98 FrclkPre 14 xO00 Number of pclk cycles after Isyncl transitions from 0 to 1 to phi frclk pulse generation Ox9C FrcikLow 14 xO00 Number of pclk cycles phi-frclk should remain low. OxA0 FrclkHigh 14 xO00 Number of pclk cycles phi frc/k should remain high. OxA4 FrclkNum 16 OxOOOO Number of phi frclk pulses per line time. OxA8 FireGenSoftTri 1 Ox0 Only active when gger PrintHeadCpuCtrIMode is set to 1, PrintHeadCpuCtrl is 1 and pin is in output mode. Bit 0 controls frc/k generator. A 0 to 1 transition on a bit triggers the corresponding generator to create the programmed pulse profile (configured by FrclkNum,FrclkHigh,FrclkLowFrcfkPre registers) when complete the bit gets reset to 0. Working Registers OxAC-OxBO LineDotCnt 2x16 OxOOO Indicates the number of dot processed in the current line Bus 0 - Printhead Channel A Bus 1 - Printhead Channel B (Read Only Registers) The configuration registers in the PHI block are clocked at pc/k rates but some blocks in the PHI are clocked by different and asynchronous clocks. Configuration values are not re-synchronized, it is therefore important that the Go register be set to zero while updating configuration values. This prevents logic from entering unknown states due to metastable clock domain transfers.
WO 2004/050369 PCT/AU2003/001616 566 Some registers can be written to at any time such as the direct CPU control registers (PrintHeadCpuln, PrintHeadCpuDir, PrintHeadCpuOut and PrintHeadCpuCtrl), the Go register and the PrintStart register. All registers can be read from at any time. 32.9.4 Dot counter 5 The dot counter keeps a running count of the number of dots fired for each color plane. The counters are 32 bits wide and will saturate. When the CPU wants to read the dot count for a particular color plane it must write to the DotCountSnap register. This causes all 6 running counter values to be transferred to the DotCount registers in the configuration registers block. The running counter values are reset. 10 // reset if being snapped if (dotcntsnap == 1) then{ dot count[5:0] = accum dot count[5:0] accum dot count[5:0] = 0 15 // update the counts for (color=0;color < 6;color++) if (accum dot count[color] != Oxffffffff) { // data valid, first dot stream data-valid = ((phi_lluready[0] == 1) AND 20 (lluphi-avail[0] == 1)) if ((data-valid == 1) AND (lluphi-data[0] [color] == 1)) then accum-dot count[color] ++ // data valid, second dot stream 25 data-valid = ((phillu ready[1] == 1) AND (lluphi-avail[l] == 1)) if ( (datavalid == 1) AND (lluphidata [1] [color] 1)) then accum dot count[color] ++ 30 } 32.9.5 Sync generator The sync generator logic has two modes of operation, master and slave mode. In master mode (configured by the PhiMode register) it generates the IsyncLo output based on configured values 35 and control triggers from the PHI controller. In slave mode it de-glitches the incoming Isync/i signal, and filters the Isyncl signal with the minimum configured period. After reset or a pulse on phi go pulse the machine returns to the Reset state, regardless of what state it's currently in. The state machine waits until it's enabled (synen==l) by the PHI controller state machine. 40 When enabled it can proceed to the SyncPre or SyncWait depending on whether the state WO 2004/050369 PCT/AU2003/001616 567 machine is configured in master or slave mode. In master mode it generates the Isyncl pulses, in slave mode it receives and filters the Isync/ pulses from the master sync generator. On transition to the SyncPre state a counter is loaded with the LsyncPre value, and while in the SyncPre the counter is decremented. When the count is zero the machine proceeds to the 5 SyncLow state loading the counter with LsyncLow value. The machine waits in the SyncLow state until the counter has decremented to zero. It proceeds to the SyncHigh state pulsing the /ine-st signal on transition and counts LsyncHigh number of cycles. This indicates to the PHI controller the line start aligned to the Isync/ positive edge. While in LsyncLow state the /syncLo output is set to 0 and in SyncHigh the IsyncLo output is set to 1. 10 When the count is zero and the current line is not the last (last line == 0), the machine returns to the SyncLow state to begin generating a new line sync pulse. The transition pulses the /ine-fin signal to the PHI controller. The loop is repeated until the current line is the last (lastjline ==1), and the machine returns to the Reset state to wait for the next page start. 15 In slave mode the state machine proceeds to the SyncWait state when enabled. It waits in this state until a /sync pulserise is received from the input de-glitch circuit. When a pulse is detected the machine jumps to the SyncPeriod state and begins counting down the LsyncHigh number of clock cycles before returning to the SyncWait state. Note in slave mode the LsyncHigh specifies the minimum number of pclk cycles between Lsync pulses. On transition from the SyncWait to the 20 SyncPeriod state the line st signal to the PHI controller is pulsed to indicate the line start. While in the SyncPeriod state if a sync pulse-fall is detected the state machine will signal a sync error (via syncerr) to the PHI controller and cause a buffer underrun interrupt. 32.9.5.1 Lsyncl input de-glitch The /sync_i input is considered an asynchronous input to the PHI, and is passed through a 25 synchronizer to reduce the possibility of metastable states occurring before being passed to the de-glitch logic. The input de-glitch logic rejects input states of duration less than the configured number of clock cycles (/syncdeg/itchcnt), input states of greater duration are reflected on the output, and are negative and positive edge detected to produce the Isync_pulse fall and lsync pulse-rise signal 30 to the main generator state machine. The counter logic is given by if ( 1synci != lsync i delay) then cnt = lsyncdeglitchcnt outputen = 0 elsif (cnt 0 ) then 35 cnt = cnt outputen = 1 else cnt outputen = 0 40 32.9.5.2 Line Sync Interrupt logic WO 2004/050369 PCT/AU2003/001616 568 The line sync interrupt logic counts the number of line syncs that occur (either internally or externally generated line syncs) and determines whether to generate an interrupt or not. The number of line syncs it counts before an interrupt is generated is configured by the LineSyncinterrupt register. The interrupt is disabled if LineSyncinterrupt is set to zero. 5 // implement the interrupt counter if (phigopulse ==1) then line-count = 0 elsif (linest 1) AND (linecount == 0)) then line count linecount int 10 elsif ((line st == 1) AND (line-count 1= 0)) then line count - // determine when to pulse the interrupt if (linesyncint == 0 ) then // interrupt disabled phiicu linesyncint = 0; 15 elsif ((linest == 1) AND (line-count == 1)) then phiicu-linesyncint = 1 32.9.6 Fire generator The fire generator block creates the signal profile for the phi frclk signal to the printhead. The frclk is based on configured values and is timed in relation to the fire st pulse from the PHI 20 controller block. Should the phifrclk state machine receive a first pulse before it has completed the sequence the machine will restart regardless of its current state. Alternatively the frclk state machine can be triggered to generate their configured pulse profile by software. A low to high transition on the FireGenSoftTrigger register will cause a pulse on softfrclk st triggering the state machine to begin generating the pulse profile. When the state 25 machine has completed its sequence it will clear the Fire GenSoftTrigger register bit (via softfire c/r signal). The FireGenSoftTrigger register will only be active when the printhead interface is in CPU direct control mode (PrintHeadCpuCtrl = 1) , the fire generator is in software trigger mode (PrintHeadCpuCtr/Mode[x] = 1) and the pin is configured to be output mode (PrintHeadCpuDr[xJ = I). 30 The fire generator consists of a state machine for creating the phi frclk signal. The phi frc/k signal is generated relative to the Isyncl signal. The machine is reset to the Reset state when phi gopulse ==1 or the reset is active, regardless of the current state. The machine waits in the reset state until it receives a fire st pulse from the PHI controller (or an 35 softfirest from the configuration registers). The controller will generate a fire st pulse at the beginning of each dot line. On the state transition the cycle counter is loaded with the FrclkPre value and the repeat counter is loaded with the FrclkNum value. The state machine waits in the FirePre state until the cycle counter is zero, after which it jumps to the FireHigh state and loads the cycle counter with FrclkHigh value. Again the state machine 40 waits until the count is zero and then proceeds to the FireLow state, On transition the cycle WO 2004/050369 PCT/AU2003/001616 569 counter is loaded with the FireLow value. The state machine waits in the FireLow state while the cycle counter is decremented. When the cycle counter reaches zero and the repeat count is non-zero, the repeat count is decremented, the cycle counter is loaded with the FrcikHigh value and the state machine jumps to 5 the FireHigh state to repeat the phi frclk generation cycle. The loop is repeated until the repeat count is zero. In such cases the state machine goes to the reset state resetting FireGenSoftTrigger (via the softfiredcr signal) register on the transition and waits for the next fire_st pulse. When in the Reset state the firerdy signal is active to indicate to the controller that the fire 10 generator is ready. 32.9.7 PHI controller The PHI controller is responsible for controlling all functions of the PHI block on a line by line basis. It controls and synchronizes the sync generator, the fire generator, and datapath unit, as well as signalling back to the CPU the PHI status. It also contains a line counter to determine 15 when a full page has completed printing. The PHI controller state machine is reset to Reset state by a reset or phi go pulse == 1. It will remain in reset until the block is enabled by phLgo == 1. Once enabled the state machine will jump to the FirstLine state, trigger the transfer of one line of data to the printhead (datast == 1) and the line counter will be initialized to the page length (PageLenLine). Once the line is 20 transferred (data fin from the datapath unit) the machine will go to Printstart state and signal the CPU using an interrupt that the PHI is ready to begin printing (phi icu print-rdy). The line counter will also be decremented. It will then wait in the Printstart state until the CPU acknowledges the print ready signal and enables printing by writing to the PrintStart register. The state machine proceeds to the SynclWait state and waits for a line start condition finestt 25 ==1). The line start condition is different depending on whether the PHI is configured as being in a master or slave SoPEC (the PhiMode register). In either case the sync generator determines the correct line start source and signals the PHI controller via the line.st signal. Once received the machine proceeds to the Line Trans state, with the transition triggering the fire generator to start (firest), the datapath unit to start (data st) and the sync generator to start (sync_st). 30 While in the Line Trans state the fire, sync and datapath unit will be producing line data. When finished processing a line the datapath unit will assert the line finished (data-fin) signal. If the line counter is not equal to 1 (i.e. not the last line) the state machine will jump back to the SyncWait state and wait for the start condition for the next line. The line counter will be decremented. If the line counter is one then the machine will proceed to the LastLine state. 35 The LastLine state generates one more line of fire pulses to print the last line held in the shift registers of the printhead. Once complete (firefin ==1) the state machine returns to the reset state and waits for the next page of data. On page completion the state machine generates a phi icu pageJinish interrupt to signal to the CPU that the page has completed, the phi icu page finish will also cause the Go register to reset automatically.
WO 2004/050369 PCT/AU2003/001616 570 While the state machine is in the LineTrans state (or in FirstLine state and the PHI is in slave mode) and waiting for the datapath unit to complete line processing, it is possible (e.g. an excessive PEP stall) that a line finish condition occurs (Iine-fin == 1) but the datapath unit is not ready. In this case an underrun error is generated. The state machine goes to the Underrun state 5 and generates a phi_icu_underrun interrupt to the CPU. The PHI cannot recover from a buffer underrun error, the CPU must reset the PEP blocks and re-start printing. The phi icu underrun will also cause the Go register to reset automatically. 32.9.8 CPU 10 control The CPU 10 control block is responsible for providing direct CPU control of the 10 pins via the 10 configuration registers. It also accepts the input signals from the printhead and re-synchronizes them to the pclk domain, and debug signals from the RDU and muxes them to output pins. Table contains the direct mapping of configuration registers to printhead 10 pins. Direct CPU control is enabled only when PrintHeadCpuCtrl is set to one. In normal operation (i.e. PrintHeadCpuCtrl == 0) the printhead frclk pin is always in output mode (phi frclke=1), the 15 phi Isynci will be in output if the SoPEC is the master, i.e. phi Isyncie = phi mode, and read will be set high. The PrintHeadCpuCtriMode register determine whether the frclk pin should be driven by the fire generator logic or direct from the CPU PrintHeadCpuOut register. The pseudocode for the CPU 10 control is: 20 if (printhead-cpu-ctrl == 1) then // CPU access enabled // outputs if (PrintHeadCpuCtrlMode[0] == 1) then // fire generator controlled phifrclko = frclk 25 else // normal direct CPU control phi frclk o = printhead-cpuout [1] phiphdata o[0] [1:0] = printheadcpu out [4:3] phiphdatao[l1] [1:0] = printheadcpu out [6:5] 30 phisrclk [1:0] = printheadcpu out[8:7] phireadl = printheadcpu_out [9] // direction control philsyncle = printheadcpu dir [0] phi_frclke = printheadcpudir[l] 35 // input assignments printhead cpu in[0] = synchronize(phi lsyncl i) printhead-cpuin[1] = synchronize(phi_frclk_i) else // normal connections // outputs 40 phiph data_o [0] [1:0] = phdata [0] [1: 0] WO 2004/050369 PCT/AU2003/001616 571 phiph data [1] [1: 0] = phdata[1] [1:0) phi_lsynclo = lsync_o phireadl 1 phisrclk[l:o) = srclk[1:01 5 phifrclko = frclk // direction control phifrclke =1 phi_lsyncle = phi-mode // depends on Master or Slave mode 10 // inputs lsyncli = philsync_i // connected regardless // debug overrides any other connections if (debugcntrl[O] == 1) then 15 phifrclk_o = debugdata valid phifrclk-e = 1 phireadl = pclk The debug signalling is controlled by the RDU block (see Section 11.8 Realtime Debug Unit (RDU)), the 10 control in the PHI muxes debug data onto the PHI pins based on the control 20 signals from the RDU. 32.9.9 Datapath Unit 32.9.10 Dot order controller The dot order controller is responsible for controlling the dot order blocks. It monitors the status of each block and determines the switch over point, at which the connections from odd and even dot 25 streams to printhead channels are swapped. The machine is reset to the Reset state when phi gopu/se == 1 or the reset is active. The machine will wait until it receives a datast pulse from the PHI controller before proceeding to the LineStart state. On the transition to the LineStart state it will reset the dot counter in each dot order block via the dotcntrst signal. 30 While in the LineStart state both dot order blocks are enabled (gen en==1). The dot order blocks process data until each of them reach their mid point. The mid point of a line is defined by the configured printhead size (i.e. print head size). When a dot order block reaches the mid point it immediately stops processing and waits for the remaining dot order block. When both dot order blocks are at the mid point (mid pt == 11) the controller clocks through the LineMid state to allow 35 the pipeline to empty and immediately goes to LineEnd state. In the LineEnd state the mode_se! is switched and the dot order blocks re-enabled, in this state the dot order blocks are reading data from the opposite LLU dot data stream as in LineStart state. The controller remains in the LineEnd state until both dot order blocks have processed a line i.e. line fin == 11.
WO 2004/050369 PCT/AU2003/001616 572 On completion of both blocks the controller returns to the Reset state and again awaits the next datast pulse from the PHI controller. When in Reset state the machine signals the PHI controller that it's ready to begin processing dot data via the dotorder rdy signal. The dot order controller selects which dot streams should feed which printhead channels. The 5 order can be changed by configuring the DotOrderMode register. In all cases Channel A and Channel B must be in opposing dot order modes. Table 216 shows the possible modes of operation. Table 216. Mode selection in Dot order controller. Channel Mode-sel DotOrderMode Dot transmit order A 0 0 Even before Odd (EBO mode), even dot stream feeds Channel A printhead, first half line. 0 1 Odd before Even (OBE mode), odd dot stream feeds Channel A printhead, first half line. 1 0 Even before Odd (EBO mode), even dot stream feeds Channel A printhead, second half line. 1 1 Odd before Even (OBE mode), odd dot stream feeds Channel A printhead, second half line. B 0 0 Odd before Even (OBE mode), odd dot stream feeds Channel B printhead, second half line 0 1 Even before Odd.(EBO mode), even dot stream feeds Channel B printhead, second half line. 1 0 Odd before Even (OBE mode), odd dot stream feeds Channel B printhead, first half line. 1 1 Even before Odd (EBO mode), even dot stream feeds Channel B printhead, first half line. 10 32.9.10.1 Dot order unit The dot order control accepts dot data from either dot stream from the LLU and writes the dot data into the dot buffer. It has two modes of operation, odd before even (OBE) and even before odd (EBO). In the OBE mode data from the odd stream dot data is accepted first then even, in EBO mode it's vice versa. The mode is configurable by the DotOrderMode register.
WO 2004/050369 PCT/AU2003/001616 573 The dot order unit maintains a dot count that is decremented each time a new dot is received from the LLU. The dot order controller resets the dot counter to the print_headsize[15:0] at the start of a new line via the dotcntrst signal. The dot count is compared with the printhead size (print head size[1 5:0] divided by 2) to determine the mid point (mid pt) and the line finish point 5 (linefin) when the dot counter is zero. The mid point is defined as the half the number of dots in a particular printhead, and is derived from the the printheadsize bus by dividing by 2 and rounding down. // define the mid point . if (dot cnt[15:0 == print headsize[15:1] )then 10 midpt = 1 else midpt = 0 The dot order unit logic maintains the dot data write pointer. Each time a new dot is written to the dot buffer the write pointer is incremented. The fill level of the dot buffer is determined by 15 comparing the read and write pointers. The fill level is used to determine when to backpressure the LLU (ready signal) due to the dot buffer filling. A suitable threshold value is determined to allow for the full LLU pipeline to empty into the dot buffer. The dot order stalling control is given by: // determine the ready/avail signal to use, based on mode 20 select if (mode sel == 1) then dot-active = llu_phi-avail[O] AND ready wr data = llu-phi-data[o] else 25 dotactive = llu_phi-avail l] AND ready wrdata = lluphi data [1] // update the counters if (dotactive == 1) then { wr en = 1 30 wr adr ++ if (dot cnt == 0) then dotcnt = printhead size else dot cnt- 35 } The dot writer needs to determine when to stall the LLU dot data stream. A number of factors could stall the dot stream in the LLU such as buffer filling, waiting for the mid point, waiting for the line finish or the dot order controller is waiting for the line start condition from the PHI controller. The stall logic is given by: 40 // determine when to stall the LLU generator WO 2004/050369 PCT/AU2003/001616 574 fill-level = wr adr - rd adr if (fill_level > (32 - THRESHOLD ))then // THRESHOLD is open value ready = 0 // buffer is close 5 to full elsif ( gen en == 0) then ready = 0 // stalled by the datapath controller else 10 ready = 1 // everything good no stall 32.9.10.2 Data generator The data generator block reads data from the dot buffer and feeds dot data to the printhead at a configured rate (set by the PrintheadRate). It also generates the margin zero data and aligns the 15 dot data generation to the synchronization pulse from the PHI controller. The data generator controller waits in Reset state until it receives a line start pulse from the PHI controller (data-st signal). Once a start pulse is received it proceeds to the SrclkPre state loading a counter with the SrclkPre value. While in this state it decrements the counter. No data is read or output at this stage. When the count is zero the machine proceeds to the DataGen1 state. 20 On transition it loads the counter with the printhead size (print headsize). If margining is to be used then the configured print headsize should be adjusted by the dot margin value i.e. print head size = (physicalprint_headsize - (dot margin * 2)). Dot data is transferred to the printhead serializer in dot-pairs, with one dot-pair transferred every 3 pclk cycles. To construct a dot data pair the state machine reads one dot in the DataGen1 state, 25 one dot in the DataGen2 state and waits for one clock cycle in the DataGen3 while the data is transferred to the data serializer. The counter will decrement for every dot data word transferred. The exact data rate is dictated by the dot buffer fill levels and the configured printhead rate (PrintheadRate). When in DataGen3 state the machine determines if it should waits for 3 cycles or transfer another dot pair to the data serializer. The generator determines the rate by comparing 30 the rate counter (rate-cnt) with the configured PrintheadRate value. If the bit selected by the ratecnt in the print-headrate bus is one data is transferred, otherwise the 3 cycles are skipped (Waitl, Wait2 and Wait3). If the PrintHeadRate is set to all zeros then no data will ever get transferred. The rate counter is decremented (rate cnt) while in the DataGen2 and Wait2 states. The rate counter is allowed to wrap normally. 35 The pseudo-code for the rate control DataGen3 (or Wait3) state is given by: // decrement the rate count rate cnt -- // happens in DataGen2, or Wait2 // determine if data should be read 40 // first determine if data is available in buffer WO 2004/050369 PCT/AU2003/001616 575 if (rd-adr != wr adr ) then if (printheadrate [ratecntl 1 ) then dot-active = 1 gate srclk =1 5 count next-state = DataGen1 else dot-active = 0 gate srclk = 0 10 next-state = waiti else dot active = 0 gate srclk = 0 next state = Wait1 15 When the dot counter reaches zero the state machine will jump to the MarginGen1 state if the configured margin value is non-zero, otherwise it will jump directly to the SrclkPost state. On transition to MarginGenI state it loads the cycle counter with the dot margin value, and begins to count down. While in the MarginGenl,MarginGen2 and MarginGen3 state machine loop the data generator logic block writes dot data to the printhead but does not read from the dot buffers. It 20 creates zero dot data words for the margin duration. As with normal dot data, it creates one dot in MarginGenI and MarginGen2 states, then wait a clock cycle to allow the transfer to the data serializer to complete. When the counter reaches zero the machine jumps to the SrclkPost state, loads the clock counter with the SrclkPost value and decrements. When the count is finished the state machine returns to 25 the Reset and awaits the next start pulse. Should a line sync arrive before the data generators have completed (data-fin signal) the PHI controller will detect a print error and stall the PHI interface. As a consequence of the data transfer mechanism of dot pair cycles followed by a wait state, the printhead size (printheadsize) and dot margin (dot margin) must always be even dot values. 30 32.9.10.3 Data serializer The data serializer block converts 12-bit dot data at pc/k rates (nominally 160 MHz) to 2-bit data at doclk rates (nominally 320 MHz). The srclk is only active when data is available for transfer to the printhead, as enabled by the gatesrc/k signal. The data rate mechanism in the data generator block will mean that data is not 35 transferred to the printhead on every set of 3 pc/k cycles. Both the dotdata and gate srclk signals are controlled by the data generator block and can only change on a fixed 3 poik cycle boundary. Data is transferred to the printhead on both edges of srclk (i.e double data rate DDR). Directly after a line sync pulse the mux control logic and the srclk generation logic are reset to a known state (the srcik is set high). Before data can begin transfer to the printhead it must 40 generate a line setup edge on srclk, causing srclk to go low. The line setup edge happens WO 2004/050369 PCT/AU2003/001616 576 SrclkPre number of pclk cycles after the line sync falling edge (indicated by the sr init signal from the data generator block). All data transfers to the printhead will be in groups of 6 2-bit data words, each word clocked on an edge of srclk. For each group srclk will start low and end low. 5 At the end of a full line of data transfer the src/k must generate a line complete edge to return the srclk to a high state before the next line sync pulse. The data generator block generates a srcom signal to indicate that the data transfer to the printhead has completed and that the line complete edge can be inserted. The srcorn signal is generated before the SrClkPost period. The data serializer block allows easy separation of clock gating and clock to logic structures from 10 the rest of the PHI interface. The mux logic determines which data bits from the dotdata bus should be selected for output on the ph data bus to the printhead. The mux selector is initialized by an edge detect on the sr init signal from the data generator. // determine wrap and init points 15 if (phi serial order == 1) then mux wrap = 5 muxinit = 0 else mux wrap = 0 20 muxinit = 5 // the mux selector logic if ((sr_init edge == 1)OR( mux sel == mux wrap )) then mux sel = muxinit elsif ( phi serial order == 1 ) then 25 mux sel-- // decrement order else mux sel++ // increment order The dot data serialization order can be configured by PhiSerialOrder register. If the 30 PhiSerialOrder is zero the order is dot[1:0], then dot[3:2] then dot[5:4]. If the register is one then the order is dot[5:4], dot[3:2], dot[1:0]. The srclk control logic is initialized to 1 when a linest positive edge is detected. If either sr_comedge, srinit edge or gate srclk are equal to one srclk is transitioned. srclk is always clocked out to the output pins on the negative edge of dock to place the clock edge in the centre 35 of the data. The pseudo code for the control logic is: if (linest-edge ==1 ) then srclkgen = 1 elsif ((gate srclk ==1) OR (sr-init-edge==1) OR 40 (sr_comedge==1)) then WO 2004/050369 PCT/AU2003/001616 577 srclk-gen = -srclk-gen else // hold 5 33 PACKAGE AND TEST Test Units 33.1 JTAG INTERFACE A standard JTAG (Joint Test Action Group) Interface is included in SoPEC for Bonding and 10 testing purposes. The JTAG port will provide access to all internal BIST (Built In Self Test) 10 structures. 33.2 SCAN TEST 1/O The SoPEC device will require several test 10's for running scan tests. In general scan in and scan out pins will be multiplexed with functional pins. 33.3 ANALOG TEST UNITS 15 33.3.1 USB PHY Testing The USB phy analog macro, will contain built-in in test structure, which can be access by either the CPU or through the JTAG port. 33.3.2 Embedded PLL Testing The embedded clock generator PLL will require test access from JTAG port. 20 34 SoPEC Pinning and Package 34.1 OVERVIEW It is intended that the SoPEC package be a 100 pin LQFP. Any spare pins in the package may be used by increasing the number of available GPIO pins or adding extra power and ground pin. The pin list shows the minimum pin requirement for the SoPEC device. 25 Table 217. SoPEC Pin List (100 LQFP) Group Pin Name #pin s Dir Type Volt I/0 Rate Freq Description 10 Cell Type Test Test (S/D) (Mh Function Macro z ) Function Clocks and resets Group 1 Xtalin 1 I N/A 32 Crystal AINSAPM_ None Input pin A Xtalout 1 0 N/A N/A 32 Crystal ABNSTPM None output pin _A Group 2 resetn 1 1 LVTT 3.3v s 10 Asynchron IT33LTPUT_ LT (leakage L ous active PM_A test) low reset PrintHead Interface Group 3 phead_daR8 0 LVDS 1.5vid 160 Print head OLVDS15_P one WO 2004/050369 PCT/AU2003/001616 578 a data MA Srclk 4 0 VDS 1.5v d 160 Printhead OLVDS15_P None clock MA Group 4 Readl 1 0 LVTT 3.3v s 160 Common T3365TP AClock L rint head MA mode control Frclk 1 /O LVTT 3.3v s 160 Common BT3365TP BClock L Fire pattern M_A shift clock, needs to toggle once per fire cycle phi spare 1 I/0 LVTT 3.3v s 160 PHI spare BT3365TP CClock1 L pin (old M_A profile pin) Lsyncl 1 /O LVTT 3.3v s 160 Line Sync BT3365TP CClock2 L output from MA Master to Slaves USB Connections Group 5 Usbhost 2 / Differ 3.3v s 12 USB BUSB2_PM None d ential differential A data for host Usb devd - 1/ Differ 3.3v s 12 USB BUSB2_PM_ None ential differential A data for device Group 6 usbdvbu 1 LVTT 3.3v s 10 USB device BT3365TP 1 scan out s sense L VBUS MC power sense usbd_pull 1 0 LVTT 3.3v s 10 USB device BT3365TP 1 scan out _upen L termination M_C enable JTAG Group 7 do 1 0 VTT 3.3v s 10 TAG Test T3365T_P CClock3 WO 2004/050369 PCT/AU2003/001616 579 L data out MA port Tms 1 I LVTT 3.3v s 10 JTAG Test IT33RITPM RI L Imode select A Tdi 1 VTT .3v s 10 JTAG Test IT33D1PUT DI1 L data in port PM_A Tck 1 I LVTT 3.3v s 10 JTAG Test IT33D2PUT_ D12 L access port M_A clock General Purpose 1O Group 8 Gpio[3:0] / LVTT 3.3v s 32 ISI BT3335PUT 4 Scanin L interface PMB pins / GPIO Group 9 Gpio['7:4] 4 I/O High 3.3v s 32 LED driver BT3365T P 4 Scanin PCNT Drive pins / MC PROGSR LVTT general OM OSC purpose Input/Outp at Group Gpio[19:812 I/0 LVTT 3.3v s 32 General BT3365PUT 2 Scanin 10 DIAGOU 10 p urpose _PMB Scanout T (aka Input/Outp MRSTRO ut Group Gpio[22:23 0 LVTT 3.3v s 32 General BT3365PUT CEOScan 11 0] L purpose _PMB TESTM3 Input/Outp TSTN1 ut Group Gpio[31:210 [/0 LVTT 3.3v s 32 Functional BT3365TP 6 Scanin 4 12 3] L Spare IOs MC scanout required for scan test Analog Power TO Group agnd 1 1 Power N/A NIA N/A PLL analog AINSD3_PM None 13 gnd _A avdd 1 I Power N/A N/A N/A PLL analog AINSD3_PM None vdd A agnd 1 I Power N/A N/A N/A Oscillator AINSDPM_ None analog gnd A avdd 1 power /A N/A /A Oscillator AINSDPM None WO 2004/050369 PCT/AU2003/001616 580 F I I I I analog vdd IA Test Only Pin Group TE 1 CMO 1.5v N/A N/A Test Enable IC15TEPDT Test only 14 S PMA VPP 1 I CMO 1.5v N/A NIA Fat Wire DRAMVPP_ Test only S Analog PM Receiver/D river for Embedded DRAM Analog Inputs VWP 1 CMO 1.5v N/A N/A Fat Wire DRAMVWP Test only S Analog _PM Receiver/D river for Embedded DRAM Analog Inputs VREFX 1 I CMO 1.5v N/A /A Fat Wire DRAMVREF Test only S Analog XPM Receiver/D river for Embedded DRAM Analog Inputs DLT 1 I CMO 1.5v N/A N/A DRAM IC15DLTPU Test only S Iddq Test TPM MC 1 I CMO 1.5v N/A N/A 10 Mode ICl5MCTP Test only S Control MA DRAME l I CMO 1.5v N/A N/A DRAM IC15LTPUT Testonly N S Enable(EN) _PM_A Total Signal Pins 73 Functional pin count is 62 Test IO count 51 Power Only Pins Group Gnd 8 I Power N/A N/A N/A gnd GNDPMA None 15 Vdd 4 I Power N/A N/A N/A vdd 1.5v, VDD150 P None WO 2004/050369 PCT/AU2003/001616 581 core MA voltage vdd330 I Power N/A N/A NA vdd 3.3v, VDD330_P None Io voltage M_A Group vdd/gnd 11 I Power N/A N/A N/A Power pin GND_PM_A None 15 fill, GND.Vddl VDD150_P .5,Vdd3.3 M_A/ as required VDD330_P M A TotalPins 100 WO 2004/050369 PCT/AU2003/001616 582 BILITHIC PRINTHEADS 1 Background Silverbrook's bilithic MemjetM printheads are the target printheads for printing systems which will be controlled by SoPEC and MoPEC devices. 5 This document presents the format and structure of these printheads, and describes the their possible arrangements in the target systems. It also defines a set of terms used to differentiate between the types of printheads and the systems which use them. BILITHIc PRINTHEAD CONFIGURATIONS 10 2 Definitions This document presents terminology and definitions used to describe the bilithic printhead systems. These terms and definitions are as follows: * Printhead Type - There are 3 parameters which define the type of printhead used in a system: 15 * Direction of the data flow through the printhead (clockwise or anti-clockwise, with the printhead shooting ink down onto the page). * Location of the left-most dot (upper row or lower row, with respect to %1,). * Printhead footprint (type A or type B, characterized by the data pin being on the left or the right of V+, where V+ is at the top of the printhead). 20 * Printhead Arrangement - Even though there are 8 printhead types, each arrangement has to use a specific pairing of printheads, as discussed in Section 3. This gives 4 pairs of printheads. However, because the paper can flow in either direction with respect to the printheads, there are a total of eight possible arrangements, e.g. Arrangement I has a Type 0 printhead on the left with respect to the paper flow, and a Type 1 printhead on the right. 25 Arrangement 2 uses the same printhead pair as Arrangement 1, but the paper flows in the opposite direction. * Color 0 is always the first color plane encountered by the paper. * _Dot 0 is defined as the nozzle which can print a dot in the left-most side of the page. * The Even Plane of a color corresponds to the row of nozzles that prints dot 0. 30 Note that in all of the relevant drawings, printheads should be interpreted as shooting ink down onto the page. Figure 295 shows the 8 different possible printhead types. Type 0 is identical to the Right Printhead presented in Figure 297 in [1], and Type 1 is the same as the Left Printhead as defined in [1]. 35 WO 2004/050369 PCT/AU2003/001616 583 While the printheads shown in Figure 295 look to be of equal width (having the same number of nozzles) it is important to remember that in a typical system, a pair of unequal sized printheads may be used. 2.1 COMBINING BILITHIC PRINTHEADS 5 Although the printheads can be physically joined in the manner shown in Figure 296, it is preferable to provide an arrangment that allows greater spacing between the 2 printheads will be required for two main reasons: * inaccuracies in the backetch * cheaper manufacturing cost due to decreasing the tolerance requirements in sealing the ink 10 reservoirs behind the printhead Failing to account for these inaccuracies and tolerances can lead to misalignment of the nozzle rows both vertically and horizontally, as shown in Figure 297. An even row of color n on printhead A may be vertically misaligned from the even row of color n on 15 printhead B by some number of dots e.g. in Figure 297 this is shown to be 5 dots. And there can also be horizontal misalignment, in that the even row of color n printhead A is not necessarily aligned with the even row of color n+1 on printhead A, e.g. in Figure 297 this horizontal misalignment is 6 dots. 20 The resultant conceptual printhead definition, shown in Figure 297 has properties that are appropriately parameterized in SoPEC and MoPEC to cater for this class of printheads. The preferred printheads can be characterized by the following features: * All nozzle rows are the same length (although may be horizontally displaced some number of 25 dots even within a color on a single printhead) * The nozzles for color n printhead A may not be printing on the same line of the page as the nozzles for color n printhead B. In the example shown in Figure 297, there is a 5 dot displacement between adjacent rows of the printheads. * The exact shape of the join is an arbitrary shape although is most likely to be sloping (if 30 sloping, it could be sloping either direction) * The maximum slope is 2 dots per row of nozzles * Although shift registers are provided in the printhead at the 2 sides of the joined printhead, they do not drive nozzles - this means the printable area is less than the actual shift registers, as highlighted by Figure 298. 35 WO 2004/050369 PCT/AU2003/001616 584 2.2 Printhead Arrangements Table 218 defines the printhead pairing and location of the each printhead type, with respect to the flow of paper, for the 8 possible arrangements Printhead Arrangement Printhead on left side, Printhead on right side, with respect to the flow with respect to the flow of of paper paper Arrangement I Type 0 Type 1 Arrangement 2 Type 1 Type 0 Arrangement 3 Type 2 Type 3 Arrangement 4 Type 3 Type 2 Arrangement 5 Type 4 Type 5 Arrangement 6 Type 5 Type 4 Arrangement 7 Type 6 Type 7 Arrangement 8 ype 7 Type 6 5 3 Bilithic Printhead Systems When using the bilithic printheads, the position of the power/gnd bars coupled with the physical footprint of the printheads mean that we must use a specific pairing of printheads together for printing on the same side of an A4 (or wider) page, e.g. we must always use a Type 0 printhead 10 with a Type 1 printhead etc. While a given printing system can use any one of the eight possible arrangements of printheads, this document only presents two of them, Arrangement 1 and Arrangement 2, for purposes of illustration. These two arrangements are discussed in subsequent sections of this document. 15 However, the other 6 possibilities also need to be considered. The main difference between the two printhead arrangements discussed in this document is the direction of the paper flow. Because of this, the dot data has to be loaded differently in Arrangement 1 compared to Arrangement 2, in order to render the page correctly. 20 3.1 ExAMPLE 1: PRINTHEAD ARRANGEMENT I Figure 299 shows an Arrangement 1 printing setup, where the bilithic printheads are arranged as follows: The Type 0 printhead is on the left with respect to the direction of the paper flow. 25 - The Type 1 printhead is on the right.
WO 2004/050369 PCT/AU2003/001616 585 Table 219 lists the order in which the dot data needs to be loaded into the above printhead system, to ensure color 0-dot 0 appears on the left side of the printed page. Table 219. Order in which the even and odd dots are loaded for printhead Arrangement 1 5 Dot Sense Type 0 printhead Type 1 printhead when on the left when on the right Odd Loaded second in Loaded first in descending order. descending order. Even Loaded first in Loaded second in ascending order. ascending order. Figure 300 shows how the dot data is demultiplexed within the printheads. Figure 301 and Figure 302 show the way in which the dot data needs to be loaded into the print 10 heads in Arrangement 1, to ensure that color 0-dot 0 appears on the left side of the printed page. Note that no data is transferred to the printheads on the first and last edges of SrClk. 3.2 EXAMPLE 2: PRINTHEAD ARRANGEMENT 2 Figure 303 shows an Arrangement 2 printing setup, where the bilithic printheads are arranged as 15 follows: * The Type 1 printhead is on the left with respect to the direction of the paper flow. * The Type 0 printhead is on the right. Table 220 lists the order in which the dot data needs to be loaded into the above printhead system, to ensure color 0-dot 0 appears on the left side of the printed page. 20 Table 220. Order in which the even and odd dots are loaded for printhead Arrangement 2 Dot Sense Type 0 printhead Type 1 printhead when on the right when on the left Odd Loaded first in Loaded second in descending order. descending order. Even Loaded second in Loaded first in ascending order. ascending order. Figure 304 shows how the dot data is demultiplexed within the printheads.
WO 2004/050369 PCT/AU2003/001616 586 Figure 305 and Figure 306 show the way in which the dot data needs to be loaded into the printheads in Arrangement 2, to ensure that color 0-dot 0 appears on the left side of the printed page. 5 Note that no data is transferred to the printheads on the first and last edges of SrClk. 4 Conclusions Comparing the signalling diagrams for Arrangement 1 with those shown for Arrangement 2, it can be seen that the color/dot sequence output for a printhead type in Arrangement 1 is the reverse of 10 the sequence for same printhead in Arrangement 2 in terms of the order in which the color plane data is output, as well as whether even or odd data is output first. However, the order within a color plane remains the same, i.e. odd descending, even ascending. From Figure 307 and Table 221, it can be seen that the plane which has to be loaded first (i.e. even 15 or odd) depends on the arrangement. Also, the order in which the dots have to be loaded (e.g. even ascending or descending etc.) is dependent on the arrangement. As well as having a mechanism to cope with the shape of the join between the printheads, as discussed in Section 2.1, if the device controlling the printheads can re-order the bits according to 20 the following criteria, then it should be able to operate in all the possible printhead arrangements: * Be able to output the even or odd plane first. * Be able to output even and odd planes in either ascending or descending order, inde pendently. * Be able to reverse the sequence in which the color planes of a single dot are output to the 25 printhead. Table 221. Order in which even and odd dots and planes are loaded into the various printhead arrangements Printhead Left side of printed page Right side of printed page Arrangement Arrangement I Even ascending loaded first Odd descending loaded first Odd descending loaded Even ascending loaded second second Arrangement 2 Odd descending loaded first Even ascending loaded first Even ascending loaded Odd descending loaded second second rrangement 3 Odd ascending loaded first Even descending loaded WO 2004/050369 PCT/AU2003/001616 587 Even descending loaded first second Odd ascending loaded second Arrangement 4 Even descending loaded Odd ascending loaded first first Even descending loaded Odd ascending loaded second second Arrangement 5 Odd ascending loaded first Even descending loaded Even descending loaded first second Odd ascending loaded second Arrangement 6 Even descending loaded Odd ascending loaded first first Even descending loaded Odd ascending loaded second second Arrangement 7 Even ascending loaded first Odd descending loaded first Odd descending loaded Even ascending loaded second second Arrangement 8 Odd descending loaded first Even ascending loaded first Even ascending loaded Odd descending loaded second second WO 2004/050369 PCT/AU2003/001616 588 CMOS SUPPORT ON BILITHIC PRINTHEAD 1 Basic Requirements To create a two part printhead, of A4/Letter portrait width to print a page in 2 seconds. Matching Left/Right chips can be of different lengths to make up this length facilitating increased wafer usage. 5 the left and right chips are to be imaged on an 8 inch wafer by "Stitching" reticle images. The memjet nozzles have a horizontal pitch of 32 um, two rows of nozzles are used for a single colour. These rows have a horizontal offset of 16 um. This gives an effective dot pitch of 16 um, or 62.5 dots per mm, or 1587.5 dots per inch, close enough to market as 1600 dpi. The first nozzle of the right chip should have a 32 um horizontal offset from the final nozzle of the 10 left chip for the same color row. There is no ink nozzle overlap (of the same colour) scheme employed. 1.1 POWER SUPPLY Vdd/Vpos and Ground supply is made through 30 um wide pads along the length of the chip using 15 conductive adhesive to bus bar beside the chips. Vdd/Vpos is 3.3 Volts. (1 2V was considered for Vpos but routing of CMOS Vdd at 3.3V would be a problem over the length of the chips, but this will be revisited). 1.2 MEMS CELLS 20 The preferred memjet device requires 180nJ of energy to fire, with a pulse of current for 1 usec. Assuming 95% efficiency, this requires a 55 ohm actuator drawing 57.4 mA during this pulse. 1.2.1 ISSUE!!! For 1 pages per 2 second, or -300 mm * 62.5 (dots/mm) /2 sec ~ 10 kHz or 100 usec per line. 25 With 1 usec fire pulse cycle, every 100th nozzle needs to fire at the same time. We have 13824 nozzles across the page, so we fire 138 nozzles at a time. 1.2.2 64um unit cell height This cell would have 4 line spacing between the odd and even dots, and 8 line spacing between 30 adjacent colours. 1.2.3 80 um unit cell height This cell would have 5 line spacing between the odd and even dots, and 10 line spacing between adjacent colours. 35 WO 2004/050369 PCT/AU2003/001616 589 1.3 Versions 1.3.1 6 Colour 1600 dpi with 64 um unit cell Left and Right Chip. 5 1.3.2 6 Colour 1600 dpi with 80 um unit cell Left and Right Chip. 1.3.3 4 Colour 800 dpi with 80 urn unit cell For camera application. Single nozzle row per colour. 10 1.4 AIR SUPPLY Air must be supplied to the MEMS region through holes in the chip. 2 Head Sizes 15 The combined heads have 13824 nozzles per colour totalling 221.184mm of print area. Enough to provide full breadth for A4 (210 mm) and Letter (8.5 inch or 215.9 mm). Table 1. Head Combinations Left Head Right Head Stitch Parts Nozzles per Colour Stitch Parts Nozzles per Colour 8 11160 2 2664 7 9744 3 4080 6 8328 4 5496 5 6912 5 6912 4 5496 6 8328 3 4080 7 9744 2 2664 8 11160 20 Nozzles per Colour is calculated as (("Stitch Parts" -1)*118+104)*12. Nozzles per row is half this value. Most likely the 8:2 head set will not be manufactured. The preferred wafer layout, manages to avoid this set, without any loses. 3 Interface 25 Each print head has the same 1/O signals (but the Left and Right versions might have a different pin out).
WO 2004/050369 PCT/AU2003/001616 590 Table 2. I/O pins Name 1/O Function Common Max Speed (MHz) Data[0-1] I Dot data for colours 0 - 5, using Differential No 320 Signalling (DataL the complementary signal), colours[0-2] on Data[0], colour[3-5] on Data[1] DataL[0-1] I complementary signal of Data[0-1] SrC/k I Dot data shift clock using Differential Signalling No 320 (SrClkL the complementary signal) SrClkL I complementary signal of SrClk ReadL I FrClk, Pr, LSyncL output mode if signal mode Yes 1 bit is set FrC/k I Fire pattern shift clock Yes 1 O nozzle test result (mode = 0b001), LsyncL = 0 Yes CMOS testing (mode = Ob111), LsyncL = 1 Pr I Pulse Profile for all colours Yes O Temperature Output (mode = Obl0), LsyncL =Yes) 0 CMOS testing (mode = Ob1 11), LsyncL = 1 LsyncL I 0 - Capture dot data for next print line es 0.14 O CMOS testing (mode = Ob1 11), LsyncL = 1 Yes) 5 Pins marked as common can be controlled by the same signal from the controller (SOPEC). 3.1 DOT FIRING To fire a nozzle, three signals are needed. A dot data, a fire signal, and a profile signal. When all signals are high, the nozzle will fire. 10 Functionally could be common, but for timing/electrical reasons should run point to point. 2 Can be shared if one side has mode=0b000 3 1 MHz cycle, but the resolution of the mark/space ratio may require 50 ns. 4 10 kHz cycle, with minimum low pulse of 10 ns (no maximum).
WO 2004/050369 PCT/AU2003/001616 591 The dot data is provide to the chip through a dot shift register with input Data[x, and clocked into the chip with SrCk. The dot data is multiplex on to the Data signals, as Dot[0-2] on Data[0], and Dot[3-5] on Data[2]. After the dots are shifted into the dot shift register, this data is transfer into the dot latch, with a low pulse in LsyncL. The value in the dot latch forms the dot data used to fire the 5 nozzle. The use of the dot latch allows the next line of data to be loaded into the dot shift register, at the same time the dot pattern in the dot latch is been fired. Across the top of a column of nozzles, containing 12 nozzles, 2 of each colour (odd and even dots, 4 or 5 lines apart), is two fire register bits and a select register bit. The fire registers forms the fire 10 shift register that runs length of the chip and back again with one register bit in each direction flow. The select register forms the Select Shift Register that runs the length of the chip. The select register, selects which of the two fire registers is used to enables this column. A ' in this register selects the forward direction fire register, and a '1' selects the reverse direction fire register. This output of this block provides the fire signal for the column. 15 The third signal needed, the profile, is provide for all colours with input Pr across the whole colour row at the same time (with a slight propagation delay per column). 3.2 DOT SHIFT REGISTER ORIENTATION 20 The left side print head (chip) and the right side print head that form complete bi-lithic print head, have different nozzle arrangement with respect to the dot order mapping of the dot shift register to the dot position on the page. With this mapping, the following data streams will need to provided. Left Head Right Head Size n-m dot order 7:3 97 44 [13822,13820,13818,...,4084,4082,4080,] line y+5 40 80 [1,3,5,...,4075,4077,4079,] line y [4081,4083,4085,...,13819,13821,13823] line y [4078,4076,4074,...,4,2,0]1 line y+5 6:4 83 28 [13822,13820,13818,...,5500,5498,5496,] line y+5 54 96 [1,3,5,...,5491,5493,5495,] line y [5497,5499,5501,...,13819,13821,13823] line y [5494,5492,5490,...,4,2,0] line y+5 5:5 69 12 [13822,13820,13818,...,6916,6914,6912,] line y+5 69 12 (1,3,5,...,6907,6909,6911,]1 line y [6913,6915,6917,...,13819,13821,13823] line y [6910,6908,6906,...,4,2,0] line y+5 4:6 54 96 [13822,13820,13818,...,8332,8330,8328,] line y+5 83 28 [1,3,5,...,8323,8325,8327,] line y [8329,8331,8333,...,13819,13821,13823] line y [8326,8324,8322,...,4,2,0] line y+5 3:7 4080 [13822,13820,13818,...,9748,9746,9744,] line y+5 97 44 [1,3,5,...,9739,9741,9743,] line y [9745,97447,9749,...,13819,13821,13823] line y 9742,9740,9738,...,4,2,0] line y+5 WO 2004/050369 PCT/AU2003/001616 592 The data needs to be multiplexed onto the data pins, such that Data[O] has {(CO, C1, C2), (CO, C1, C2)....} in the above order, and Data[1] has {(C3, C4, C5), (C3, C4, C5) .. }. Figure 311 shows the timing of data transfer during normal printing mode. Note SrC/k has a default 5 state of high and data is transferred on both edges of SrC/k. If there are L nozzles per colour, SrC/k would have L+2 edges, where the first and last edges do not transfer data. Data requires a setup and hold about the both edges of SrClk. Data transfers starts on the first rising after LSyncL rising. SrC/k default state is high and needs to return to high after the last data of 10 the line. This means the first edge of SrC/k (falling) after LSyncL rising, and the last edge of SrC/k as it returns to the default state, no data is transferred to the print head. LSyncL rising requires setup to the first falling SrC/k, and must stay high during the entire line data transfer until after last rising SrC/k. 15 3.3 FIRE SHIFT REGISTER The fire shift register controls the rate of nozzle fire. If the register is full of 'l's then the you could print the entire print head in a single FrCik cycle, although electrical current limitations will prevent this happening in any reasonable implementation. 20 Ideally, a '1' is shifted in to the fire shift register, in every nt position, and a '0' in all other position. In this manner, after n cycles of FrC/k, the entire print head will be printed. The fire shift register and select shift registers allow the generation of a horizontal print line that on close inspection would not have a discontinuity of a "saw tooth" pattern, Figure 312 a) & b) but a 25 "sharks tooth" pattern of c). This is done by firing 2 nozzles in every 2n group of nozzle at the same time starting from the outer 2 nozzles working towards the centre two (or the starting from the centre, and working towards the outer two) at the fire rate controlled by FrClk. 30 To achieve this fire pattern the fire shift register and select shift register need to be set up as show in Figure 313 . The pattern has shifted a '1' into the fire shift register every nth positions (where n is usually is a 35 minimum of about 100) and n 'l's, followed n '0's in the select shift register. At a start of a print cycle, these patterns need to be aligned as above, with the "1000..." of a forward half of fire shift register, matching an n grouping of '1' or '0's in the select shift register. As well, with the "1000..." of WO 2004/050369 PCT/AU2003/001616 593 a reverse half of the fire shift register, matching an n grouping of '1' or '0's in the select shift register. And to continue this print pattern across the butt ends of the chips, the select shift register in each should end with a complete block of n 'l's (or 'O's). 5 Since the two chips can be of different lengths, initialisation of these patterns is an issue. This is solved by building initialisation circuitry into chips. This circuit is controlled by two registers, nlen(14) and count(1 4) and b(1). These registers are loaded serially through Data[O], while LSyncL is low, and ReadL is high with FrClk. 10 The scan order from input is b, n[13-0],c[0-13],color[5-0], mode[2-0] therefore b is shifted in last. The system color and mode registers are unrelated to the Fire Shift Register, but are loaded at the same time as this block. There function is described later. Table 4. Head Combinations Initialisation for n=100 Nozzle s Nozzle s nien(AaB)= countA = b A b B rem= countB LB LA n-1 (LA/2) mod n (L 8 /2) mod n (LA-LB+rem) mod n -1 -1 4080 9744 99 71 0 0 40 3 5496 8328 99 63 0 0 48 79 6912 6912 99 55 0 0 56 55 15 The following table shows the values to programme the bi-lithic head pairs using a fire pattern length of 100. The calculation assumes head 'A' is the longest head of the pair and once the registers are initialised with LA FrClk cycles (ReadL='0', LSyncL='1'). rem would be the correct value for countB if chip B was only clocked (FrClk) LB times. But this chip will be over clocked LA-1-B 20 cycles. The values of bA and bB are either the same or inverse of each other. The actually value does not matter. They need to be different from each other if the select shift registers would end up with different values at the butt ends. If (LA/2n) is even (and countA is non zero), then the final run in 'A's select shift register will be !bA. If (LA-LB/2) mod n is even (and countB is non zero) then the final run in 'B's select shift register will be !bB. 25 WO 2004/050369 PCT/AU2003/001616 594 3.4 SYSTEM REGISTERS As describe above, the Fire Shift Register generation block, also contains some system registers. Table 5. System Registers Name Size Function Color 6 Each bit is an enable for the corresponding colour. If color[X]=O, then Prx is 0 and SrClkx is 0. If color[X]=1, then Prxfollows the Pr signal and SrClk, is deserialised SrClk. Mode 3 Mode[0] = 1, then FrClk pin is used as an output, internally the FrClk signal is set to 0 Mode[1] = 1, then Pr pin is used as an output, internally the Pr signal is set to 0 Mode[2] = 1, then LsyncL pin is used as an output, internally the LsyncL signal is set to 1 5 3.5 PROFILE PATTERN A profile pattern is repeated at FrClk rate. It is expected to be a single pulse about 1 us long. But it could be a more complicated series of pulse. The actual pattern depends on the ink type. The following figure show the external timing to print a line of data. In this example the line is printed 10 in 8 cycles of FrCk. 3.6 INTERFACE MODES The print head has eight different modes controlled by signals ReadL and LSyncL and system mode register. As seen in Figure 318 with both LSyncL and ReadL high, the chip in normal 15 printing mode. Some of these modes can operate at the same time, but may interfere with the result of the other modes. Table 6. Print Head Modes ReadL LSyncL Function Mode Internal Mapping Registe r 1 1 Normal Print Mode 000 (XXX) SrClk=SrClk/3 frclk=FrClk SelClk=0 FsClk=FrClk Scan=O CoreScan=0 WO 2004/050369 PCT/AU2003/001616 595 ( 0 Dot Load Mode 000 (XXX) " Dot latches are open, loaded with Dot shift registers, latch once LSyncL returns to I (this happens regardless of ReadL) " Enables Dot Shift register to capture fire result. 1 0 Fire Load Mode 000 (XXX) SrClk=X * Data[O] will shift through mode, color, nlen, frclk=X count and b with FrC/k SelClk=X FsClk=FrClk Scan=1 CoreScan=X 0 1 Reset Nozzle Test 001 SrClk=SrClk * Resets the state of nozzle test circuit FrClk=FrClk SelClk=FrClk FsClk=FrClk Scan=0 CoreScan=1 0 1 CMOS testing mode 111 e The contents of the dot shift registers are serial shifted out on LsyncL (colourO-1), FrCIk (colour2-3), Pr (colour4-5) with SrC/k 0 1 Fire Initialise mode 000 (XXO) * The contents of the fire shift register and select shift register is generated with FrCik 0 0 Temperature Output 010 SrClk=X * The series of Sigma Delta output are frclk=O clocked out on Pr with FrC/k. The sum of SelClk=O these bits represent the temperature of the FsClk=0 chip. Scan=0 CoreScan=X 0 0 Nozzle Test Output 001 * The result of a nozzle test is output on FrClk. 3.6.1 Printing WO 2004/050369 PCT/AU2003/001616 596 Figure 318 shows show timing for normal printing. During this action, we drop out of Normal Print Mode, to Dot Load Mode between line transfers. For printing to perform correctly, all other signals should be stable. 5 3.6.2 Initialising for Printing To initialise for printing the fire shift registers and select shift registers need to be setup into a state as shown in Figure 318 . To do this the chips are put into Fire Load Mode and the values for nien, count and b are serially shifted from Data[0] clocked by FrClk. As the two chip have separate Data line, and common FrClk, this happens at the same time. Once this is done, mode is changed to Fire 10 Initialise Mode, and further LA FrClk cycles are provided to both chips. During all these operation Pr should be low, to prevent unintentional firing for nozzles. 3.6.3 Nozzle Testing Nozzle testing is done by firing a single nozzle at a time and monitoring the FrClk pin in the Nozzle 15 Test Output mode. Each nozzle has a test switch which closes when the nozzle is fired with an energy level greater than required for normal ink ejection. All 12 switches in a nozzle column are connect in parallel to the following circuit. 20 This circuit is initialised when ever LSyncL is high and ReadL is low (Reset Nozzle Test mode). This forces all "switch nodes" to low, and the feedback through lower NOR gate will latches this value. With LSyncL low and ReadL still low (Nozzle Test Output mode) the Testout of the first nozzle column is output on FrClk. If any switch is closed, the switch node of this column will be pulled up, and will ripple through to the output as transition from high to low. 25 Nozzle testing requires a setup phase in order to fire only one nozzle. There are many ways to achieve this. Simplest might be to load a single colour with 101010 through the even nozzles, and 010101... for the odd nozzles (O's for all other colours), and set up a fire pattern with n = LA/2. With this fire pattern only one nozzle will fire in each Pr pulse. After firing in Nozzle Test Output mode, a 30 single FrC/k will advance to next nozzle, then Reset and Test. After LA/2 cycles of this testing, a single SrC/k will advance the dot shift registers to setup the untested nozzles of this colour, and another LA/2 cycles of FrC/k, Reset and Test will finished testing this colour. Then repeat test procedure for other colours. 35 3.6.4 Temperature Output This mode is not well defined yet. In this mode, Pr will output a series of ones and zeros clocked by FrCk. After a (currently unknown) number of FrClk cycles the sum of this series will represent the WO 2004/050369 PCT/AU2003/001616 597 temperature of the chip. Clocking frequency in this mode it expected to be in the range 10kHz 1 MHz. The Frequency of FrC/k and the number of cycles need to be programmable. Since this mode 5 cycles FrC/k, the result of fire shift register and select shift register would be changed, but in this mode FrC/k is disabled to these circuit. So printing can resume without reinitialising. 3.6.5 CMOS Testing CMOS testing is a mode meant for chip testing before MEMS as added to the chip. This mode 10 allows the dot shift register to be shifted out on the LsyncLFrClk and Pr pins. Much like the nozzle test mode, the nozzles are fired while LSyncL is low, but during the firing SrC/k will be pulsed, loading the dot shift register with the signal that would fire the nozzle. Once captured, the result can be shifted out. 15 The Dot Load Mode above violates normal printing procedure by firing the nozzles (Pr) and modify the dot shift register (SrCk). 4 RETICLE LAYOUT To make long chips we need to stitch the CMOS (and MEMS) together by overlapping the reticle 20 stepping field. The reticle will contain two areas: The top edge of Area 2, PAD END contains the pads that stitch on bottom edge of Area 1, CORE. Area 1 contains the core array of nozzle logic. The top edge of Area I will stitch to the bottom edge of itself. Finally the bottom edge of Area 2, BUTT END will stitch to the top edge of Area 1. The 25 BUTT END to used to complete a feedback wiring and seal the chip. The above region will then be exposed across a wafer bottom to top. Area 2, Area 1, Area 1...., Area 2. Only the PAD END of Area 2 needs to fit on the wafer. The final exposure of Area 2 only requires the BUTT END on the wafer. 30 4.1 TSMC U-FRAME REQUIREMENTS. TSMC will be building us frames 10 mm x 0.23 mm which will be placed either side of both Area I and Area 2. 35 TSMC requires 6 mm area for blading between the two exposure area. This translates to 3 mm on the reticle, as some reticules are 2x size, while most are 5x, the worst case must be used.
WO 2004/050369 PCT/AU2003/001616 598 SECURITY OVERVIEW 1 Introduction A number of hardware, software and protocol solutions to security issues have been 5 developed. These range from authorization and encryption protocols for enabling secure communication between hardware and software modules, to physical and electrical systems that protect the integrity of integrated circuits and other hardware. It should be understood that in many cases, principles described with reference to 10 hardware such as integrated circuits (ie, chips) can be implemented wholly or partly in software running on, for example, a computer. Mixed systems in which software and hardware (and combinations) embody various entities, modules and units can also be constructed using may of these principles, particularly in relation to authorization and authentication protocols. The particular extent to which the principles described below 15 can be translated to or from hardware or software will be apparent to one skilled in the art, and so will not always explicitly be explained. It should also be understood that many of the techniques disclosed below have application to many fields other than printing. Some specific examples are described 20 towards the end of this description. A "QA Chip" is a quality assurance chip can allows certain security functions and protocols to be implemented. The preferred QA Chip is described in some detail later in this specification. 25 1.5 QA CHIP TERMINOLOGY The Authentication Protocols documents [5] and [61 refer to QA Chips by their function in particular protocols: * For authenticated reads in [5], ChipR is the QA Chip being read from, and ChipT is the QA 30 Chip that identifies whether the data read from ChipR can be trusted. ChipR and ChipT are referred to as Untrusted QA Device and Trusted QA Device respectively in [6]. * For replacement of keys in [5], ChipP is the QA Chip being programmed with the new key, and ChipF is the factory QA Chip that generates the message to program the new key. ChipF is referred to as the Key Programmer QA Device in [6]. 35 9 For upgrades of data in memory vectors in [5], ChipU is the QA Chip being upgraded, and ChipS is the QA Chip that signs the upgrade value. ChipS is referred to as the Value Upgrader QA Device and Parameter Upgrader QA Device in [6].
WO 2004/050369 PCT/AU2003/001616 599 Any given physical QA Chip will contain functionality that allows it to operate as an entity in some number of these protocols. Therefore, wherever the terms ChipR, ChipT, ChipP, ChipF, ChipU and ChipS are used in this 5 document, they are referring to logical entities involved in an authentication protocol as defined in [5] and [6]. Physical QA Chips are referred to by their location. For example, each ink cartridge may contain a QA Chip referred to as an INK_QA, with all INKQA chips being on the same physical bus. In the 10 same way, the QA Chip inside the printer is referred to as PRINTERQA, and will be on a separate bus to the INK_QA chips. 2 Requirements 2.1 SECURITY 15 When applied to a printing environment, the functional security requirements for the preferred embodiment are: * Code of QA chip owner or licensee co-existing safely with code of authorized OEMs * Chip owner/licensee operating parameters authentication * Parameters authentication for authorized OEMs 20 e Ink usage authentication Each of these is outlined in subsequent sections. The authentication requirements imply that: * OEMs and end-users must not be able to replace or tamper with QA chip 25 manufacturer/owner's program code or data * OEMs and end-users must not be able to perform unauthorized activities for example by calling chip manufacturer/owner's code * End-users must not be able to replace or tamper with OEM program code or data * End-users must not be able to call unauthorized functions within OEM program code 30 * Manufacturer/owner's development program code must not be capable of running on all SoPECs. * OEMs must be able to test products at their highest upgradable status, yet not be able to ship them outside the terms of their license * OEMs and end-users must not be able to directly access the print engine pipeline (PEP) 35 hardware, the LSS Master (for QA Chip access) or any other peripheral block with the exception of operating system permitted GPIO pins and timers.
WO 2004/050369 PCT/AU2003/001616 600 2.1.1 QA Manufacturer/owner code and OEM program code co-existing safely SoPEC includes a CPU that must run both manufacturer/owner program code and OEM program code. The execution model envisaged for SoPEC is one where Manufacturer/owner program code forms an operating system (O/S), providing services such as controlling the print engine pipeline, 5 interfaces to communications channels etc. The OEM program code must run in a form of user mode, protected from harming the Manufacturer/owner program code. The OEM program code is permitted to obtain services by calling functions in the O/S, and the O/S may also call OEM code at specific times. For example, the OEM program code may request that the O/S call an OEM interrupt service routine when a particular GPIO pin is activated. 10 In addition, we may wish to permit the OEM code to directly call functions in Manufacturer/owner code with the same permissions as the OEM code. For example, the Manufacturer/owner code may provide SHAl as a service, and the OEM could call the SHA1 function, but execute that function with OEM permissions and not Silverbook permissions. 15 A basic requirement then, for SoPEC, is a form of protection management, whereby Manufacturer/owner and OEM program code can co-exist without the OEM program code damaging operations or services provided by the Manufacturer/owner O/S. Since services rely on SoPEC peripherals (such as USB2 Host, LSS Master, Timers etc) access to these peripherals 20 should also be restricted to Manufacturer/owner program code only. 2.1.2 Manufacturer/owner operating parameters authentication A particular OEM will be licensed to run a Print Engine with a particular set of operating parameters (such as print speed or quality). The OEM and/or end-user can upgrade the operating license for a 25 fee and thereby obtain an upgraded set of operating parameters. Neither the OEM nor end-user should be able to upgrade the operating parameters without paying the appropriate fee to upgrade the license. Similarly, neither the OEM nor end-user should be able to bypass the authentication mechanism via any program code on SoPEC. This implies that OEMs 30 and end-users must not be able to tamper with or replace Manufacturer/owner program code or data, nor be able to call unauthorized functions within Manufacturer/owner program code. However, the OEM must be capable of assembly-line testing the Print Engine at the upgraded status before selling the Print Engine to the end-user. 35 WO 2004/050369 PCT/AU2003/001616 601 2.1.3 OEM operating parameters authentication The OEM may provide operating parameters to the end-user independent of the Manufacturer/owner operating parameters. For example, the OEM may want to sell a franking machine'. 5 The end-user should not be able to upgrade the operating parameters without paying the appropriate fee to the OEM. Similarly, the end-user should not be able to bypass the authentication mechanism via any program code on SoPEC. This implies that end-users must not be able to tamper with or replace OEM program code or data, as well as not be able to tamper with the PEP 10 blocks or service-related peripherals. 2.2 ACCEPTABLE COMPROMISES If an end user takes the time and energy to hack the print engine and thereby succeeds in upgrading the single print engine only, yet not be able to use the same keys etc on another print 15 engine, that is an acceptable security compromise. However it doesn't mean we have to make it totally simple or cheap for the end-user to accomplish this. Software-only attacks are the most dangerous, since they can be transmitted via the internet and have no perceived cost. Physical modification attacks are far less problematic, since most printer 20 users are not likely to want their print engine to be physically modified. This is even more true if the cost of the physical modification is likely to exceed the price of a legitimate upgrade. 2.3 IMPLEMENTATION CONSTRAINTS Any solution to the requirements detailed in Section 2.1 should also meet certain preferred 25 implementation constraints. These are: * No flash memory inside SoPEC * SoPEC must be simple to verify * Manufacturer/owner program code must be updateable * OEM program code must be updateable 30 * Must be bootable from activity on USB2 * Must be bootable from an external ROM to allow stand-alone printer operation * No extra pins for assigning IDs to slave SoPECs * Cannot trust the comms channel to the QA Chip in the printer (PRINTERQA) * Cannot trust the comms channel to the QA Chip in the ink cartridges (INKQA) la franking machine prints stamps WO 2004/050369 PCT/AU2003/001616 602 e Cannot trust the USB comms channel These constraints are detailed below. 2.3.1 No flash memory inside SoPEC 5 The preferred embodiment of SoPEC is intended to be implemented in 0.13 micron or smaller. Flash memory will not be available in any of the target processes being considered. 2.3.2 SoPEC must be simple to verify All combinatorial logic and embedded program code within SoPEC must be verified before 10 manufacture. Every increase in complexity in either of these increases verification effort and increases risk. 2.3.3 Manufacturer/owner program code must be updateable It is neither possible nor desirable to write a single complete operating system that is: 15 * verified completely (see Section 2.3.1) * correct for all possible future uses of SoPEC systems * finished in time for SoPEC manufacture Therefore the complete Manufacturer/owner program code must not permanently reside on SoPEC. It must be possible to update the Manufacturer/owner program code as enhancements to 20 functionality are made and bug fixes are applied. In the worst case, only new printers would receive the new functionality or bug fixes. In the best case, existing SoPEC users can download new embedded code to enable functionality or bug fixes. Ideally, these same users would be obtaining these updates from the OEM website or equivalent, 25 and not require any interaction with Manufacturer/owner. 2.3.4 OEM program code must be updateable Given that each OEM will be writing specific program code for printers that have not yet been conceived, it is impossible for all OEM program code to be embedded in SoPEC at the ASIC 30 manufacture stage. Since flash memory is not available (see Section 2.3.1), OEMs cannot store their program code in on-chip flash. While it is theoretically possible to store OEM program code in ROM on SoPEC, this would entail OEM-specific ASICs which would be prohibitively expensive. Therefore OEM program 35 code cannot permanently reside on SoPEC.
WO 2004/050369 PCTIAU2003/001616 603 Since OEM program code must be downloadable for SoPEC to execute, it should therefore be possible to update the OEM program code as enhancements to functionality are made and bug fixes are applied. 5 In the worst case, only new printers would receive the new functionality or bug fixes. In the best case, existing SoPEC users can download new embedded code to enable functionality or bug fixes. Ideally, these same users would be obtaining these updates from the OEM website or equivalent, and not require any interaction with Manufacturer/owner. 10 2.3.5 Must be bootable from activity on USB2 SoPEC can be placed in sleep mode to save power when printing is not required. RAM is not preserved in sleep mode. Therefore any program code and data in RAM will be lost. However, SoPEC must be capable of being woken up by the host when it is time to print again. In the case of a single SoPEC system, the host communicates with SoPEC via USB2. From 15 SoPEC's point of view, it is activity on the USB2 device port that signals the time to wake up. In the case of a multi-SoPEC system, the host typically communicates with the Master SoPEC chip (as above), and then the Master relays messages to other Slave SoPECs by sending data out USB2 host port(s) and into the Slave SoPEC's device port. The net result is that the Slave SoPECs and the Master SoPEC all boot as a result of activity on the USB2 device port. 20 Therefore SoPEC must be capable of being woken up by activity on the USB2 device port. 2.3.6 Must be bootable from an external ROM to allow stand-alone printer operation SoPEC must also support the case where the printer is not connected to a PC (or the PC is currently turned off), and a digital camera or equivalent is plugged into the SoPEC-based printer. In 25 this case, the entire printing application needs to be present within the hardware of the printer. Since the Manufacturer/owner program code and OEM program code will vary depending on the application (see Section 2.3.3 and Section 2.3.4), it is not possible to store the program in SoPEC's ROM. 30 Therefore SoPEC requires a means of booting from a non-PC host. It is possible that this could be accomplished by the OEM adding a USB2-host chip to the printer and simulating the effect of a PC, and thereby download the program code. This solution requires the boot operation to be based on USB2 activity (see Section 2.3.5). However this is an unattractive solution since it adds microprocessor complexity and component cost when only a ROM-equivalent was desired. 35 As a result SoPEC should ideally be able to boot from an external ROM of some kind. Note that booting from an external ROM means first booting from the internal ROM, and then downloading and authenticating the startup section of the program from the external ROM. This is not the same WO 2004/050369 PCTIAU2003/001616 604 as simply running program code in-situ within an external ROM, since one of the security requirements was that OEMs and end-users must not be able to replace or tamper with Manufacturer/owner program code or data, i.e. we never want to blindly run code from an external ROM. 5 As an additional point, if SoPEC is in sleep mode, SoPEC must be capable of instigating the boot process due to activity on a programmable GPIO. e.g. a wake-up button. This would be in addition to the standard power-on booting. 10 2.3.7 No extra pins to assign IDs to slave SoPECs In a single SoPEC system the host only sends data to the single SoPEC. However in a multi SoPEC system, each of the slaves needs to be uniquely identifiable in order to be able for the host to send data to the correct slave. 15 Since there is no flash on board SoPEC (Section 2.3.1) we are unable to store a slave ID in each SoPEC. Moreover, any ROM in each SoPEC will be identical. It is possible to assign n pins to allow 2" combinations of IlDs for slave SoPECs. However a design goal of SoPEC is to minimize pins for cost reasons, and this is particularly true of features only used 20 in multi-SoPEC systems. The design constraint requirement is therefore to allow slaves to be IDed via a method that does not require any extra pins. This implies that whatever boot mechanism that satisfies the security requirements of Section 2.1 must also be able to assign IlDs to slave SoPECs. 25 2.3.8 Cannot trust the comms channel to the QA Chip in the printer (PRINTER QA) If the printer operating parameters are stored in the non-volatile memory of the Print Engine's on board PRINTERQA chip, both Manufacturer/owner and OEM program code cannot rely on the communication channel being secure. It is possible for an attacker to eavesdrop on communications 30 to the PRINTERQA chip, replace the PRINTER__QA chip and/or subvert the communications channel. It is also possible for this to be true during manufacture of the circuit board containing the SoPEC and the PRINTERQA chip. 2.3.9 Cannot trust the comms channel to the QA Chip in the ink cartridges (INK QA) 35 The amount of ink remaining for a given ink cartridge is stored in the non-volatile memory of that ink cartridge's INK_QA chip. Both Manufacturer/owner and OEM program code cannot rely on the communication channel to the INK_QA being secure. It is possible for an attacker to eavesdrop on WO 2004/050369 PCTIAU2003/001616 605 communications to the INK_QA chip, to replace the INKQA chip and/or to subvert the communications channel. It is also possible for this to be true during manufacture of the consumable containing the INKQA chip. 5 2.3.10 Cannot trust the inter-SoPEC comms channel (USB2) In a multi-SoPEC system, or in a single-SoPEC system that has a non-USB2 connection to the host, a given SoPEC will receive its data over a USB2 host port. It is quite possible for an end-user to insert a chip that eavesdrops on and/or subverts the communications channel (for example performs man-in-the-middle attacks). 10 3 Proposed Solution A proposed solution to the requirements of Section 2, can be summarised as: * Each SoPEC has a unique id * CPU with user/supervisor mode 15 * Memory Management Unit * The unique id is not cached * Specific entry points in O/S * Boot procedure, including authentication of program code and operating parameters * SoPEC physical identification 20 3.1 EACH SoPEC HAS A UNIQUE ID Each SoPEC needs to contains a unique SoPECid of minimum size 64-bits. This SoPECid is used to form a symmetric key unique to each SoPEC: SoPECid_key. On SoPEC we make use of an additional 112-bit ECID 2 macro that has been programmed with a random number on a per-chip basis. 25 Thus SoPEC_id is the 112-bit macro, and the SoPECidc_key is a 160-bit result obtained by SHA1(SoPECid). The verification of operating parameters and ink usage depends on SoPECid being difficult to determine. Difficult to determine means that someone should not be able to determine the id via 30 software, or by viewing the communications between chips on the board. If the SoPECid is available through running a test procedure on specific test pins on the chip, then depending on the ease by which this can be done, it is likely to be acceptable. 2Electronic Chip Id WO 2004/050369 PCTIAU2003/001616 606 It is important to note that in the proposed solution, compromise of the SoPECid leads only to compromise of the operating parameters and ink usage on this particular SoPEC. It does not compromise any other SoPEC or all inks or operating parameters in general. 5 It is ideal that the SoPECid be random, although this is unlikely to occur on standard manufacture processes for ASICs. If the id is within a small range however, it will be able to be broken by brute force. This is why 32-bits is not sufficient protection. 3.2 CPU WITH USER/SUPERVISOR MODE 10 SoPEC contains a CPU with direct hardware support for user and supervisor modes. At present, the intended CPU is the LEON (a 32-bit processor with an instruction set according to the IEEE-1 754 standard. The IEEE1 754 standard is compatible with the SPARC V8 instruction set). Manufacturer/owner (operating system) program code will run in supervisor mode, and all OEM 15 program code will run in user mode. 3.3 MEMORY MANAGEMENT UNIT SoPEC contains a Memory Management Unit (MMU) that limits access to regions of DRAM by defining read, write and execute access permissions for supervisor and user mode. Program code 20 running in user mode is subject to user mode permission settings, and program code running in supervisor mode is subject to supervisor mode settings. A setting of 1 for a permission bit means that type of access (e.g. read, write, execute) is permitted. A setting of 0 for a read permission bit means that that type of access is not permitted. 25 At reset and whenever SoPEC wakes up, the settings for all the permission bits are 1 for all supervisor mode accesses, and 0 for all user mode accesses. This means that supervisor mode program code must explicitly set user mode access to be permitted on a section of DRAM. 30 Access permission to all the non-valid address space should be trapped, regardless of user or supervisor mode, and regardless of the access being read, execute, or write. Access permission to all of the valid non-DRAM address space (for example the PEP blocks) is supervisor read / write access only (no supervisor execute access, and user mode has no acccess 35 at all) with the exception that certain GPIO and Timer registers can also be accessed by user code. These registers will require bitwise access permissions. Each peripheral block will determine how the access is restricted.
WO 2004/050369 PCTIAU2003/001616 607 With respect to the DRAM and PEP subsystems of SoPEC, typically we would set user read/write/execute mode permissions to be 1/1/0 only in the region of memory that is used for OEM program data, 1/0/1 for regions of OEM program code, and 0/0/0 elsewhere (including the trap table). By contrast we would typically set supervisor mode read/write/execute permissions for this 5 memory to be 1/1/0 (to avoid accidentally executing user code in supervisor mode). The SoPEC id parameter (see Section 3.1) should only be accessible in supervisor mode, and should only be stored and manipulated in a region of memory that has no user mode access. 10 3.4 UNIQUE ID IS NOT CACHED The unique SoPECid needs to be available to supervisor code and not available to user code. This is taken care of by the MMU (Section 3.3). However the SoPECId must also not be accessable via the CPU's data cache or register windows. 15 For example, if the user were to cause an interrupt to occur at a particular point in the program execution when the SoPECid was being manipulated, it must not be possible for the user program code to turn caching off and then access the SoPECid inside the data cache. This would bypass any MMU security. 20 The same must be true of register windows. It must not be possible for user mode program code to read or modify register settings in a supervisor program's register windows. This means that at the least, the SoPEC id itself must not be cacheable. Likewise, any processed form of the SoPECId such as the SoPEC id key (e.g. read into registers or calculated expected 25 results from a QAChip) should not be accessable by user program code. 3.5 SPECIFIC ENTRY POINTS IN O/S Given that user mode program code cannot even call functions in supervisor code space, the question arises as how OEM programs can access functions, or request services. The 30 implementation for this depends on the CPU. On the LEON processor, the TRAP instruction allows programs to switch between user and supervisor mode in a controlled way. The TRAP switches between user and supervisor register sets, and calls a specific entry point in the supervisor code space in supervisor mode. The TRAP 35 handier dispatches the service request, and then returns to the caller in user mode.
WO 2004/050369 PCTIAU2003/001616 608 Use of a command dispatcher allows the O/S to provide services that filter access -e.g. a generalised print function will set PEP registers appropriately and ensure QA Chip ink updates occur. 5 The LEON also allows supervisor mode code to call user mode code in user mode. There are a number of ways that this functionality can be implemented. It is possible to call the user code without a trap, but to return to supervisor mode requires a trap (and associated latency). 3.6 BOOT PROCEDURE 10 3.6.1 Basic premise The intention is to load the Manufacturer/owner and OEM program code into SoPEC's RAM, where it can be subsequently executed. The basic SoPEC therefore, must be capable of downloading program code. However SoPEC must be able to guarantee that only authorized Manufacturer/owner boot programs can be loaded, otherwise anyone could modify the O/S to do 15 anything, and then load that - thereby bypassing the licensed operating parameters. We perform authentication of program code and data using asymmetric (public-key) digital signatures and without using a QA Chip. 20 Assuming we have already downloaded some data and a 160-bit signature into eDRAM, the boot loader needs to perform the following tasks: * perform SHA-1 on the downloaded data to calculate a digest localDigest * perform asymmetric decryption on the downloaded signature (160-bits) using an asymmetric public key to obtain authorizedDigest 25 If authorizedDigest is the PKCS#1 (patent free) form of localDigest, then the downloaded data is authorized (the signature must have been signed with the asymmetric private key) and control can then be passed to the downloaded data Asymmetric decryption is used instead of symmetric decryption because the decrypting key must be held in SoPEC's ROM. If symmetric private keys are used, the ROM can be probed and the security 30 is compromised. The procedure requires the following data item: a bootOkey = an n-bit asymmetric public key 35 The procedure also requires the following two functions: 0 SHA-1= a function that performs SHA-1 on a range of memory and returns a 160-bit digest WO 2004/050369 PCTIAU2003/001616 609 decrypt = a function that performs asymmetric decryption of a message using the passed-in key PKCS#1 form of localDigest is 2048-bits formatted as 5 follows: bits 2047-2040 = OxOO, bits 2039-2032 = 0x01, bits 2031-288 0xFF..0xFF, bits 287-160 0x003021300906052B0E03021A05000414, bits 159-0 localDigest. For more information, see PKCS#l v2.1 section 9.2 10 Assuming that all of these are available (e.g. in the boot ROM), boot loader 0 can be defined as in the following pseudocode: bootloaderO(data, sig) localDigest +- SHA-1(data) 15 authorizedDigest +- decrypt (sig, bootOkey) expectedDigest 0x00x01|0xFF. .OxFF[ 0x003021300906052B0E03021A05000414 llocalDigest) / "I" = concat If (authorizedDigest == expectedDigest) 20 jump to program code at data-start address// will never return Else // program code is unauthorized Endlf 25 The length of the key will depend on the asymmetric algorithm chosen. The key must provide the equivalent protection of the entire QA Chip system - if the Manufacturer/owner O/S program code can be bypassed, then it is equivalent to the QA Chip keys being compromised. In fact it is worse because it would compromise Manufacturer/owner operating parameters, OEM operating parameters, and ink authentication by software downloaded off the net (e.g. from some hacker). 30 In the case of RSA, a 2048-bit key is required to match the 160-bit symmetric-key security of the QA Chip. In the case of ECDSA, a key length of 132 bits is likely to suffice. RSA is convenient because the patent (US patent number 4,405,829) expired in September 2000. 35 There is no advantage to storing multiple keys in SoPEC and having the extemal message choose which key to validate against, because a compromise of any key allows the external user to always select that key.
WO 2004/050369 PCTIAU2003/001616 610 There is also no particular advantage to having the boot mechanism select the key (e.g. one for USB-based booting and one for external ROM booting) a compromise of the external ROM booting key is enough to compromise all the SoPEC systems. 5 However, there are advantages in having multiple keys present in the boot ROM and having a wire bonding option on the pads select which of the keys is to be used. Ideally, the pads would be connected within the package, and the selection is not available via external means once the die has ben packaged. This means we can have different keys for different application areas (e.g. different uses of the chip), and if any particular SoPEC key is compromised, the die could be kept 10 constant and only the bonding changed. Note that in the worst case of all keys being compromised, it may be economically feasible to change the bootOkey value in SoPEC's ROM, since this is only a single mask change, and would be easy to verify and characterize. Therefore the entire security of SoPEC is based on keeping the asymmetric private key paired to 15 boot0key secure. The entire security of SoPEC is also based on keeping the program that signs (i.e. authorizes) datasets using the asymmetric private key paired to bootOkey secure. It may therefore be reasonable to have multiple signatures (and hence multiple signature programs) to reduce the chance of a single point of weakness by a rogue employee. Note that the authentication time increases linearly with the number of signatures, and requires a 2048-bit public 20 key in ROM for each signature. 3.6.2 Hierarchies of authentication Given that test programs, evaluation programs, and Manufacturer/owner O/S code needs to be written and tested, and OEM program code etc. also needs to be tested, it is not secure to have a 25 single authentication of a monolithic dataset combining Manufacturer/owner O/S, non-O/S, and OEM program code - we certainly don't want OEMs signing Manufacturer/owner program code, and Manufacturer/owner shouldn't have to be involved with the signing of OEM program code. Therefore we require differing levels of authentication and therefore a number of keys, although the 30 procedure for authentication is identical to the first - a section of program code contains the key and procedure for authenticating the next. This method allows for any hierarchy of authentication, based on a root key of boot0key. For example, assume that we have the following entities: 35 * QACo, Manufacturer/owner's QA/key company. Knows private version of boot0key, and owner of security concerns.
WO 2004/050369 PCTIAU2003/001616 611 * SoPECCo, Manufacturer/owner's SoPEC hardware / software company. Supplies SoPEC ASICs and SoPEC O/S printing software to a ComCo. * ComCo, a company that assembles Print Engines from SoPECs, Memjet printheads etc, customizing the Print Engine for a given OEM according to a license 5 o OEM, a company that uses a Print Engine to create a printer product to sell to the end-users. The OEM would supply the motor control logic, user interface, and casing. The levels of authentication hierarchy are as follows: " QACo writes the boot ROM, agenerates dataset1, consisting of a boot loader program that 10 loads and validates dataset2 and QACo's asymmetric public boot1key. QACo signs datasetO with the asymmetric private bootOkey * SoPECCo generates datasetl, consisting of the print engine security kernel O/S (which incorporates the security-based features of the print engine functionality) and the ComCo's asymmetric public key. Upon a special "formal release" request from SoPECCo, QACo signs 15 datasetO with QACo's asymmetric private bootOkey key. The print engine program code expects to see an operating parameter block signed by the ComCo's asymmetric private key. Note that this is a special "formal release" request to by SoPECCo; the procedure for development versions of the program are described in Section 3.6.3. e The ComCo generates dataSet3, consisting of datasetl plus dataset2, where dataset2 is an 20 operating parameter block for a given OEM's print engine licence (according to the print engine license arrangement) signed with the ComCo's asymmetric private key. The operating parameter block (dataset2) would contain valid print speed ranges, a PrintEngineLicenseld, and the OEM's asymmetric public key. The ComCo can generate as many of these operating parameter blocks for any number of Print Engine Licenses, but cannot write or sign any 25 supervisor O/S program code. " The OEM would generate dataset5, consisting of dataset3 plus dataset4, where dataset4 is the OEM program code signed with the OEM's asymmetric private key. The OEM can produce as many versions of dataset5 as it likes (e.g. for testing purposes or for updates to drivers etc) and need not involve Manufacturer/owner, QACo, or ComCo in any way. 30 The relationship is shown below in Figure 325. When the end-user uses dataset5, SoPEC itself validates datasetl via the bootOkey mechanism described in Section 3.6.1. Once dataset1 is executing, it validates dataset2, and uses dataset2 data to validate dataset4. The validation hierarchy is shown in Figure 326. 35 If a key is compromised, it compromises all subsequent authorizations down the hierarchy. In the example from above (and as illustrated in Figure 326) if the OEM's asymmetric private key is WO 2004/050369 PCTIAU2003/001616 612 compromised, then O/S program code is not compromised since it is above OEM program code in the authentication hierarchy. However if the ComCo's asymmetric private key is compromised, then the OEM program code is also compromised. A compromise of bootOkey compromises everything up to SoPEC itself, and would require a mask ROM change in SoPEC to fix. 5 It is worthwhile repeating that in any hierarchy the security of the entire hierarchy is based on keeping the asymmetric private key paired to bootOkey secure. It is also a requirement that the program that signs (i.e. authorizes) datasets using the asymmetric private key paired to bootOkey secure. 10 3.6.3 Developing Program Code at Manufacturer/owner The hierarchical boot procedure described in Section 3.6.1 and Section 3.6.2 gives a hierarchy of protection in a final shipped product. 15 It is also desirable to use a hierarchy of protection during software development within Manufacturer/owner. For a program to be downloaded and run on SoPEC during development, it will need to be signed. In addition, we don't want to have to sign each and every Manufacturer/owner development code 20 with the bootOkey, as it creates the possibility of any developmental (including buggy or rogue) application being run on any SoPEC. Therefore QACo needs to generate/create a special intermediate boot loader, signed with boot0key, that performs the exact same tasks as the normal boot loader, except that it checks the SoPECid to 25 see if it is a specific SoPECid (or set of SoPECids). If the SoPEC_id is in the valid set, then the developmental boot loader validates dataset2 by means of its length and a SHA-1 digest of the developmental codes, and not by a further digital signature. The QACo can give this boot loader to the software development team within Manufacturer/owner. The software team can now write and run any program code, and load the program code using the development boot loader. There is no 30 requirement for the subsequent software program (i.e. the developmental program code) to be signed with any key since the programs can only be run on the particular SoPECs. 3 The SHA-1 digest is to allow the total program load time to simulate the running time of the normal boot loader running on a non-developmental version of the program.
WO 2004/050369 PCTIAU2003/001616 613 If the developmental boot loader (and/or signature generator) were compromised, or any of the developmental programs were compromised, the worst situation is that an attacker could run programs on that particular set of SoPECs, and on no others. 5 This should greatly reduce the possibility of erroneous programs signed with bootOkey being available to an attacker (only official releases are signed by bootOkey), and therefore reduces the possibility of a Manufacturer/owner employee intentionally or inadvertently creating a back door for attackers. 10 The relationship is shown below in Figure 327. Theoretically the same kind of hierarchy could also be used to allow OEMs to be assured that their program code will only work on specific SoPECs, but this is unlikely to be necessary, and is probably undesirable. 15 3.6.4 Date-limited loaders It is possible that errors in supervisor program code (e.g. the operating system) could allow attackers to subvert the program in SoPEC and gain supervisor control. 20 To reduce the impact of this kind of attack, it is possible to allocate some bits of the SoPEC id to form some kind of date. The granularity of the date could be as simple as a single bit that says the date is obtained from the regular IBM ECID, or it could be 6 bits that give 10 years worth of 3-month units. 25 The first step of the program loaded by boot loader 0 could check the SoPECid date, and run or refuse to run appropriately. The Manufacturer/owner driver or OS could therefore be limited to run on SoPECs that are manufactured up until a particular date. This means that the OEM would require a new version of the OS for SoPECs after a particular date, 30 but the new driver could be made to work on all previous versions of SoPEC. The function simply requires a form of date, whose granularity for working can be determined by agreement with the OEM. 35 For example, suppose that SoPECs are supplied with 3-month granularity in their date components. Manufacturer/owner could ship a version of the OS that works for any SoPEC of the date (i.e. on any chip), or for all SoPECs manufactured during the year etc. The driver issued the next year could WO 2004/050369 PCTIAU2003/001616 614 work with all SoPECs up until that years etc. In this way the drivers for a chip will be backwards compatible, but will be deliberately not forwards-compatible. It allows the downloading of a new driver with no problems, but it protects against bugs in one years's driver OS from being used against future SoPECs. 5 Note that the phasing in of a new OS doesn't have to be at the same time as the hardware. For example, the new OS can come in 3 months before the hardware that it supports. However once the new SoPECs are being delivered, the OEM must not ship the older driver with the newer SoPECs, for the old driver will not work on the newer SoPECs. Basically once the OEM has 10 received the new driver, they should use that driver for all SoPEC systems from that point on (old SoPECs will work with the new driver). This date-limiting feature would most likely be using a field in the ComCo specified operating parameters, so it allows the SoPEC to use date-checking in addition to additional QA Chip related 15 parameter checking (such as the OEM's PrintEngineLicenseld etc). A variant on this theme is a date-window, where a start-date and end-date are specified (as relating to SoPEC manufacture, not date of use). 20 3.6.5 Authenticating operating parameters Operating parameters need to be considered in terms of Manufacturer/owner operating parameters and OEM operating parameters. Both sets of operating parameters are stored on the PRINTERQA chip (physically located inside the printer). This allows the printer to maintain parameters regardless of being moved to different computers, or a loss/replacement of host O/S drivers etc. 25 On PRINTERQA, memory vector Mo contains the upgradable operating parameters, and memory vectors M 1 . contains any constant (non-upgradable) operating parameters. Considering only Manufacturer/owner operating parameters for the moment, there are actually two 30 problems: a. setting and storing the Manufacturer/owner operating parameters, which should be authorized only by Manufacturer/owner b. reading the parameters into SoPEC, which is an issue of SoPEC authenticating the data on the PRINTERQA chip since we don't trust PRINTER_QA. 35 The PRINTERQA chip therefore contains the following symmetric keys: WO 2004/050369 PCTIAU2003/001616 615 0 Ko = PrintEngineLicensekey. This key is constant for all SoPECs supplied for a given print engine license agreement between an OEM and a Manufacturer/owner ComCo. Ko has write permissions to the Manufacturer/owner upgradeable region of Mo on PRINTERQA. 0 K 1 = SoPEC id key. This key is unique for each SoPEC (see Section 3.1), and is known only 5 to the SoPEC and PRINTERQA. K 1 does not have write permissions for anything. Ko is used to solve problem (a). It is only used to authenticate the actual upgrades of the operating parameters. Upgrades are performed using the standard upgrade protocol described in [5], with PRINTERQA acting as the ChipU, and the external upgrader acting as the ChipS. 10
K
1 is used by SoPEC to solve problem (b). It is used to authenticate reads of data (i.e. the operating parameters) from PRINTERQA. The procedure follows the standard authenticated read protocol described in [5], with PRINTER QA acting as ChipR, and the embedded supervisor software on SoPEC acting as ChipT. The authenticated read protocol [5] requires the use of a 160-bit nonce, 15 which is a pseudo-random number. This creates the problem of introducing pseudo-randomness into SoPEC that is not readily determinable by OEM programs, especially given that SoPEC boots into a known state. One possibility is to use the same random number generator as in the QA Chip (a 160-bit maximal-lengthed linear feedback shift register) with the seed taken from the value in the WatchDogTimer register in SoPEC's timer unit when the first page arrives. 20 Note that the procedure for verifying reads of data from PRINTERQA does not rely on Manufacturer/owner's key Ka. This means that precisely the same mechanism can be used to read and authenticate the OEM data also stored in PRINTER_QA. Of course this must be done by Manufacturer/owner supervisor code so that SoPECid key is not revealed. 25 If the OEM also requires upgradable parameters, we can add an extra key to PRINTER_QA, where that key is an OEMkey and has write permissions to the OEM part of MD. In this way, K 1 never needs to be known by anyone except the SoPEC and PRINTERQA. 30 Each printing SoPEC in a multi-SoPEC system need access to a PRINTERQA chip that contains the appropriate SoPEC id key to validate ink useage and operating parameters. This can be accomplished by a separate PRINTERQA for each SoPEC, or by adding extra keys (multiple SoPEC id keys) to a single PRINTERQA. 35 However, if ink usage is not being validated (e.g. if print speed were the only Manufacturer/owner upgradable parameter) then not all SoPECs require access to a PRINTER_QA chip that contains WO 2004/050369 PCTIAU2003/001616 616 the appropriate SoPECid_key. Assuming that OEM program code controls the physical motor speed (different motors per OEM), then the PHI within the first (or only) front-page SoPEC can be programmed to accept (or generate) line sync pulses no faster than a particular rate. If line syncs arrived faster than the particular rate, the PHI would simply print at the slower rate. If the motor 5 speed was hacked to be fast, the print image will appear stretched. 3.6.5.1 Floating operating parameters and dongles As described in Section 2.1.2, Manufacturer/owner operating parameters include such items as print speed, print quality etc. and are tied to a license provided to an OEM. These parameters are 10 under Manufacturer/owner control. The licensed Manufacturer/owner operating parameters are typ ically stored in the PRINTERQA as described in Section 3.6.5. However there are situations when it is desirable to have a floating upgrade to a license, for use on a printer of the user's choice. For example, OEMs may sell a speed-increase license upgrade that 15 can be plugged into the printer of the user's choice. This form of upgrade can be considered a floating upgrade in that it upgrades whichever printer it is currently plugged into. This dongle is referred to as ADDITIONALPRINTERQA. The software checks for the existence of an ADDITIONALPRINTER_QA and if present the operating parameters are chosen from the values stored on both QA chips. 20 The basic problem of authenticating the additional operating parameters boils down to the problem that we don't trust ADDITIONALPRINTERQA. Therefore we need a system whereby a given SoPEC can perform an authenticated read of the data in ADDITIONALPRINTERQA. 25 We should not write the SoPEC id key to a key in the ADDITIONALPRINTERQA because: * then it will be tied specifically to that SoPEC, and the primary intention of the ADDITIONALPRINTERQA is that it be floatable; * the ink cartridge would then not work in another printer since the other printer would not know the old SoPEC id key (knowledge of the old key is required in order to change the old key to 30 a new one). e updating keys is not power-safe (i.e. if at the user's site, power is removed mid-update, the ADDITIONALPRINTERQA could be rendered useless) WO 2004/050369 PCTIAU2003/001616 617 The proposed solution is to let ADDITIONALPRINTERQA have two keys: Ko = FloatingPrintEngineLicensekey. This key has the same function as the PrintEngineLicensekey in the PRINTERQA 4 in that Ko has write permissions to the Manufacturer/owner upgradeable region of Mo on ADDITIONALPRINTERQA. 5 * K 1 = UseExtParmsLicense key. This key is constant for all of the ADDITIONALPRINTERQAs for a given license agreement between an OEM and a Manufacturer/owner ComCo (this is not the same key as PrintEngineLicensekey which is stored as Ko in PRINTERQA). K 1 has no write permissions to anything. 10 Ko is used to allow writes to the various fields containing operating parameters in the ADDITIONALPRINTERQA. These writes/upgrades are performed using the standard upgrade protocol described in [5], with ADDITIONALPRINTERQA acting as the ChipU, and the external upgrader acting as the ChipS. The upgrader (ChipS) also needs to check the appropriate licensing parameters such as OEM_Id for validity. 15
K
1 is used to allow SoPEC to authenticate reads of the ink remaining and any other ink data. This is accomplished by having the same UseExtParmsLicense key within PRINTERQA (e.g. in K 2 ), also with no write permissions. i.e: * PRINTERQA.K 2 = UseExtParmsLicensekey. This key is constant for all of the 20 PRINTERQAs for a given license agreement between an OEM and a Manufacturer/owner ComCo. K 2 has no write permissions to anything. This means there are two shared keys, with PRINTERQA sharing both, and thereby acting as a bridge between INKQA and SoPEC. 25 * UseExtParmsLicensekey is shared between PRINTER_QA and ADDITIONALPRINTERQA * SoPECid_key is shared between SoPEC and PRINTER_QA All SoPEC has to do is do an authenticated read [6] from ADDITIONALPRINTERQA, pass the 30 data / signature to PRINTERQA, let PRINTERQA validate the data / signature, and get PRINTERQA to produce a similar signature based on the shared SoPEC id key. It can do so using the Translate function [6]. SoPEC can then compare PRINTERQA's signature with its own calculated signature (i.e. implement a Test function [6] in software on SoPEC), and if the signatures match, the data from ADDITIONALPRINTERQA must be valid, and can therefore be trusted. 'This can be identical to PrintEngineLicensekey in the PRINTER_.QA if it is desireable (unlikely) that upgraders can function on PRINTERQAs as well as ADDITIONALPRINTER_QAs WO 2004/050369 PCTIAU2003/001616 618 Once the data from ADDITIONALPRINTERQA is known to be trusted, the various operating parameters such as OEM_Id can be checked for validity. The actual steps of read authentication as performed by SoPEC are: 5 RPRIR +- PRINTERQA.random() RDONLE, MDONGLE, SIGDONGE +- DONGLEQA. read (KI, RPRINTER) RSOPEC <- random () RPRINTER, PRINER +- PRINTERQA. translate (K2, RD)ONGLE, MDONGLE, SIGDONGLE, KI, RSOPEC) 10 SIGSoPEC < HMAC_SHA_1 (SoPEC_idkey, MDONGL PRINTER I RSOPEC) If (SIGPRINTER = SIGsoPEC) // various parms inside MDONGLE (data read from ADDITIONALPRINTERQA) is valid Else 15 // the data read from ADDITIONALPRINTERQA is not valid and cannot be trusted Endlf 3.6.5.2 Dongles tied to a given SoPEC 20 Section 3.6.5.1 describes floating dongles i.e. dongles that can be used on any SoPEC. Sometimes it is desirable to tie a dongle to a specific SoPEC. Tying a QACHIP to be used only on a specific SoPEC can be easily accomplished by writing the PRINTERQA's chipid (unique serial number) into an appropriate Mo field on the 25 ADDITIONALPRINTER_QA. The system software can detect the match and function appropriately. If there is no match, the software can ignore the data read from the ADDITIONALPRINTERQA. Although it is also possible to store the SoPEC id key in one of the keys within the dongle, this 30 must be done in an environment where power will not be removed partway through the key update process (if power is removed during the key update there is a possibility that the dongle QA Chip may be rendered unusable, although this can be checked for after the power failure).
WO 2004/050369 PCTIAU2003/001616 619 3.6.5.3 OEM assembly-line test Although an OEM should only be able sell the licensed operating parameters for a given Print Engine, they must be able to assembly-line test 5 or service/test the Print Engine with a different set of operating parameters e.g. a maximally upgraded Print Engine. 5 Several different mechanisms can be employed to allow OEMs to test the upgraded capabilities of the Print Engine. At present it is unclear exactly what kind of assembly-line tests would be performed. The simplest solution is to use an ADDITIONALPRINTERQA (i..e. special dongle PRINTERQA 10 as described in Section 3.6.5.1). The ADDITIONALPRINTERQA would contain the operating parameters that maximally upgrade the printer as long as the dongle is connected to the SoPEC. The exact connection may be directly electrical (e.g. via the standard QA Chip connections) or may be over the USB connection to the printer test host depending on the nature of the test. The exact preferred connection is yet to be determined. 15 In the testing environment, the ADDITIONALPRINTERQA also requires a numberOfimpressions field inside M 0 , which is writeable by Kg. Before the SoPEC prints a page at the higher speed, it decrements the numberOfImpressions counter, performs an authenticated read to ensure the count was decremented, and then prints the page. In this way, the total number of pages that can be 20 printed at high speed is reduced in the event of someone stealing the ADDITIONALPRINTERQA device. It also means that multiple test machines can make use of the same ADDITIONALPRINTERQA. 3.6.6 Use of a PrintEngineLicense id 25 Manufacturer/owner O/S program code contains the OEM's asymmetric public key to ensure that the subsequent OEM program code is authentic - i.e. from the OEM. However given that SoPEC only contains a single root key, it is theoretically possible for different OEM's applications to be run identically physical Print Engines i.e. printer driver for OEM 1 run on an identically physical Print Engine from OEM 2 30 To guard against this, the Manufacturer/owner O/S program code contains a PrintEngindLicense id code (e.g. 16 bits) that matches the same named value stored as a fixed operating parameter in the PRINTERQA (i.e. in Ml+). As with all other operating parameters, the value of PrintEngineLicenseid is stored in PRINTERQA (and any ADDITIONALPRINTERQA devices) 5This section is referring to assembly-line testing rather than development testing. An OEM can maximally upgrade a given Print Engine to allow developmental testing of their own OEM program code & mechanics.
WO 2004/050369 PCTIAU2003/001616 620 at the same time as the other various PRINTERQA customizations are being applied, before being shipped to the OEM site. In this way, the OEMs can be sure of differentiating themselves through software functionality. 5 3.6.7 Authentication of ink The Manufacturer/owner O/S must perform ink authentication [6] during prints. Ink usage authen tication makes use of counters in SoPEC that keep an accurate record of the exact number of dots printed for each ink. 10 The ink amount remaining in a given cartridge is stored in that cartridge's INK QA chip. Other data stored on the INK_QA chip includes ink color, viscosity, Memjet firing pulse profile information, as well as licensing parameters such as OEM Id, inkType, InkUsageLicenseId, etc. This information is typically constant, and is therefore likely to be stored in MI, within INKQA. 15 Just as the Print Engine operating parameters are validated by means of PRINTER QA, a given Print Engine license may only be permitted to function with specifically licensed ink. Therefore the software on SoPEC could contain a valid set of ink types, colors, OEMIds, InkUsageLicense_Ids etc. for subsequent matching against the data in the INK_QA. 20 SoPEC must be able to authenticate reads from the INK_QA, both in terms of ink parameters as well as ink remaining. To authenticate ink a number of steps must be taken: 25 * restrict access to dot counts * authenticate ink usage and ink parameters via INKQA and PRINTERQA = broadcast ink dot usage to all SoPECs in a multi-SoPEC system 3.6.7.1 restrict access to dot counts 30 Since the dot counts are accessed via the PHI in the PEP section of SoPEC, access to these registers (and more generally all PEP registers) must be only available from supervisor mode, and not by OEM code (running in user mode). Otherwise it might be possible for OEM program code to clear dot counts before authentication has occurred. 35 3.6.7.2 authenticate ink usage and ink parameters via INKQA and PRINTERQA The basic problem of authentication of ink remaining and other ink data boils down to the problem that we don't trust INK_QA. Therefore how can a SoPEC know the initial value of ink (or the ink WO 2004/050369 PCTIAU2003/001616 621 parameters), and how can a SoPEC know that after a write to the INKQA, the count has been correctly decremented. Taking the first issue, which is determining the initial ink count or the ink parameters, we need a 5 system whereby a given SoPEC can perform an authenticated read of the data in INKQA. We cannot write the SoPECid key to the INK_QA for two reasons: e updating keys is not power-safe (i.e. if power is removed mid-update, the INKQA could be rendered useless) 10 e the ink cartridge would then not work in another printer since the other printer would not know the old SoPECidkey (knowledge of the old key is required in order to change the old key to a new one). The proposed solution is to let INKQA have two keys: 15 K Ko = SupplyinkLicensekey. This key is constant for all ink cartridges for a given ink supply agreement between an OEM and a Manufacturer/owner ComCo (this is not the same key as PrintEngineLicense key which is stored as K 0 in PRINTER_QA). K 0 has write permissions to the ink remaining regions of Mo on INK_QA. * K 1 = UseInkLicense key. This key is constant for all ink cartridges for a given ink usage 20 agreement between an OEM and a Manufacturer/owner ComCo (this is not the same key as PrintEngineLicense-key which is stored as K 0 in PRINTERQA). K 1 has no write permissions to anything. Ko is used to authenticate the actual upgrades of the amount of ink remaining (e.g. to fill and refill the amount of ink). Upgrades are performed using the standard upgrade protocol described in [5], 25 with INKQA acting as the ChipU, and the external upgrader acting as the ChipS. The fill and refill upgrader (ChipS) also needs to check the appropriate ink licensing parameters such as OEM_Id, InkType and inkUsageLicenseId for validity. K, is used to allow SoPEC to authenticate reads of the ink remaining and any other ink data. This is 30 accomplished by having the same UseinkLicensekey within PRINTERQA (e.g. in K 2 or K3), also with no write permissions. This means there are two shared keys, with PRINTERQA sharing both, and thereby acting as a bridge between INKQA and SoPEC. 35 - UselnkLicensekey is shared between INK_QA and PRINTER_QA 0 SoPECid_key is shared between SoPEC and PRINTERQA WO 2004/050369 PCTIAU2003/001616 622 All SoPEC has to do is do an authenticated read [6] from INKQA, pass the data / signature to PRINTERQA, let PRINTERQA validate the data I signature and get PRINTER QA to produce a similar signature based on the shared SoPEC id key (i.e. the Translate function [6]). SoPEC can then compare PRINTER-QA's signature with its own calculated signature (i.e. implement a Test 5 function [6] in software on the SoPEC), and if the signatures match, the data from INKQA must be valid, and can therefore be trusted. Once the data from INKQA is known to be trusted, the amount of ink remaining can be checked, and the other ink licensing parameters such as OEM_ld, InkType, InkUsageLicenseld can be 10 checked for validity. The actual steps of read authentication as performed by SoPEC are: RPRIE <- PRINTERQA. random ()
R
1 M, M,,, SIG,, +- INK_QA. read (K1, RPRINTER) read with keyl: 15 UseinkLicensekey RSOPEC +- random () RPRITER, SIGpRINTER <- PRINTERQA. translate (K2, RINK, Mm, SIG 1 N, KI, RsopEc) SIGsopEC +- HMACSHA_1 (SoPEC-id-key, MINK PRINTER RSOP
E
C) 20 If (SIGPRINTR = SIGSOPEC) // MI (data read from INK QA) is valid // MI could be ink parameters, such as InkUsageLicense_Id, or ink remaining If (Mm.inkRemaining = expectedInkRemaining) 25 // all is ok Else // the ink value is not what we wrote, so don' t print anything anymore EndIf 30 Else // the data read from INKQA is not valid and cannot be trusted EndIf Strictly speaking, we don't need a nonce (RsoPEc) all the time because MA (containing the ink remaining) should be decrementing between authentications. However we do need one to retrieve 35 the initial amount of ink and the other ink parameters (at power up). This is why taking a random number from the WatchDogTimer at the receipt of the first page is acceptable.
WO 2004/050369 PCTIAU2003/001616 623 In summary, the SoPEC performs the non-authenticated write [6] of ink remaining to the INKQA chip, and then performs an authenticated read of the data via the PRINTER_QA as per the pseudocode above. If the value is authenticated, ad the INK_QA ink-remaining value matches the expected value, the count was correctly decremented and the printing can continue. 5 3.6.7.3 broadcast ink dot usage to all SoPECs in a multi-SoPEC system In a multi-SoPEC system, each SoPEC attached to a printhead must broadcast its ink usage to all the SoPECs. In this way, each SoPEC will have its own version of the expected ink usage. 10 In the case of a man-in-the-middle attack, at worst the count in a given SoPEC is only its own count (i.e. all broadcasts are turned into 0 ink usage by the man-in-the-middle). We would also require the broadcast amount to be treated as an unsigned integer to prevent negative amounts from being substituted. 15 A single SoPEC performs the update of ink remaining to the INKQA chip, and then all SoPECs perform an authenticated read of the data via the appropriate PRINTERQA (the PRINTER_QA that contains their matching SoPECid_key - remember that multiple SoPEC id keys can be stored in a single PRINTER QA). If the value is authenticated, and the INK_QA value matches the expected value, the count was correctly decremented and the printing can continue. 20 If any of the broadcasts are not received, or have been tampered with, the updated ink counts will not match. The only case this does not cater for is if each SoPEC is tricked (via a USB2 inter SoPEC-comms man-in-the-middle attack) into a total that is the same, yet not the true total. Apart from the fact that this is not viable for general pages, at worst this is the maximum amount of ink 25 printed by a single SoPEC. We don't care about protecting against this case. Since a typical maximum is 4 printing SoPECs, it requires at most 4 authenticated reads. This should be completed within 0.5 seconds, well within the 1-2 seconds/page print time. 30 3.6.8 Example hierarchy Adding an extra bootloader step to the example from Section 3.6.2, we can break up the contents of program space into logical sections, as shown in Table 227. Note that the ComCo does not provide any program code, merely operating parameters that is used by the 0/S. Table 227. Sections of Program Space 35 section contents verifies 0 boot loader 0 section 1 via bootOkey WO 2004/050369 PCTIAU2003/001616 624 (ROM) SHA-1 function asymmetric decrypt function bootOkey 1 boot loader I section 2 via SoPECOSpublic-key SoPEC_OSpublickey 2 Manufacturer/owner O/S program section 3 via ComCo public key code section 4 via OEM publickey (supplied function to generate in section 3) SoPECid key from SoPECid PRINTERQA data, which includes the Basic Print Engine PrintEngineLicenseid, ComCo public key Manufacturer/owner operating parameters, and OEM operating parameters (all authenticated via SoPECid-key) 3 ComCo license agreement operat- Is used by section 2 to verify section 4 ing parameter ranges, including and range of parameters as found in PrintEngineLicenseid (gets PRINTERQA loaded into supervisor mode sec tion of memory) OEMpublic key (gets loaded into supervisor mode section of mem ory) Any ComCo written user-mode program code (gets loaded into mode mode section of memory) OEM specific program code OEM operating parameters via calls to Manufacturer/owner O/S code The verification procedures will be required each time the CPU is woken up, since the RAM is not preserved. 5 3.6.9 What if the CPU is not fast enough? In the example of Section 3.6.8, every time the CPU is woken up to print a document it needs to perform: * SHA-1 on all program code and program data e 4 sets of asymmetric decryption to load the program code and data WO 2004/050369 PCTIAU2003/001616 625 1 HMAC-SHA1 generation per 512-bits of Manufacturer/owner and OEM printer and ink oper ating parameters Although the SHA-1 and HMAC process will be fast enough on the embedded CPU (the program 5 code will be executing from ROM), it may be that the asymmetric decryption will be slow. And this becomes more likely with each extra level of authentication. If this is the case (as is likely), hardware acceleration is required. A cheap form of hardware acceleration takes advantage of the fact that in most cases the same 10 program is loaded each time, with the first time likely to be at power-up. The hardware acceleration is simply data storage for the authorizedDigest which means that the boot procedure now is: slowCPUbootloader0(data, sig) localDigest <- SHA-1(data) If (localDigest = previouslyStoredAuthorizedDigest) 15 jump to program code at data-start address// will never return Else authorizedDigest +- decrypt(sig, bootokey) expectedDigest = 0x00J0x01J0xFF. .OxFFI 20 0xOO3021300906052BOE03021AO5000414 ]localDigest) If (authorizedDigest == expectedDigest) previouslyStoredAuthorizedDigest <- localDigest jump to program code at data-start address// will never return 25 Else // program code is unauthorized EndIf This procedure means that a reboot of the same authorized program code will only require SHA-1 processing. At power-up, or if new program code is loaded (e.g. an upgrade of a driver over the 30 internet), then the full authorization via asymmetric decryption takes place. This is because the stored digest will not match at power-up and whenever a new program is loaded. The question is how much preserved space is required. 35 Each digest requires 160 bits (20 bytes), and this is constant regardless of the asymmetric encryption scheme or the key length. While it is possible to reduce this number of bits, thereby sacrificing security, the cost is small enough to warrant keeping the full digest.
WO 2004/050369 PCTIAU2003/001616 626 However each level of boot loader requires its own digest to be preserved. This gives a maximum of 20 bytes per loader. Digests for operating parameters and ink levels may also be preserved in the same way, although these authentications should be fast enough not to require cached storage. 5 Assuming SoPEC provides for 12 digests (to be generous), this is a total of 240 bytes. These 240 bytes could easily be stored as 60 x 32-bit registers, or probably more conveniently as a small amount of RAM (eg 0.25 - 1 Kbyte). Providing something like 1 Kbyte of RAM has the advantage of allowing the CPU to store other useful data, although this is not a requirement. 10 In general, it is useful for the boot ROM to know whether it is being started up due to power-on reset, GPIO activity, or activity on the USB2. In the former case, it can ignore the previously stored values (either 0 for registers or garbage for RAM). In the latter cases, it can use the previously stored values. Even without this, a startup value of 0 (or garbage) means the digest won't match and therefore the authentication will occur implictly. 15 3.7 SoPEC PHSYICAL IDENTIFICATION There must be a mapping of logical to physical since specific SoPECs are responsible for printing on particular physical parts of the page, and/or have particular devices attached to specific pins. 20 The identification process is mostly solved by general USB2 enumeration. Each slave SoPEC will need to verify the boot broadcast messages received over USB2, and only execute the code if the signatures are valid. Several levels of authorization may occur. However, at some stage, this common program code (broadcast to all of the slave SoPECs and signed by the 25 appropriate asymmetric private key) can, among other things, set the slave SoPEC's id relating to the physical location. If there is only 1 slave, the id is easy to determine, but if there is more than 1 slave, the id must be determined in some fashion. For example, physical location/id determination may be: 3 given by the physical USB2 port on the master 30 e related to the physical wiring up of the USB2 interconnects * based on GPIO wiring. On other systems, a particular physical arrangement of SoPECs may exist such that each slave SoPEC will have a different set of connections on GPIOs. For example, one SoPEC maybe in charge of motor control, while another may be driving the LEDs etc. The unused GPIO pins (not necessarily the same on each SoPEC) can be set as 35 inputs and then tied to 0 or 1. As long as the connection settings are mutually exclusive, program code can determine which is which, and the id appropriately set.
WO 2004/050369 PCTIAU2003/001616 627 This scheme of slave SoPEC identification does not introduce a security breach. If an attacker rewires the pinouts to confuse identification, at best it will simply cause strange printouts (e.g. swapping of printout data) to occur, while at worst the Print Engine will simply not function. 5 3.8 SETTING UP QA CHIP KEYS In use, each INK_QA chip needs the following keys: e K 0 = SupplyInkLicensekey SK, = UseinkLicensekey 10 Each PRINTERQA chip tied to a specific SoPEC requires the following keys: e Ko = PrintEngineLicense key S K, = SoPEC id key * K 2 = UseExtParmsLicense-key e K 3 = UseInkLicensekey 15 Note that there may be more than one K, depending on the number of PRINTER QA chips and SoPECs in a system. These keys need to be appropriately set up in the QA Chips before they will function correctly together. 3.8.1 Original QA Chips as received by a ComCo 20 When original QA Chips are shipped from QACo to a specific ComCo their keys are as follows:
SK
0 = QACoComC_Key0 e K, = QACoComCoKeyl * K 2 = QACoComCoKey2 e K 3 = QA Co ComCoKey3 25 All 4 keys are only known to QACo. Note that these keys are different for each QA Chip. 3.8.2 Steps at the ComCo The ComCo is responsible for making Print Engines out of Memjet printheads, QA Chips, PECs or SoPECs, PCBs etc. 30 In addition, the ComCo must customize the INK_QA chips and PRINTERQA chip on-board the print engine before shipping to the OEM. There are two stages: * replacing the keys in QA Chips with specific keys for the application (i.e. INK_QA and 35 PRINTERQA) * setting operating parameters as per the license with the OEM WO 2004/050369 PCTIAU2003/001616 628 3.8.2.1 Replacing keys The ComCo is issued QID hardware [4] by QACo that allows programming of the various keys (except for K 1 ) in a given QA Chip to the final values, following the standard ChipF/ChipP replace key (indirect version) protocol [6]. The indirect version of the protocol allows each 5 QACo_ComCo_Key to be different for each SoPEC. In the case of programming of PRINTERQA's K1 to be SoPECid key, there is the additional step of transferring an asymmetrically encrypted SoPEC_idkey (by the public-key) along with the nonce (Rp) used in the replace key protocol to the device that is functioning as a ChipF. The ChipF must 10 decrypt the SoPEC id key so it can generate the standard replace key message for PRINTER QA (functioning as a ChipP in the ChipF/ChipP protocol). The asymmetric key pair held in the ChipF equivalent should be unique to a ComCo (but still known only by QACo) to prevent damage in the case of a compromise. 15 Note that the various keys installed in the QA Chips (both INKQA and PRINTERQA) are only known to the QACo. The OEM only uses QIDs and QACo supplied ChipFs. The replace key protocol (6] allows the programming to occur without compromising the old or new key. 3.8.2.2 Setting operating parameters 20 There are two sets of operating parameters stored in PRINTERQA and INK_QA: * fixed * upgradable The fixed operating parameters can be written to by means of a non-authenticated writes [6] to Mj+ via a QID [4], and permission bits set such that they are ReadOnly. 25 The upgradable operating parameters can only be written to after the QA Chips have been programmed with the correct keys as per Section 3.8.2.1. Once they contain the correct keys they can be programmed with appropriate operating parameters by means of a QID and an appropriate ChipS (containing matching keys).
WO 2004/050369 PCTIAU2003/001616 629 AUTHENTICATION PROTOCOLS 1 Introduction The following describes authentication protocols for general authentication applications, but with specific reference to the QA Chip. 5 The intention is to show the broad form of possible protocols for use in different authentication situations, and can be used as a reference when subsequently defining an implementation specification for a particular application. As mentioned earlier, although the protocols are described in relation to a printing environment, many of them have wider application such as, but not limited 10 to, those described at the end of this specification. 2 Nomenclature The following symbolic nomenclature is used throughout this document: Table 228. Summary of symbolic nomenclature 15 Symbol Description F[X] Function F, taking a single parameter X F[X, Y] Function F, taking two parameters, X and Y X Y X concatenated with Y XA Y Bitwise X AND Y Xv Y Bitwise X OR Y (inclusive-OR) X 9 Y Bitwise X XOR Y (exclusive-OR) ,X Bitwise NOT X (complement) X Y X is assigned the value Y X- {Y, Z} The domain of assignment inputs to X is Y and Z X= Y X is equal to Y X o Y X is not equal to Y UX Decrement X by I (floor 0) PX Increment X by I (modulo register length) Erase X Erase Flash memory register X SetBits[X, Y] Set the bits of the Flash memory register X based on Y Z <- ShiftRight[X, Y] Shift register X right one bit position, taking input bit from Y and placing the output bit in Z WO 2004/050369 PCTIAU2003/001616 630 3 PSEUDOCODE 3.1 Asynchronous The following pseudocode: var = expression 5 means the var signal or output is equal to the evaluation of the expression. 3.2 Synchronous The following pseudocode: var +- expression means the var register is assigned the result of evaluating the expression during 10 this cycle. 3.3 Expression Expressions are defined using the nomenclature in Table 228 above. Therefore: var = (a = b) is interpreted as the var signal is I if a is equal to b, and 0 otherwise. 15 4. Intentionally blank 5 Basic Protocols 5.1 PROTOCOL BACKGROUND 20 This protocol set is a restricted form of a more general case of a multiple key single memory vector protocol. It is a restricted form in that the memory vector M has been optimized for Flash memory utilization: * M is broken into multiple memory vectors (semi-fixed and variable components) for the purposes of optimizing flash memory utilization. Typically M contains some parts that are 25 fixed at some stage of the manufacturing process (eg a batch number, serial number etc.), and once set, are not ever updated. This information does not contain the amount of consumable remaining, and therefore is not read or written to with any great frequency. * We therefore define Mo to be the M that contains the frequently updated sections, and the remaining Ms to be rarely written to. Authenticated writes only write to M 0 , and non 30 authenticated writes can be directed to a specific M. This reduces the size of permissions that are stored in the QA Chip (since key-based writes are not required for Ms other than MG). It also means that Mo and the remaining Ms can be manipulated in different ways, thereby increasing flash memory longevity. 35 5.2 REQUIREMENTS OF PROTOCOL Each QA Chip contains the following values: N The maximum number of keys known to the chip.
WO 2004/050369 PCTIAU2003/001616 631 T The number of vectors M is broken into. KN Array of N secret keys used for calculating FKn[X] where Kn is the nth element of the array. R Current random number used to ensure time varying messages. Each chip instance must be seeded with a different initial value. Changes for each signature generation. 5 MT Array of T memory vectors. Only Mo can be written to with an authorized write, while all Ms can be written to in an unauthorized write. Writes to Mo are optimized for Flash usage, while updates to any other Mi. are expensive with regards to Flash utilization, and are expected to be only performed once per section of M. M 1 contains T, N and f in ReadOnly form so users of the chip can know these two values. 10 PT+N T+N element array of access permissions for each part of M. Entries n={0... T-1} hold access permissions for non-authenticated writes to M, (no key required). Entries n={T to T+N-1}hold access permissions for authenticated writes to Mo for K. Permission choices for each part of M are Read Only, Read/Write, and Decrement Only. C 3 constants used for generating signatures. C 1 , C 2 , and C 3 are constants that pad out a sub 15 message to a hashing boundary, and all 3 must be different. Each QA Chip contains the following private function: SK(N,XI Internalfunction only. Returns S[X], the result of applying a digital signature function S to X based upon the appropriate key KI. The digital signature must be long enough to counter the chances of someone generating a random signature. The length depends on the signature 20 scheme chosen, although the scheme chosen for the QA Chip is HMAC-SHAI, and therefore the length of the signature is 160 bits. Additional functions are required in certain QA Chips, but these are described as required. 5.3 READ PROTOCOLS The set of read protocols describe the means by which a System reads a specific data vector Mt 25 from a QA Chip referred to as ChipR. We assume that the communications link to ChipR (and therefore ChipR itself) is not trusted. If it were trusted, the System could simply read the data and there is no issue. Since the communications link to ChipR is not trusted and ChipR cannot be trusted, the System needs a way of authenticating the data as actually being from a real ChipR. 30 Since the read protocol must be capable of being implemented in physical QA Chips, we cannot use asymmetric cryptography (for example the ChipR signs the data with a private key, and System validates the signature using a public key). This document describes two read protocols: . direct validation of reads 35 . indirect validation of reads. 5.3.1 Direct Validation of Reads WO 2004/050369 PCTIAU2003/001616 632 In a direct validation read protocol we require two QA Chips: ChipR is the QA Chip being read, and ChipT is the QA Chip we entrust to tell us whether or not the data read from ChipR is trustworthy. The basic idea is that system asks ChipR for data, and ChipR responds with the data and a signature based on a secret key. System then asks ChipT whether the signature supplied by ChipR 5 is correct. If ChipT responds that it is, then System can trust that data just read from ChipR. Every time data is read from ChipR, the validation procedure must be carried out. Direct validation requires the System to trust the communication line to ChipT. This could be because ChipT is in physical proximity to the System, and both System and ChipT are in a trusted (e.g. Silverbrook secure) environment. However, since we need to validate the read, ChipR by 10 definition must be in a non-trusted environment. Each QA Chip protects its signature generation or verification mechanism by the use of a nonce. The protocol requires the following publicly available functions in ChipT: 15 Random[] Returns R (does not advance R). Test[n,X, Y, ZI Advances R and returns 1 if SKn[RIXC1| Y] = Z. Otherwise returns 0. The time taken to calculate and compare signatures must be independent of data content. The protocol requires the following publicly available functions in ChipR: 20 Read[n, t, X] Advances R, and returns R, Mt, SKn[XIRICIIMd. The time taken to calculate the signature must not be based on the contents of X, R, Mt, or K. If t is invalid, the function assumes t=0. To read ChipR's memory Mi in a validated way, System performs the following tasks: 25 a. System calls ChipT's Random function; b. ChipT returns RT to System; c. System calls ChipRs Read function, passing in some key number n1, the desired data vector number t, and RT (from b); d. ChipR updates RR, then calculates and returns RR, MRt, SKnl[RTIRRIC1|MRi; 30 e. System calls ChipT's Test function, passing in the key to use for signature verification n2, and the results from d (i.e. RR, MRt, SKn1[RTRRIC1|MR@d; f. System checks response from ChipT. If the response is 1, then the Mt read from ChipR is considered to be valid. If 0, then the Mi read from ChipR is considered to be invalid. 35 The choice of n1 and n2 must be such that ChipR's K, 1 = ChipT's Kn 2 . The data flow for this read protocol is shown in Figure 328.
WO 2004/050369 PCTIAU2003/001616 633 From the System's perspective, the protocol would take on a form like the following pseudocode: RT <- ChipT.Random() RR, MR, SIGR <- ChipR.Read(keyNumonChipR,desiredM, RT) ok <- ChipT.Test(keyNumOnChipT, RR, MR, SIGR) 5 If (ok = 1) // MR is to be trusted Else // MR is not to be trusted EndIf 10 With regards to security, if an attacker finds out ChipR's Kn 1 , they can replace the ChipR by a fake ChipR because they can create signatures. Likewise, if an attacker finds out ChipT's K1 2 , they can replace the ChipR by a fake ChipR because ChipR's Kn 1 = ChipT's Kn 2 . Moreover, they can use the ChipRs on any system that shares the same key. 15 The only way of restricting exposure due to key reveals is to restrict the number of systems that match ChipR and ChipT. i.e. vary the key as much as possible. The degree to which this can be done will depend on the application. In the case of a PRINTERQA acting as a ChipT, and an INKQA acting as a ChipR, the same key must be used on all systems where the particular INKQA data must be validated. 20 In all cases, ChipR must contain sufficient information to produce a signature. Knowing (or finding out) this information, whatever form it is in, allows clone ChipRs to be built. 5.3.2 Indirect Validation of Reads 25 In a direct validation protocol (see Section 5.3.1), the System validates the correctness of data read from ChipR by means of a trusted chip ChipT. This is possible because ChipR and ChipT share some secret information. However, it is possible to extend trust via indirect validation. This is required when we trust ChipT, 30 but ChipT doesn't know how to validate data from ChipR. Instead, ChipT knows how to validate data from Chip! (some intermediate chip) which in turn knows how to validate data from either another Chipl (and so on up a chain) or ChipR. Thus we have a chain of validation. The means of validation chains is translation of signatures. Chip[, translates signatures from higher 35 up the chain (either Chipin.
1 or from ChipR at the start of the chain) into signatures capable of being passed to the next stage in the chain (either Chipi+ 1 or to ChipT at the end of the chain). A given WO 2004/050369 PCTIAU2003/001616 634 Chipi can only translate signatures if it knows the key of the previous stage in the chain as well as the key of the next stage in the chain. The protocol requires the following publicly available functions in Chipl: 5 Random[] Returns R (does not advance R). Translate[n1,X, Y, Z,n2,A] Returns 1, SKn2[AI RIC 1 Y] and advances R if Z = SKni[RIXIC 1 |Y]. Otherwise returns 0, 0. The time taken to calculate and compare signatures must be independent of data content. 10 The data flow for this signature translation protocol is shown in Figure 329: Note that Rprev is eventually RR, and Rnet is eventually RT. In the multiple Chip[ case, Rprev is the R, of Chipln.
1 and Rnex is R, of Chipli+ 1 .The Rprev of the first Chipi in the chain is RR, and the Rnext of the last Chipl in the chain is RT. 15 Assuming at least 1 ChipT, the System would need to perform the following tasks in order to read ChipR's memory Mt in an indirectly validated way: a. System calls Chipln's Random function; b. Chiplo returns Rio to System; 20 c. System calls ChipR's Read function, passing in some key number nO, the desired data vector number t, and Rio (from b); d. ChipR updates RR, then calculates and returns RR, MRt, SKnO[RInIRRIC1|MRd e. System assigns RR to Rprev and SKnO[RinARRIC11Rt] to SIGprev f. System calls the next-chip-in-the-chain's Random function (either ChipIn+ 1 or ChipT) 25 g. The next-chip-in-the-chain will return Rnext to System h. System calls Chipl's Translate function, passing in n1 (translation input key number), Rpre,, MRt, SiGprev), n2, (translation output key number) and the results from g (Rext); i. Chipi returns testResult and SIG, to System j. If testResult = 0, then the validation has failed, and the Mt read from ChipR is considered to be 30 invalid. Exit with failure. k. If the next chip in the chain is a Chipl, assign SIGi to SIGprev and go to step f I. System calls ChipT's Test function, passing in nt, Rprev, MRt, and SIGprev; m. System calls System checks response from ChipT. If the response is 1, then the Mt read from ChipR is considered to be valid. If 0, then the Mt read from ChipR is considered to be invalid. 35 For the Translate function to work, Chipln and Chipl+ 1 must share a key. The choice of n1 and n2 in the protocol described must be such that Chipi,'s Kn 2 = Chipli+ 1 's Kn 1
.
WO 2004/050369 PCTIAU2003/001616 635 Note that Translate is essentially a "Test plus resign" function. From an implementation point of view the first part of Translate is identical to Test. Note that the use of Chipls and the translate function merely allows signatures to be transformed. At 5 the end of the translation chain (if present) will be a ChipT requiring the use of a Test function. There can be any number of Chipls in the chain to ChipT as long as the Translate function is used to map signatures between Chipli and Chipn 1 and so on until arrival at the final destination (ChipT). 10 From the System's perspective, a read protocol using at least 1 Chipl would take on a form like the following pseudocode: Rnext +- ChipI [0] .Random() Rprev, MR, SIGprev <- ChipR.Read(keyNumOnChipR,desiredM, Rext) 15 ok = I i = 0 while ((i < iMax) AND ok) For i +- 0 to iMax If (i iMax) 20 Raet +- ChipT.Random() Else Rnext +- ChipI [i+1] Randomo( EndIf ok, SIGprev <- ChipI [i] .Translate (iKey [i] , Rprey, MR, 25 SIGpreV, OKey[i] , Re.t) Rprev = Rnext If (ok = 0) // MR is not to be trusted EndIf 30 EndFor ok +- ChipT.Test(keyNumOnChipT, Rprev, MR, SIGprev) If (ok ='1) // MR is to be trusted Else 35 // MR is not to be trusted EndIf WO 2004/050369 PCTIAU2003/001616 636 5.3.3 Additional Comments on Reads In the Memjet printing environment, certain implementations will exist where the operating parameters are stored in QA Chips. In this case, the system must read the data from the QA Chip using an appropriate read protocol. 5 If the connection is trusted (e.g. to a virtual QA Chip in software), a generic Read is sufficient. If the connection is not trusted, it is ideal that the System have a trusted ChipT in the form of software (if possible) or hardware (e.g. a QA Chip on board the same silicon package as the microcontroller and firmware). Whether implemented in software or hardware, the QA Chip should contain an 10 appropriate key that is unique per print engine. Such a key setup would allow reads of print engine parameters and also allow indirect reads of consumables (from a consumable QA Chip). If the ChipT is physically separate from System (e.g. ChipT is on a board connected to System) System must also occasionally (based on system clock for example) call ChipT's Test function with 15 bad data, expecting a 0 response. This is to reduce the possibility of someone inserting a fake ChipT into the system that always returns 1 for the Test function. 5.4 UPGRADE PROTOCOLS This set of protocols describe the means by which a System upgrades a specific data vector Mt 20 within a QA Chip (ChipU). The data vector may contain information about the functioning of the device (e.g. the current maximum operating speed) or the amount of a consumable remaining. The updating of Mt in ChipU falls into two categories: * non-authenticated writes, where anyone is able to update the data vector 25 * authenticated writes, where only authorized entities are able to upgrades data vectors 5.4.1 Non-authenticated writes This is the most frequent type of write, and takes place between the System / consumable during normal everyday operation for M 0 , and during the manufacturing process for Ml. 30 In this kind of write, the System wants to change Mt within ChipU subject to P. For example, the System could be decrementing the amount of consumable remaining. Although System does not need to know and of the Ks or even have access to a trusted chip to perform the write, the System must follow a non-authenticated write by an authenticated read if it needs to know that the write was 35 successful.
WO 2004/050369 PCTIAU2003/001616 637 The protocol requires ChipU to contain the following publicly available function: Write[t, X] Writes X over those parts of Mt subject to Pt and the existing value for M. To authenticate a write of Mew to ChipA's memory M: a. System calls ChipU's Write function, passing in Mnew; 5 b. The authentication procedure for a Read is carried out (see Section 5.3 on page 631); c. If the read succeeds in such a way that Mne, = M returned in b, the write succeeded. If not, it failed. Note that if these parameters are transmitted over an error-prone communications line (as opposed 10 to internally or using an additional error-free transport layer), then an additional checksum would be required to prevent the wrong M from being updated or to prevent the correct M from being updated to the wrong value. For example, SHA-1 [t,X] should be additionally transferred across the communications line and checked (either by a wrapper function around Write or in a variant of Write that takes a hash as an extra parameter). 15 This is the most frequent type of write, and takes place between the System / consumable during normal everyday operation for Mo, and during the manufacturing process for Mi.. 5.4.2 Authenticated writes 20 In the QA Chip protocols, Mo is defined to be the only data vector that can be upgraded in an authenticated way. This decision was made primarily to simplify flash management, although it also helps to reduce the permissions storage requirements. In this kind of write, System wants to change Chip U's Mo in an authorized way, without being 25 subject to the permissions that apply during normal operation. For example, a consumable may be at a refilling station and the normally Decrement Only section of Mo should be updated to include the new valid consumable. In this case, the chip whose Mo is being updated must authenticate the writes being generated by the external System and in addition, apply the appropriate permission for the key to ensure that only the correct parts of Mo are updated. Having a different permission for 30 each key is required as when multiple keys are involved, all keys should not necessarily be given open access to Mo. For example, suppose Mo contains printer speed and a counter of money available for franking. A ChipS that updates printer speed should not be capable of updating the amount of money. Since P0.T.1 is used for non-authenticated writes, each K, has a corresponding permission PTn that determines what can be updated in an authenticated write. 35 The basic principle of the authenticated write (or upgrade) protocol is that the new value for the Mt must be signed before ChipU accepts it. The QA Chip responsible for generating the signature WO 2004/050369 PCTIAU2003/001616 638 (ChipS) must first validate that the ChipU is valid by reading the old value for Mt. Once the old value is seen as valid, a new value can be signed by ChipS and the resultant data plus signature passed to ChipU. Note that both chips distrust each other. 5 There are two forms of authenticated writes. The first form is when both ChipU and ChipS directly store the same key. The second is when both ChipU and ChipS store different versions of the key and a transforming procedure is used on the stored key to generate the required key - i.e. the key is indirectly stored. The second form is slightly more complicated, and only has value when the ChipS is not readily available to an attacker. 10 5.4.2.1 Direct authenticated writes The direct form of the authenticated write protocol is used when the ChipS and ChipU are equally available to an attacker. For example, suppose that ChipU contains a printer's operating speed. Suppose that the speed can be increased by purchasing a ChipS and inserting it into the printer 15 system. In this case, the ChipS and ChipU are equally available to an attacker. This is different from upgrading the printer over the internet where the effective ChipS is in a remote location, and thereby not as readily available to an attacker. The direct authenticated write protocol requires ChipU to contain the following publicly available 20 functions: Read[n, t, X] Advances R, and returns R, Mt, SKn[XIR|C|IMt. The time taken to calculate the signature must not be based on the contents of X, R, Mt, or K. WriteA[n, X, Y, Z] Advances R, replaces M 0 by Y subject to P-rn and returns 1 only if SKn[RIXtC1| Y] 25 = Z. Otherwise returns 0. The time taken to calculate and compare signatures must be independent of data content. This function is identical to ChipT's Test function except that it additionally writes Y subject to P-r+n to its M when the signature matches. Authenticated writes require that the System has access to a ChipS that is capable of generating 30 appropriate signatures. In its basic form, ChipS requires the following variables and function: SignM[n,V,W,X,Y,Z] Advances R, and returns R, SKn[WIRIC1IZ] only if Y = SKn[VIWIC 1X]. Otherwise returns all Os. The time taken to calculate and compare signatures must 35 be independent of data content. To update ChipU's M vector: WO 2004/050369 PCTIAU2003/001616 639 a. System calls ChipUs Read function, passing in n1, 0 (desired vector number) and 0 (the random value, but is a don't-care value) as the input parameters; b. ChipU produces Ru, Muo, SKn1 OIRuIC IMuo) and returns these to System; c. System calls ChipS's SignM function, passing in n2 (the key to be used in ChipS), 0 (the random 5 value as used in a), Ru, Muo, SKn1[OiRuIC1|MuO], and MD (the desired vector to be written to ChipU); d. ChipS produces Rs and SKn 2 [RuIRs|ClIMo] if the inputs were valid, and 0 for all outputs if the inputs were not valid. e. If values returned in d are non zero, then ChipU is considered authentic. System can then call 10 ChipU's WriteA function with these values from d. f. ChipU should return a 1 to indicate success. A 0 should only be returned if the data generated by ChipS is incorrect (e.g. a transmission error). The choice of n1 and n2 must be such that ChipU's K,1 = ChipS's Kn 2 . 15 The data flow for authenticated writes is shown in Figure 330. Note that this protocol allows ChipS to generate a signature for any desired memory vector MD, and therefore a stolen ChipS has the ability to effectively render the particular keys for those parts of MO 20 in ChipU irrelevant. It is therefore not recommended that the basic form of ChipS be ever implemented except in specifically controlled circumstances. 25 It is much more secure to limit the powers of ChipS. The following list covers some of the variants of limiting the power of ChipS: a. the ability to upgrade a limited number of times b. the ability to upgrade based on a credit value - i.e. the upgrade amount is decremented from the local value, and effectively transferred to the upgraded device 30 c. the ability to upgrade to a fixed value or from a limited list d. the ability to upgrade to any value e. the ability to only upgrade certain data fields within M In many of these variants, the ability to refresh the ChipS in some way (e.g. with a new count or 35 credit value) would be a useful feature.
WO 2004/050369 PCTIAU2003/001616 640 In certain cases, the variant is in ChipS, while ChipU remains the same. It may also be desirable to create a ChipU variant, for example only allowing ChipU to only be upgraded a specific number of times. 5 5.4.2.1.1 Variant example This section details the variant for the ability to upgrade a memory vector to any value a specific number of times, but the upgrade is only allowed to affect certain fields within the memory vector i.e. a combination of (a), (d), and (e) above. 10 In this example, ChipS requires the following variables and function: CountRemaining Part of ChipS's Mo that contains the number of signatures that ChipS is allowed to generate. Decrements with each successful call to SignM and SignP. Permissions in ChipS's PO..T- for this part of Mo needs to be ReadOnly once ChipS has been setup. Therefore CountRemaining can only be updated 15 by another ChipS that will perform updates to that part of Mo (assuming ChipS's Ps allows that part of Mo to be updated). Q Part of M that contains the write permissions for updating ChipU's M. By adding Q to ChipS we allow different ChipSs that can update different parts of Mu. Permissions in ChipS's Po T- for this part of M needs to be ReadOnly 20 once ChipS has been setup. Therefore Q can only be updated by another ChipS that will perform updates to that part of M. SignM[n,V,W,X,Y,Z] Advances R, decrements CountRemaining and returns R, ZQx (Z applied to X with permissions Q), SKn[WIRIC1|ZQx] only if Y = SKn[VIWICIIX] and CountRemaining > 0. Otherwise returns all Os. The time taken to calculate 25 and compare signatures must be independent of data content. To update ChipU's M vector: a. System calls ChipU's Read function, passing in n1, 0 (desired vector number) and 0 (the random value, but is a don't-care value) as the input parameters; 30 b. ChipU produces Ru, MUo, Sxn1[0jRujC1|Muo] and returns these to System; c. System calls ChipS's SignM function, passing in n2 (the key to be used in ChipS), 0 (as used in a), Ru, Muo, SKn1[0|RuIC1|Muo], and MD (the desired vector to be written to ChipU); d. ChipS produces Rs, MQD (processed by running MD against MUo using Q) and SKn 2 [RujRsIC1IMQD if the inputs were valid, and 0 for all outputs if the inputs were not valid. 35 e. If values returned in d are non zero, then ChipU is considered authentic. System can then call ChipU's WriteA function with these values from d.
WO 2004/050369 PCTIAU2003/001616 641 f. ChipU should return a I to indicate success. A 0 should only be returned if the data generated by ChipS is incorrect (e.g. a transmission error). The choice of n1 and n2 must be such that ChipU's Kn 1 = ChipS's K1 2 . 5 The data flow for this variant of authenticated writes is shown in Figure 331. Note that Q in ChipS is part of ChipS's M. This allows a user to set up ChipS with a permission set for upgrades. This should be done to ChipS and that part of M designated by PO..T.1 set to ReadOnly 10 before ChipS is programmed with Ku. If Ks is programmed with Ku first, there is a risk of someone obtaining a half-setup ChipS and changing all of Mu instead of only the sections specified by Q. In addition, CountRemaining in ChipS needs to be setup (including making it ReadOnly in Ps) before ChipS is programmed with Ku. ChipS should therefore be programmed to only perform a 15 limited number of SignM operations (thereby limiting compromise exposure if a ChipS is stolen). Thus ChipS would itself need to be upgraded with a new CountRemaining every so often. 5.4.2.2 Indirect authenticated writes This section describes an alternative authenticated write protocol when ChipU is more readily 20 available to an attacker and ChipS is less available to an attacker. We can store different keys on ChipU and ChipS, and implement a mapping between them in such a way that if the attacker is able to obtain a key from a given ChipU, they cannot upgrade all ChipUs. In the general case, this is accomplished by storing key Ks on ChipS, and Ku and f on ChipU. The 25 relationship is f(Ks) = Ku such that knowledge of Ku and f does not make it easy to determine Ks. This implies that a one-way function is desirable for f. In the QA Chip domain, we define f as a number (e.g. 32-bits) such that SHA (Ks If) = Ku. The value of f (random between chips) can be stored in a known location within M 1 as a constant for the 30 life of the QA Chip. It is possible to use the same f for multiple relationships if desired, since f is public and the protection lies in the fact that f varies between QA Chips (preferably in a non predictable way). The indirect protocol is the same as the direct protocol with the exception that f is additionally 35 passed in to the SignM function so that ChipS is able to generate the correct key. The System obtains f by performing a Read of M 1 . Note that all other functions, including the WriteA function in ChipU, are identical to their direct authentication counterparts.
WO 2004/050369 PCTIAU2003/001616 642 SignM[f, n,V,W,X,Y, Z] Advances R, and returns R, Sf(Kn[WIRIC1|Z] only if Y = Sf(Kn)[VIWICIX] and CountRemaining > 0. Otherwise returns all Os. The time taken to calculate and compare signatures must be independent of data content. 5 Before reading ChipU's memory Mo (the pre-upgrade value), the System must extract f from ChipU by performing the following tasks: a. System calls ChipU's Read function, passing in (dontCare, 1, dontCare) b. ChipU returns M 1 , from which System can extract fu c. System stores fu for future use 10 To update ChipU's M vector, the protocol is identical to that described in the basic authenticated write protocol with the exception of steps c and d: c. System calls ChipS's SignM function, passing in fu, n2 (the key to be used in ChipS), 0 (as used in a), Ru, Muo, SKn1[0jRuC1|Muo], and M 0 (the desired vector to be written to ChipU); 15 d. ChipS produces Rs and Sfu(Kn 2 )[RulRsjCjMo] if the inputs were valid, and 0 for all outputs if the inputs were not valid. In addition, the choice of n1 and n2 must be such that ChipU's K" 1 = ChipS's fu(Kn 2 ). 20 Note that fu is obtained from M 1 without validation. This is because there is nothing to be gained by subverting the value of fu, (because then the signatures won't match). From the System's perspective, the protocol would take on a form like the following pseudocode: dontCare, MR, dontCare <- ChipR.Read(dontCare,1, dontCare) 25 fR = extract from MR R, M,, SIGu <- ChipU.Read(keyNumOnChipU,0, 0) Rs, SIGs = ChipS.SignM2(fa, keyNumOnChipS, 0, Ru, Mu, SIGu, MD) If (RS = SIGs = 0) 30 // ChipU and therefore Mu is not to be trusted Else // ChipU and therefore Mu can be trusted ok = ChipU.WriteA(keyNumOnChipU, Rs, MD, SIGs) If (ok) 35 // updating of data in ChipU was successful Else // transmission error during WriteA WO 2004/050369 PCTIAU2003/001616 643 Endif EndIf 5.4.2.2.1 variant example 5 The indirect form of the example from Section 5.4.2.1.1 is shown here. SignM[f,n,V,W,X,Y,Z] Advances R, decrements CountRemaining and returns R, Zax (Z applied to X with permissions Q), Sf(Kn)[WIRIC|ZQAx] only if Y = Sf(Kf)[VlWIC1|X] and CountRemaining > 0. Otherwise returns all Os. The time taken to calculate and compare signatures must be independent of data content. 10 Before reading ChipU's memory Mo (the pre-upgrade value), the System must extract f from ChipU by performing the following tasks: a. System calls ChipU's Read function, passing in (dontCare, 1, dontCare) b. ChipU returns M 1 , from which System can extract fu 15 c. System stores fu for future use To update ChipU's M vector, the protocol is identical to that described in the basic authenticated write protocol with the exception of steps c and d: c. System calls ChipS's SignM function, passing in fu, n2 (the key to be used in ChipS), 0 (as used 20 in a), Ru, MuD, SKn1[0RujC1jMuo], and MD (the desired vector to be written to ChipU); d. ChipS produces Rs, MOD (processed by running M 0 against Muo using Q) and SfU(Kn2)[RujRsIC1|MQD] if the inputs were valid, and 0 for all outputs if the inputs were not valid. In addition, the choice of n1 and n2 must be such that ChipU's Kn 1 = ChipS's fu(Kn 2 ). 25 Note that fu is obtained from M 1 without validation. This is because there is nothing to be gained by subverting the value of fu, (because then the signatures won't match). From the System's perspective, the protocol would take on a form like the following pseudocode: 30 dontCare, MR, dontCare <- ChipR.Read(dontCare,1, dontCare) f= extract from MR Ru, Mu, SIGu <- ChipU. Read (keyNumOnChipU,0, 0) Rs, MQD, SIGs = Chips.SignM2(fa, keyNumOnChipS, 0, RU, Mu, SIGu, MD) 35 If (Rs = MQ =SIGs = 0) // ChipU and therefore Mu is not to be trusted Else WO 2004/050369 PCTIAU2003/001616 644 // ChipU and therefore Mu can be trusted ok = ChipU.WriteA(keyNumOnChipU, Rs, MQD, SIGs) If (ok) // updating of data in ChipU was successful 5 Else // transmission error during WriteA EndIf EndIf 10 5.4.3 Updating permissions for future writes In order to reduce exposure to accidental and malicious attacks on P (and certain parts of M), only authorized users are allowed to update P. Writes to P are the same as authorized writes to M, except that they update Po instead of M. Initially (at manufacture), P is set to be Read/Write for all M. As different processes fill up different parts of M, they can be sealed against future change by 15 updating the permissions. Updating a chip's Po..T-1 changes permissions for unauthorized writes to Mn, and updating PT..T+N-1 changes permissions for authorized writes with key Kn. Pn is only allowed to change to be a more restrictive form of itself. For example, initially all parts of M have permissions of Read/Write. A permission of Read/Write can be updated to Decrement Only 20 or Read Only. A permission of Decrement Only can be updated to become Read Only. A Read Only permission cannot be further restricted. In this transaction protocol, the System's chip is referred to as ChipS, and the chip being updated is referred to as ChipU. Each chip distrusts the other. 25 The protocol requires the following publicly available functions in ChipU: Random[] Returns R (does not advance R). SetPermission[n,p,X,Y,Z] Advances R, and updates P, according to Y and returns 1 followed by the resultant P, only if SK,[RIXIYIC 2 ] = Z. Otherwise returns 0. P, can only become 30 more restricted. Passing in 0 for any permission leaves it unchanged (passing in Y=0 returns the current Pp). Authenticated writes of permissions require that the System has access to a ChipS that is capable of generating appropriate signatures. ChipS requires the following variable: 35 CountRemaining Part of ChipS's Mo that contains the number of signatures that ChipS is allowed to generate. Decrements with each successful call to SignM and SignP. Permissions in ChipS's Po..T1 for this part of Mo needs to be ReadOnly WO 2004/050369 PCTIAU2003/001616 645 once ChipS has been setup. Therefore CountRemaining can only be updated by another ChipS that will perform updates to that part of MO (assuming ChipS's P, allows that part of MO to be updated). 5 In addition, ChipS requires either of the following two SignP functions depending on whether direct or indirect key storage is used (see direct vs indirect authenticated write protocols in Section 5.4.2): SignP[n,X,Y] Used when the same key is directly stored in both ChipS and ChipU. Advances R, decrements CountRemaining and returns R and SKn[XIRIYIC 2 ] only if CountRemaining > 0. Otherwise returns all Os. The time taken to calculate and 10 compare signatures must be independent of data content. SignP[f,n,X,Y] Used when the same key is not directly stored in both ChipS and ChipU. In this case ChipU's K, 1 = ChipS's f(Kn 2 ). The function is identical to the direct form of SignP, except that it additionally accepts f and returns Sf(Kn)[XiRIYIC 2 ] instead of SKn[XIRIYIC 2 ]. 15 5.4.3.1 Direct form of SignP When the direct form of SignP is used, ChipU's P, is updated as follows: a. System calls ChipU's Random function; b. ChipU returns Ru to System; 20 c. System calls ChipS's SignP function, passing in n2, Ru and PD (the desired P to be written to ChipU); d. ChipS produces Rs and SKn 2 [RuIRsIPDIC2] if it is still permitted to produce signatures. e. If values returned in d are non zero, then System can then call ChipU's SetPermission function with n1, the desired permission entry p, Rs, PD and SKn 2 [RuIRsIPDIC 2
]
25 f. ChipU verifies the received signature against its own generated signature SKn1[RUIRSIPDIC 2 ] and applies PD to P, if the signature matches g. System checks 1st output parameter. 1 = success, 0 = failure. The choice of n1 and n2 must be such that ChipU's Kn 1 = ChipS's Kn 2 . 30 The data flow for basic authenticated writes to permissions is shown in Figure 332. 5.4.3.2 Indirect form of SignP When the indirect form of SignP is used in ChipS, the System must extract f from ChipU (so it 35 knows how to generate the correct key) by performing the following tasks: a. System calls ChipU's Read function, passing in (dontCare, 1, dontCare) b. ChipU returns M 1 , from which System can extract fu WO 2004/050369 PCTIAU2003/001616 646 c. System stores fu for future use ChipUs P, is updated as follows: a. System calls ChipU's Random function; 5 b. ChipU returns Ru to System; c. System calls ChipS's SignP function, passing in fu, n2, Ru and PD (the desired P to be written to ChipU); d. ChipS produces Rs and Sfu(Kn2[RulRSlPDIC2] if it is still permitted to produce signatures. e. If values returned in d are non zero, then System can then call ChipUs SetPermission function 10 with n1, the desired permission entry p, Rs, PD and Sfu(Kn 2 )[RuIRslPDIC2] f. ChipU verifies the received signature against SKn1[RuIRsIPDIC 2 ] and applies PD to Pn if the signature matches g. System checks 1st output parameter. 1 = success, 0 = failure. In addition, the choice of n1 and n2 must be such that ChipU's K" 1 = ChipS's fu(Kn 2 ). 15 5.4.4 Protecting memory vectors To protect the appropriate part of M, against unauthorized writes, call SetPermissions[n] for n = 0 to T-1. To protect the appropriate part of Mo against authorized writes with key n, call SetPermissions[T+n] for n=0 to N-1. Note that only Mo can be written in an authenticated fashion. 20 Note that the SetPermission function must be called after the part of M has been set to the desired value. For example, if adding a serial number to an area of M 1 that is currently ReadWrite so that noone is permitted to update the number again: * the Write function is called to write the serial number to M 1 25 9 SetPermission(1) is called for to set that part of M to be ReadOnly for non-authorized writes. If adding a consumable value to Mo such that only keys 1-2 can update it, and keys 0, and 3-N cannot: e the Write function is called to write the amount of consumable to M * SetPermission is called for 0 to set that part of Mo to be DecrementOnly for non-authorized 30 writes. This allows the amount of consumable to decrement. * SetPermission is called for n = {T, T+3, T+4 ..., T+N-1 } to set that part of Mo to be ReadOnly for authorized writes using all but keys 1 and 2. This leaves keys 1 and 2 with ReadWrite permissions to Mo. It is possible for someone who knows a key to further restrict other keys, but it is not in anyone's 35 interest to do so. 5.5 PROGRAMMING K WO 2004/050369 PCTIAU2003/001616 647 In this case, we have a factory chip (ChipF) connected to a System. The System wants to program the key in another chip (ChipP). System wants to avoid passing the new key to ChipP in the clear, and also wants to avoid the possibility of the key-upgrade message being replayed on another ChipP (even if the user doesn't know the key). 5 The protocol assumes that ChipF and ChipP already share (directly or indirectly) a secret key KoId. This key is used to ensure that only a chip that knows KOId can set Knew. Although the example shows a ChipF that is only allowed to program a specific number of ChipPs, 10 the key-upgrade protocol can be easily altered (similar to the way the write protocols have variants) to provide other means of limiting the ability to update ChipPs. The protocol requires the following publicly available functions in ChipP: Random[] Returns R (does not advance R). 15 ReplaceKey[n, X, Y, Z] Replaces Kn by SKn[R|XjC 3 ]GY, advances R, and returns 1 only if SKn[XIYIC 3 ] = Z. Otherwise returns 0. The time taken to calculate signatures and compare values must be identical for all inputs. And the following data and functions in ChipF: 20 CountRemaining Part of Mo with contains the number of signatures that ChipF is allowed to generate. Decrements with each successful call to GetProgramKey. Permissions in P for this part of Mo needs to be ReadOnly once ChipF has been setup. Therefore can only be updated by a ChipS that has authority to perform updates to that part of
M
o . 25 Knew The new key to be transferred from ChipF to ChipP. Must not be visible. After manufacture, Knew is 0. SetPartialKey[X] Updates Knew to be KieweX. This function allows Knew to be programmed in any number of steps, thereby allowing different people or systems to know different parts of the key (but 30 not the whole Knew). K,,, is stored in ChipF's flash memory. In addition, ChipF requires either of the following GetProgramKey functions depending on whether direct or indirect key storage is used on the input key and/or output key (see direct vs indirect authenticated write protocols in Section 5.4.2): 35 GetProgram Keyl [n, X] Direct to direct. Used when the same key (K,) is directly stored in both ChipF and ChipP and we want to store Knew in ChipP. Advances RF, decrements CountRemaining, outputs RF, the encrypted key SKn[XIRFIC3]GKnew and a WO 2004/050369 PCTIAU2003/001616 648 signature of the first two outputs plus C 3 if CountRemaining>O. Otherwise outputs 0. The time to calculate the encrypted key & signature must be identical for all inputs. GetProgramKey2[f, n, X] Direct to indirect. Used when the same key (K,) is directly stored in 5 both ChipF and ChipP but we want to store fp(Kn,,) in ChipP instead of simply Knew (i.e. we want to keep the key in ChipP to be different in all ChipPs). In this case ChipP's Kn 1 = ChipF's fp(Kn 2 ). The function is identical to GetProgramKeyl, except that it additionally accepts fp, and returns SKn[XIRF1C3 IP(Knew) instead of SKn[XIRFIC3] eKnew. Note that the produced signature is produced using Kr since 10 that is what is already stored in ChipP. GetProgramKey3[f, n, X] Indirect to direct. Used when the same key is not directly stored in both ChipF and ChipP but we want to store Knew in ChipP. In this case ChipP's Kn 1 = ChipF's fp(Kn 2 ). The function is identical to GetProgramKeyl, except that it additionally accepts fe, and returns Sp(Kn[XIRFIC3]KneW instead of 15 S"[XjRFIC 3 ]EKnw. The produced signature is produced using fp(Kn) instead of K, since that is what is already stored in ChipP. GetProgramKey4[f, n, X] Indirect to indirect. Used when the same key is not directly stored in both ChipF and ChipP but we want to store fp(Knew) in ChipP instead of simply Knew (i.e. we want to keep the key in ChipP to be different in all ChipPs). In this case 20 ChipP's Kn 1 = ChipF's fp(Kn 2 ). The function is identical to GetProgramKey3, except that it returns SfP(ny)[X[RFIC 3 ]@fP(KnOW) instead of SW(Kn)I(XIRFC3]eKeW. The pro duced signature is produced using fp(K,) since that is what is already stored in ChipP. 25 Since there are likely to be few ChipFs, and many ChipPs, the indirect forms of GetProgramKey can be usefully employed. 5.5.1 GetProgramKeyl - direct to direct With the "old key = direct, new key = direct" form of GetProgramKey, to update P's key: 30 a. System calls ChipP's Random function; b. ChipP returns Rp to System; c. System calls ChipF's GetProgramKey function, passing in n2 (the desired key to use) and the result from b; d. ChipF updates RF, then calculates and returns RF, SKn2[RpRFIC3]@Kfl, and 35 SKn2[RFISKn 2 [RpIRFIC 3 ]eK 6
WIC
3 ]; e. If the response from d is not 0, System calls ChipP's ReplaceKey function, passing in n1 (the key to use in ChipP) and the response from d; WO 2004/050369 PCTIAU2003/001616 649 f. System checks response from ChipP. If the response is 1, then ChipP's Kn 1 has been correctly updated to Knew. If the response is 0, ChipP's Kn 1 has not been updated. The choice of n1 and n2 must be such that ChipP's K, = ChipF's Kn 2 . 5 The data flow for key updates is shown in Figure 333: Note that Knew is never passed in the open. An attacker could send its own Rp, but cannot produce SKn2[RpIRFjC3] without Kn 2 .The signature based on Knew is sent to ensure that ChipP will be able to 10 determine if either of the first two parameters have been changed en route. CountRemaining needs to be setup in MFO (including making it ReadOnly in P) before ChipF is programmed with Kp. ChipF should therefore be programmed to only perform a limited number of GetProgramKey operations (thereby limiting compromise exposure if a ChipF is stolen). An 15 authorized ChipS can be used to update this counter if necessary (see Section 5.4.2 on page 637). 5.5.2 GetProgramKey2 - direct to indirect With the "old key = direct, new key = indirect" form of GetProgramKey, to update P's key, the System must extract f from ChipP (so it can tell ChipF how to generate the correct key) by 20 performing the following tasks: a. System calls ChipP's Read function, passing in (dontCare, 1, dontCare) b. ChipP returns M 1 , from which System can extract fp c. System stores fe for future use 25 ChipP's key is updated as follows: a. System calls ChipP's Random function; b. ChipP returns Rp to System; c. System calls ChipF's GetProgramKey function, passing in fe, n2 (the desired key to use) and the result from b; 30 d. ChipF updates RF, then calculates and returns RF, SKn 2 [RPjRFIC 3 ®fP(KneW), and SKn2[RFISKn2[RpIRFIC 3 ] fP(Knew)IC 3 ]; e. If the response from d is not 0, System calls ChipP's ReplaceKey function, passing in n1 (the key to use in ChipP) and the response from d; f. System checks response from ChipP. If the response is 1, then ChipP's Kn 1 has been correctly 35 updated to fp(Knew). If the response is 0, ChipP's Kn 1 has not been updated. The choice of n1 and n2 must be such that ChipP's Kn 1 = ChipF's Kn 2
.
WO 2004/050369 PCTIAU2003/001616 650 5.5.3 GetProgramKey3 - indirect to direct With the "old key = indirect, new key = direct" form of GetProgramKey, to update P's key, the System must extract f from ChipP (so it can tell ChipF how to generate the correct key) by 5 performing the following tasks: a. System calls ChipP's Read function, passing in (dontCare, 1, dontCare) b. ChipP returns M 1 , from which System can extract fe c. System stores fp for future use 10 ChipP's key is updated as follows: a. System calls ChipP's Random function; b. ChipP returns Rp to System; c. System calls ChipF's GetProgramKey function, passing in fp, n2 (the desired key to use) and the result from b; 15 d. ChipF updates RF, then calculates and returns RF, SfP(Kn 2 )[RpeRFIC 3 ]®Knew, and SfP(Kn2)[RFISfP(Kn2)[RpIRFIC3]@KnewIC3; e. If the response from d is not 0, System calls ChipP's ReplaceKey function, passing in ni (the key to use in ChipP) and the response from d; f. System checks response from ChipP. If the response is 1, then ChipP's Kn 1 has been correctly 20 updated to Knew. If the response is 0, ChipP's Kn 1 has not been updated. The choice of n1 and n2 must be such that ChipP's Kn 1 = ChipF's fp(Kn 2 ). 5.5.4 GetProgramKey4 - indirect to indirect With the "old key = indirect, new key = indirect" form of GetProgramKey, to update P's key, the 25 System must extract f from ChipP (so it can tell ChipF how to generate the correct key) by performing the following tasks: a. System calls ChipP's Read function, passing in (dontCare, 1, dontCare) b. ChipP returns M 1 , from which System can extract fp c. System stores fp for future use 30 ChipP's key is updated as follows: a. System calls ChipP's Random function; b. ChipP returns Re to System; c. System calls ChipF's GetProgramKey function, passing in fe, n2 (the desired key to use) and the 35 result from b; d. ChipF updates RF, then calculates and returns RF, SfP(Kn 2 )[RpIRFIC 3 ]®fp(Knew), and SfP(Kn2)[RFSfp(Kn 2 )[RpIRFIC3]fP(Knew)IC3]; WO 2004/050369 PCTIAU2003/001616 651 e. If the response from d is not 0, System calls ChipP's ReplaceKey function, passing in n1 (the key to use in ChipP) and the response from d; f. System checks response from ChipP. If the response is 1, then ChipP's Kn 1 has been correctly updated to fp(Knew). If the response is 0, ChipP's Kn 1 has not been updated. 5 The choice of n1 and n2 must be such that ChipP's K, 1 = ChipF's fp(Kn 2 ). 5.5.5 Chicken and Egg The Program Key protocol requires both ChipF and ChipP to know Kold (either directly or indirectly). Obviously both chips had to be programmed in some way with Kold, and thus Koad can be thought of 10 as an older Knew: Koad can be placed in chips if another ChipF knows Kolder, and so on. Although this process allows a chain of reprogramming of keys, with each stage secure, at some stage the very first key (Karst) must be placed in the chips. Kfi, is in fact programmed with the chip's microcode at the manufacturing test station as the last step in manufacturing test. Kfrst can be a 15 manufacturing batch key, changed for each batch or for each customer etc., and can have as short a life as desired. Compromising Kfrst need not result in a complete compromise of the chain of Ks. This is especially true if Kgrst is indirectly stored in ChipPs (i.e. each ChipP holds an f and f(Kgrt) instead of K 1 rt directly). One example is where Kfart (the key stored in each chip after manufacture/test) is a batch key, and can be different per chip. Kfrt may advance to a ComCo 20 specific Ksecond etc. but still remain indirect. A direct form (e.g. Kfinal) only needs to go in if it is actually required at the end of the programming chain. Depending on reprogramming requirements, Kfrst can be the same or different for all K. 25 6 Memjet forms of Protocols Physical QA Chips are used in Memjet printer systems to store printer operating parameters as well as consumable parameters. 6.1 PRINTERQA 30 A PRINTERQA is stored within each print engine to perform two primary tasks: * storage and protection of operating parameters * a means of indirect read validation of other QA Chip data vectors WO 2004/050369 PCTIAU2003/001616 652 Each PRINTERQA contains the following keys: Table 229. Keys in PrinterQA Key Contents Comments 0 Upgrade Key Used to upgrade the operating parameters. Should be indirect form of key (i.e. a different key for each PRINTERQA) so that an indirect form of the write is required. I Consumable Read Validation Key Used to indirectly read the data from an CONSUMABLEQA chip using indirect authenticated read protocol Section 5.3.2 on page 633). 2 PrintEngineController Read When reading data from the Validation Key PRINTERQA, the system can either trust the data, or must use this key to perform the authenticated read protocol (see Section 5.3 on page 631). 3-n (reserved) Currently unused. Could be used to provide a means to indirectly read additional print engine operating parameters ala K1, or provide additional Print Engine validation ala K2. 5 Note that if multiple Print Engine Controllers are used (e.g. a multiple SoPEC system), then multiple PrintEngineController Read Validation Keys are required. These keys can be stored within a single PRINTERQA (e.g. in K 3 and beyond), or can be stored in separate PRINTERQAs (for example each SoPEC (or group of SoPECs) has an individual PRINTERQA). 10 The functions required in the PRINTERQA are: * Random, ReplaceKey, to allow key programming & substitution * Read, to allow reads of data * Write, to allow updates of Mj+ during manufacture 15 * WriteAuth, to provide a means of updating the MO data (operating parameters) WO 2004/050369 PCTIAU2003/001616 653 * SetPermissions, to provide a means of updating write permissions * Test, to provide a means of checking if consumable reads are valid * Translate, to provide a means of indirect reading of consumable data 5 6.2 CONSUMABLE QA A CONSUMABLEQA is stored with each consumable (e.g. ink cartridge) to perform two primary tasks: * storage of consumable related data * protection of consumable amount remaining 10 Each CONSUMABLEQA contains the following keys: Table 230. Keys in CONSUMABLEQA Key Contents Comments 0 Upgrade Key Used to upgrade the consumable parameters. Should be stored as the indirect form of the key (i.e. a different key for each CONSUMABLE QA) so that an indirect form of the write is required. 1 Consumable Read Validation Key When reading data from the CONSUMABLE .QA, the system can either trust the data, or must use this key to perform either the direct or indirect authenticated read protocol (see Section 5.3 on page 631). 2 (reserved) Currently unused. 3-n (reserved) Currently unused. 15 The functions required in the CONSUMABLEQA are: * Random, ReplaceKey, to allow key programming & substitution * Read, to allow reads of data * Write, to allow updates of Mj+ during manufacture * WriteAuth, to provide a means of updating the Mo data (consumable remaining) 20 e SetPermissions, to provide a means of updating write permissions WO 2004/050369 PCTIAU2003/001616 654 AUTHENTICATION OF CONSUMABLES 1 Introduction Manufacturers of systems that require consumables (such as a laser printer that requires toner 5 cartridges) have struggled with the problem of authenticating consumables, to varying levels of success. Most have resorted to specialized packaging that involves a patent. However this does not stop home refill operations or clone manufacture in countries with weak industrial property protection. The prevention of copying is important to prevent poorly manufactured substitute consumables from damaging the base system. For example, poorly filtered ink may clog print 10 nozzles in an ink jet printer, causing the consumer to blame the system manufacturer and not admit the use of non-authorized consumables. To solve the authentication problem, this document describes an QA Chip that contains authentication keys and circuitry specially designed to prevent copying. The chip is manufactured 15 using the standard Flash memory manufacturing process, and is low cost enough to be included in consumables such as ink and toner cartridges. The implementation is approximately 1mm2 in a 0.25 micron flash process, and has an expected manufacturing cost of approximately 10 cents in 2003. 20 2 NSA Once programmed, the QA Chips as described here are compliant with the NSA export guidelines since they do not constitute a strong encryption device. They can therefore be practically manufactured in the USA (and exported) or anywhere else in the world. 25 3 Nomenclature The following symbolic nomenclature is used throughout this document: Table 231. Summary of symbolic nomenclature Symbol Description F[X] Function F, taking a single parameter X F[X, Y] Function F, taking two parameters, X and Y X Y X concatenated with Y XA Y Bitwise X AND Y Xv Y Bitwise X OR Y (inclusive-OR) X ( Y Bitwise X XOR Y (exclusive-OR) X Bitwise NOT X (complement) WO 2004/050369 PCTIAU2003/001616 655 X <- Y X is assigned the value Y X <- {Y, Z} The domain of assignment inputs to X is Y and Z X= Y X is equal to Y X#w Y X is not equal to Y 4X Decrement X by 1 (floor 0) X Increment X by 1 (modulo register length) Erase X Erase Flash memory register X SetBits[X, Y] Set the bits of the Flash memory register X based on Y Z +- ShiftRight[X, Y] Shift register X right one bit position, taking input bit from Y and placing the output bit in Z 4 PSEUDOCODE 4.1.1 Asynchronous The following pseudocode: var = expression 5 means the var signal or output is equal to the evaluation of the expression. 4.1.2 Synchronous The following pseudocode: var +- expression means the var register is assigned the result of evaluating the expression during this cycle. 10 4.1.3 Expression Expressions are defined using the nomenclature in Table 231 above. Therefore: var = (a = b) is interpreted as the var signal is I if a is equal to b, and 0 otherwise. 4.2 DIAGRAMS 15 Black is used to denote data, and red to denote 1-bit control-signal lines. 4.3 QA CHIP TERMINOLOGY This document refers to QA Chips by their function in particular protocols: " For authenticated reads, ChipA is the QA Chip being authenticated, and ChipT is the QA Chip that is trusted. 20 - For replacement of keys, ChipP is the QA Chip being programmed with the new key, and ChipF is the factory QA Chip that generates the message to program the new key. * For upgrades of data in a QA Chip, ChipU is the QA Chip being upgraded, and ChipS is the QA Chip that signs the upgrade value. Any given physical QA Chip will contain functionality that allows it to operate as an entity in some 25 number of these protocols.
WO 2004/050369 PCTIAU2003/001616 656 Therefore, wherever the terms ChipA, ChipT, ChipP, ChipF, ChipU and ChipS are used in this document, they are referring to logical entities involved in an authentication protocol as defined in subsequent sections. 5 Physical QA Chips are referred to by their location. For example, each ink cartridge may contain a QA Chip referred to as an INKQA, with all INKQA chips being on the same physical bus. In the same way, the QA Chip inside a printer is referred to as PRINTERQA, and will be on a separate bus to the INKQA chips. 10 5 Concepts and Terms This chapter provides a background to the problem of authenticating consumables. For more in depth introductory texts, see [12], [78], and [56]. 5.1 BASIC TERMS 15 A message, denoted by M, is plaintext. The process of transforming M into ciphertext C, where the substance of M is hidden, is called encryption. The process of transforming C back into M is called decryption. Referring to the encryption function as E, and the decryption function as D, we have the following identities: E [M]= C D[C]= M 20 Therefore the following identity is true: D[E[M]] = M 5.2 SYMMETRIC CRYPTOGRAPHY A symmetric encryption algorithm is one where: 25 * the encryption function E relies on key K1, * the decryption function D relies on key K2, * K 2 can be derived from K 1 , and * K 1 can be derived from K 2 . In most symmetric algorithms, K, equals K2. However, even if K 1 does not equal K 2 , given that one 30 key can be derived from the other, a single key K can suffice for the mathematical definition. Thus: EK[M] = C DK[C] = M WO 2004/050369 PCTIAU2003/001616 657 The security of these algorithms rests very much in the key K. Knowledge of K allows anyone to encrypt or decrypt. Consequently K must remain a secret for the duration of the value of M. For example, M may be a wartime message "My current position is grid position 123-456". Once the war is over the value of M is greatly reduced, and if K is made public, the knowledge of the combat 5 unit's position may be of no relevance whatsoever. Of course if it is politically sensitive for the combat unit's position to be known even after the war, K may have to remain secret for a very long time. An enormous variety of symmetric algorithms exist, from the textbooks of ancient history through to 10 sophisticated modern algorithms. Many of these are insecure, in that modern cryptanalysis techniques (see Section 5.7 on page 673) can successfully attack the algorithm to the extent that K can be derived. The security of the particular symmetric algorithm is a function of two things: the strength of the 15 algorithm and the length of the key [78]. The strength of an algorithm is difficult to quantify, relying on its resistance to cryptographic attacks (see Section 5.7 on page 673). In addition, the longer that an algorithm has remained in the public eye, and yet remained unbroken in the midst of intense scrutiny, the more secure the algorithm is 20 likely to be. By contrast, a secret algorithm that has not been scrutinized by cryptographic experts is unlikely to be secure. Even if the algorithm is "perfectly" strong (the only way to break it is to try every key - see Section 5.7.1.5 on page 674), eventually the right key will be found. However, the more keys there are, the 25 more keys have to be tried. If there are N keys, it will take a maximum of N tries. If the key is N bits long, it will take a maximum of 2 m tries, with a 50% chance of finding the key after only half the attempts ( 2 N-1). The longer N becomes, the longer it will take to find the key, and hence the more secure it is. What makes a good key length depends on the value of the secret and the time for which the secret must remain secret as well as available computing resources. 30 In 1996, an ad hoc group of world-renowned cryptographers and computer scientists released a report [9] describing minimal key lengths for symmetric ciphers to provide adequate commercial security. They suggest an absolute minimum key length of 90 bits in order to protect data for 20 years, and stress that increasingly, as cryptosystems succumb to smarter attacks than brute-force 35 key search, even more bits may be required to account for future surprises in cryptanalysis techniques.
WO 2004/050369 PCTIAU2003/001616 658 We will ignore most historical symmetric algorithms on the grounds that they are insecure, especially given modern computing technology. Instead, we will discuss the following algorithms: * DES * Blowfish 5 e RC5 * IDEA 5.2.1 DES DES (Data Encryption Standard) [26] is a US and international standard, where the same key is used to encrypt and decrypt. The key length is 56 bits. It has been implemented in hardware and 10 software, although the original design was for hardware only. The original algorithm used in DES was patented in 1976 (US patent number 3,962,539) and has since expired. During the design of DES, the NSA (National Security Agency) provided secret S-boxes to perform the key-dependent nonlinear transformations of the data block. After differential cryptanalysis was discovered outside the NSA, it was revealed that the DES S-boxes were specifically designed to be 15 resistant to differential cryptanalysis. As described in [95], using 1993 technology, a 56-bit DES key can be recovered by a custom designed $1 million machine performing a brute force attack in only 35 minutes. For $10 million, the key can be recovered in only 3.5 minutes. DES is clearly not secure now, and will become less so in the future. 20 A variant of DES, called triple-DES is more secure, but requires 3 keys: K 1 , K 2 , and K 3 . The keys are used in the following manner:
EK
3 [Dxz[EK1[M]]] = C
DK
3 [Ex 2 [DKj[C]]] = M The main advantage of triple-DES is that existing DES implementations can be used to give more 25 security than single key DES. Specifically, triple-DES gives protection of equivalent key length of 112 bits [78]. Triple-DES does not give the equivalent protection of a 168-bit key (3 x 56) as one might naively expect. Equipment that performs triple-DES decoding and/or encoding cannot be exported from the United States. 30 5.2.2 Blowfish Blowfish is a symmetric block cipher first presented by Schneier in 1994 [76]. It takes a variable length key, from 32 bits to 448 bits, is unpatented, and is both license and royalty free. In addition, it is much faster than DES. The Blowfish algorithm consists of two parts: a key-expansion part and a data-encryption part. Key 35 expansion converts a key of at most 448 bits into several subkey arrays totaling 4168 bytes. Data WO 2004/050369 PCTIAU2003/001616 659 encryption occurs via a 16-round Feistel network. All operations are XORs and additions on 32-bit words, with four index array lookups per round. It should be noted that decryption is the same as encryption except that the subkey arrays are used in the reverse order. Complexity of implementation is therefore reduced compared to other 5 algorithms that do not have such symmetry. [771 describes the published attacks which have been mounted on Blowfish, although the algorithm remains secure as of February 1998 [79]. The major finding with these attacks has been the discovery of certain weak keys. These weak keys can be tested for during key generation. For more information, refer to [77] and [79]. 10 5.2.3 RC5 Designed by Ron Rivest in 1995, RC5 [74] has a variable block size, key size, and number of rounds. Typically, however, it uses a 64-bit block size and a 128-bit key. The RC5 algorithm consists of two parts: a key-expansion part and a data-encryption part. Key expansion converts a key into 2r+2 subkeys (where r = the number of rounds), each subkey being 15 w bits. For a 64-bit blocksize with 16 rounds (w=32, r=16), the subkey arrays total 136 bytes. Data encryption uses addition mod 2w, XOR and bitwise rotation. An initial examination by Kaliski and Yin [43] suggested that standard linear and differential cryptanalysis appeared impractical for the 64-bit blocksize version of the algorithm. Their differential attacks on 9 and 12 round RC5 require 245 and 262 chosen plaintexts respectively, while the linear 20 attacks on 4, 5, and 6 round RC5 requires 21, 24 and 25 known plaintexts). These two attacks are independent of key size. More recently however, Knudsen and Meier [47] described a new type of differential attack on RC5 that improved the earlier results by a factor of 128, showing that RC5 has certain weak keys. RC5 is protected by multiple patents owned by RSA Laboratories. A license must be obtained to 25 use it. 5.2.4 IDEA Developed in 1990 by Lai and Massey [53], the first incarnation of the IDEA cipher was called PES. After differential cryptanalysis was discovered by Biham and Shamir in 1991, the algorithm was strengthened, with the result being published in 1992 as IDEA [52]. 30 IDEA uses 128-bit keys to operate on 64-bit plaintext blocks. The same algorithm is used for encryption and decryption. It is generally regarded as the most secure block algorithm available today [78][78]. The biggest drawback of IDEA is the fact that it is patented (US patent number 5,214,703, issued in 1993), and a license must be obtained from Ascom Tech AG (Bern) to use it. 35 5.3 ASYMMETRIC CRYPTOGRAPHY An asymmetric encryption algorithm is one where: WO 2004/050369 PCTIAU2003/001616 660 * the encryption function E relies on key K 1 , * the decryption function D relies on key K2, * K2 cannot be derived from K1 in a reasonable amount of time, and * K 1 cannot be derived from K2 in a reasonable amount of time. 5 Thus: EKI [M] = C
DK
2 [C] = M These algorithms are also called public-key because one key K1 can be made public. Thus anyone can encrypt a message (using KI) but only the person with the corresponding decryption key (K2) can decrypt and thus read the message. 10 In most cases, the following identity also holds:
EK
2 [M] = C
DK
1 [C] = M This identity is very important because it implies that anyone with the public key K1 can see M and know that it came from the owner of K2. No-one else could have generated C because to do so 15 would imply knowledge of K2. This gives rise to a different application, unrelated to encryption digital signatures. The property of not being able to derive K1 from K2 and vice versa in a reasonable time is of course clouded by the concept of reasonable time. What has been demonstrated time after time, is that a 20 calculation that was thought to require a long time has been made possible by the introduction of faster computers, new algorithms etc. The security of asymmetric algorithms is based on the difficulty of one of two problems: factoring large numbers (more specifically large numbers that are the product of two large primes), and the difficulty of calculating discrete logarithms in a finite field. Factoring large numbers is conjectured to be a hard problem given today's understanding of 25 mathematics. The problem however, is that factoring is getting easier much faster than anticipated. Ron Rivest in 1977 said that factoring a 125-digit number would take 40 quadrillion years [30]. In 1994 a 129-digit number was factored [3]. According to Schneier, you need a 1024-bit number to get the level of security today that you got from a 512-bit number in the 1980s [78]. If the key is to last for some years then 1024 bits may not even be enough. Rivest revised his key length estimates 30 in 1990: he suggests 1628 bits for high security lasting until 2005, and 1884 bits for high security lasting until 2015 [69]. Schneier suggests 2048 bits are required in order to protect against corporations and governments until 2015 [80].
WO 2004/050369 PCTIAU2003/001616 661 Public key cryptography was invented in 1976 by Diffie and Hellman [15][15], and independently by Merkle [57]. Although Diffie, Hellman and Merkle patented the concepts (US patent numbers 4,200,770 and 4,218,582), these patents expired in 1997. A number of public key cryptographic algorithms exist. Most are impractical to implement, and 5 many generate a very large C for a given M or require enormous keys. Still others, while secure, are far too slow to be practical for several years. Because of this, many public key systems are hybrid - a public key mechanism is used to transmit a symmetric session key, and then the session key is used for the actual messages. All of the algorithms have a problem in terms of key selection. A random number is simply not 10 secure enough. The two large primes p and q must be chosen carefully - there are certain weak combinations that can be factored more easily (some of the weak keys can be tested for). But nonetheless, key selection is not a simple matter of randomly selecting 1024 bits for example. Consequently the key selection process must also be secure. Of the practical algorithms in use under public scrutiny, the following are discussed: 15 - RSA * DSA * ElGamal 5.3.1 RSA The RSA cryptosystem [75], named after Rivest, Shamir, and Adleman, is the most widely used 20 public key cryptosystem, and is a de facto standard in much of the world [78]. The security of RSA depends on the conjectured difficulty of factoring large numbers that are the product of two primes (p and q). There are a number of restrictions on the generation of p and q. They should both be large, with a similar number of bits, yet not be close to one another (otherwise p = q =Ipq). In addition, many authors have suggested that p and q should be strong primes [56]. 25 The Hellman-Bach patent (US patent number 4,633,036) covers a method for generating strong RSA primes p and q such that n = pq and factoring n is believed to be computationally infeasible. The RSA algorithm patent was issued in 1983 (US patent number 4,405,829). The patent expires on September 20, 2000. 5.3.2 DSA 30 DSA (Digital Signature Algorithm) is an algorithm designed as part of the Digital Signature Standard (DSS) [29]. As defined, it cannot be used for generalized encryption. In addition, compared to RSA, DSA is 10 to 40 times slower for signature verification [40]. DSA explicitly uses the SHA-1 hashing algorithm (see Section 5.5.3.3 on page 667). DSA key generation relies on finding two primes p and q such that q divides p-i. According to 35 Schneier [78], a 1024-bit p value is required for long term DSA security. However the DSA standard [29] does not permit values of p larger than 1024 bits (p must also be a multiple of 64 bits).
WO 2004/050369 PCTIAU2003/001616 662 The US Government owns the DSA algorithm and has at least one relevant patent (US patent 5,231,688 granted in 1993). However, according to NIST [61]: "The DSA patent and any foreign counterparts that may issue are available for use without any written permission from or any payment of royalties to the U. S. 5 government." In a much stronger declaration, NIST states in the same document [61] that DSA does not infringe third party's rights: "NIST reviewed all of the asserted patents and concluded that none of them would be infringed by DSS. Extra protection will be written into the PKI pilot project that will 10 prevent an organization or individual from suing anyone except the government for patent infringement during the course of the project." It must however, be noted that the Schnorr authentication algorithm [81] (US patent 4,995,082) patent holder claims that DSA infringes his patent. The Schnorr patent is not due to expire until 2008. 15 5.3.3 ElGamal The ElGamal scheme [22][22] is used for both encryption and digital signatures. The security is based on the conjectured difficulty of calculating discrete logarithms in a finite field. Key selection involves the selection of a prime p, and two random numbers g and x such that both g and x are less than p. Then calculate y = gx mod p. The public key is y, g, and p. The private key 20 is x. ElGamal is unpatented. Although it uses the patented Diffie-Hellman public key algorithm [115][15], those patents expired in 1997. ElGamal public key encryption and digital signatures can now be safely used without infringing third party patents. 5.4 CRYPTOGRAPHIC CHALLENGE-RESPONSE PROTOCOLS AND ZERO KNOWLEDGE PROOFS 25 The general principle of a challenge-response protocol is to provide identity authentication. The simplest form of challenge-response takes the form of a secret password. A asks B for the secret password, and if B responds with the correct password, A declares B authentic. There are three main problems with this kind of simplistic protocol. Firstly, once B has responded 30 with the password, any observer C will know what the password is. Secondly, A must know the password in order to verify it. Thirdly, if C impersonates A, then B will give the password to C (thinking C was A), thus compromising the password. Using a copyright text (such as a haiku) as the password is not sufficient, because we are 35 assuming that anyone is able to copy the password (for example in a country where intellectual property is not respected).
WO 2004/050369 PCT/AU2003/001616 663 The idea of cryptographic challenge-response protocols is that one entity (the claimant) proves its identity to another (the verifier) by demonstrating knowledge of a secret known to be associated with that entity, without revealing the secret itself to the verifier during the protocol 156]. In the generalized case of cryptographic challenge-response protocols, with some schemes the verifier 5 knows the secret, while in others the secret is not even known by the verifier. A good overview of these protocols can be found in [25], [78], and [56]. Since this documentation specifically concerns Authentication, the actual cryptographic challenge response protocols used for authentication are detailed in the appropriate sections. However the 10 concept of Zero Knowledge Proofs bears mentioning here. The Zero Knowledge Proof protocol, first described by Feige, Fiat and Shamir in [24] is extensively used in Smart Cards for the purpose of authentication [34][34][34]. The protocol's effectiveness is based on the assumption that it is computationally infeasible to compute square roots modulo a 15 large composite integer with unknown factorization. This is provably equivalent to the assumption that factoring large integers is difficult. It should be noted that there is no need for the claimant to have significant computing power. Smart cards implement this kind of authentication using only a few modulo multiplications [34][34]. 20 Finally, it should be noted that the Zero Knowledge Proof protocol is patented [82] (US patent 4,748,668, issued May 31, 1988). 5.5 ONE-WAY FUNCTIONS A one-way function F operates on an input X, and returns F[X] such that X cannot be determined 25 from F[X]. When there is. no restriction on the format of X, and F[X] contains fewer bits than X, then collisions must exist. A collision is defined as two different X input values producing the same F[X] value - i.e. X1 and X 2 exist such that X 1 + X 2 yet F[X 1 ] = F[X 2 ]. When X contains more bits than F[X], the input must be compressed in some way to create the 30 output. In many cases, X is broken into blocks of a particular size, and compressed over a number of rounds, with the output of one round being the input to the next. The output of the hash function is the last output once X has been consumed. A pseudo-collision of the compression function CF is defined as two different initial values V 1 and V 2 and two inputs X 1 and X 2 (possibly identical) are given such that CF(V 1 , X 1 ) = CF(V 2 , X 2 ). Note that the existence of a pseudo-collision does not 35 mean that it is easy to compute an X 2 for a given X 1
.
WO 2004/050369 PCT/AU2003/001616 664 We are only interested in one-way functions that are fast to compute. In addition, we are only interested in deterministic one-way functions that are repeatable in different implementations. Consider an example F where F[X] is the time between calls to F. For a given F{X) X cannot be determined because X is not even used by F. However the output from F will be different for 5 different implementations. This kind of F is therefore not of interest. In the scope of this document, we are interested in the following forms of one-way functions: * Encryption using an unknown key e Random number sequences 10 * Hash Functions e Message Authentication Codes 5.5.1 Encryption using an unknown key When a message is encrypted using an unknown key K, the encryption function E is effectively 15 one-way. Without the key, it is computationally infeasible to obtain M from EK[M] without K. An encryption function is only one-way for as long as the key remains hidden. An encryption algorithm does not create collisions, since E creates EK[M] such that it is possible to reconstruct M using function D. Consequently F(X] contains at least as many bits as X (no 20 information is lost) if the one-way function F is E. Symmetric encryption algorithms (see Section 5.2 on page 656) have the advantage over asymmetric algorithms (see Section 5.3 on page 659) for producing one-way functions based on encryption for the following reasons: 25 e The key for a given strength encryption algorithm is shorter for a symmetric algorithm than an asymmetric algorithm Symmetric algorithms are faster to compute and require less software or silicon Note however, that the selection of a good key depends on the encryption algorithm chosen. Certain keys are not strong for particular encryption algorithms, so any key needs to be tested for 30 strength. The more tests that need to be performed for key selection, the less likely the key will remain hidden. 5.5.2 Random number sequences Consider a random number sequence RD, R 1 , ..., R;, R 1 1. We define the one-way function F such 35 that F[X] returns the Xth random number in the random sequence. However we must ensure that F[X] is repeatable for a given X on different implementations. The random number sequence WO 2004/050369 PCT/AU2003/001616 665 therefore cannot be truly random. Instead, it must be pseudo-random, with the generator making use of a specific seed. There are a large number of issues concerned with defining good random number generators. 5 Knuth, in [48] describes what makes a generator "good" (including statistical tests), and the general problems associated with constructing them. Moreau gives a high level survey of the current state of the field in [60]. The majority of random number generators produce the P random number from the i-1th state - the 10 only way to determine the /t number is to iterate from the 0 th number to the /h. if i is large, it may not be practical to wait for i iterations. However there is a type of random number generator that does allow random access. In (10], Blum, Blum and Shub define the ideal generator as follows: "... we would like a pseudo-random sequence 15 generator to quickly produce, from short seeds, long sequences (of bits) that appear in every way to be generated by successive flips of a fair coin". They defined the X2 mod n generator {10], more commonly referred to as the BBS generator. They showed that given certain assumptions upon which modern cryptography relies, a BBS generator passes extremely stringent statistical tests, 20 The BBS generator relies on selecting n which is a Blum integer (n = pq where p and q are large prime numbers, p ; q, p mod 4 = 3, and q mod 4 = 3). The initial state of the generator is given by xO where xO = x 2 mod n, and x is a random integer relatively prime to n. The /M pseudo-random bit is the least significant bit of xi where: = x mod n 25 As an extra property, knowledge of p and q allows a direct calculation of the lh number in the sequence as follows: x x 0 Ymod n where y = 2' mod ((p - 1)(q - 1)) Without knowledge of p and q, the generator must iterate (the security of calculation relies on the 30 conjectured difficulty of factoring large numbers). When first defined, the primary problem with the BBS generator was the amount of work required for a single output bit. The algorithm was considered too slow for most applications. However the WO 2004/050369 PCT/AU2003/001616 666 advent of Montgomery reduction arithmetic [58] has given rise to more practical implementations, such as [59]. In addition, Vazirani and Vazirani have shown in [93] that depending on the size of n, more bits can safely be taken from xj without compromising the security of the generator. 5 Assuming we only take 1 bit per x, N bits (and hence N iterations of the bit generator function) are needed in order to generate an N-bit random number. To the outside observer, given a particular set of bits, there is no way to determine the next bit other than a 50/50 probability. If the x, p and q are hidden, they act as a key, and it is computationaly infeasible to take an output bit stream and compute x, p, and q. It is also computationally infeasible to determine the value of i used to 10 generate a given set of pseudo-random bits. This last feature makes the generator one-way. Different values of i can produce identical bit sequences of a given length (e.g. 32 bits of random bits). Even if x, p and q are known, for a given Fli,, i can only be derived as a set of possibilities, not as a certain value (of course if the domain of 1 is known, then the set of possibilities is reduced further). 15 However, there are problems in selecting a good p and q, and a good seed x. In particular, Ritter in [68] describes a problem in selecting x. The nature of the problem is that a BBS generator does not create a single cycle of known length. Instead, it creates cycles of various lengths, including degenerate (zero-length) cycles. Thus a BBS generator cannot be initialized with a random state - it 20 might be on a short cycle. Specific algorithms exist in section 9 of [10] to determine the length of the period for a given seed given certain strenuous conditions for n. 5.5.3 Hash functions Special one-way functions, known as Hash functions, map arbitrary length messages to fixed 25 length hash values. Hash functions are referred to as HIM]. Since the input is of arbitrary length, a hash function has a compression component in order to produce a fixed length output. Hash functions also have an obfuscation component in order to make it difficult to find collisions and to determine information about M from H[M]. 30 Because collisions do exist, most applications require that the hash algorithm is preimage resistant, in that for a given X 1 it is difficult to find X 2 such that H[X 1 ] = H[X 2 ]. In addition, most applications also require the hash algorithm to be collision resistant (i.e. it should be hard to find two messages
X
1 and X 2 such that H[X 1 ] = H[X 2 ]). However, as described in [20], it is an open problem whether a collision-resistant hash function, in the ideal sense, can exist at all. 35 WO 2004/050369 PCTIAU2003/001616 667 The primary application for hash functions is in the reduction of an input message into a digital "fingerprint" before the application of a digital signature algorithm. One problem of collisions with digital signatures can be seen in the following example. A has a long message M 1 that says 7 owe B $10". A signs H[M 1 ] using his private 5 key. B, being greedy, then searches for a collision message M 2 where H[M 2 ] = H[M 1 ] but where M 2 is favorable to B, for example "I owe B millionon. Clearly it is in A's interest to ensure that it is difficult to find such an M 2 . Exam ples of collision resistant one-way hash functions are SHA-1 [28], MD5 [73] and RIPEMD-160 10 [66], all derived from MD4 [70][70]. 5.5.3.1 MD4 Ron Rivest introduced MD4 [70][70] in 1990. It is only mentioned here because all other one-way hash functions are derived in some way from MD4. 15 MD4 is now considered completely broken [18)[18] in that collisions can be calculated instead of searched for. In the example above, B could trivially generate a substitute message M 2 with the same hash value as the original message M 1 . 20 5.5.3.2 MD5 Ron Rivest introduced MD5 [73] in 1991 as a more secure MD4. Like MD4, MD5 produces a 128 bit hash value. MD5 is not patented [80]. Dobbertin describes the status of MD5 after recent attacks [20]. He describes how pseudo 25 collisions have been found in MD5, indicating a weakness in the compression function, and more recently, collisions have been found. This means that MD5 should not be used for compression in digital signature schemes where the existence of collisions may have dire consequences. However MD5 can still be used as a one-way function. In addition, the HMAC-MD5 construct (see Section 5.5.4.1 on page 670) is not affected by these recent attacks. 30 5.5.3.3 SHA-1 SHA-1 [28] is very similar to MD5, but has a 160-bit hash value (MD5 only has 128 bits of hash value). SHA-1 was designed and introduced by the NIST and NSA for use in the Digital Signature Standard (DSS). The original published description was called SHA [27], but very soon afterwards, 35 was revised to become SHA-1 [28], supposedly to correct a security flaw in SHA (although the NSA has not released the mathematical reasoning behind the change).
WO 2004/050369 PCTIAU2003/001616 668 There are no known cryptographic attacks against SHA-1 [78]. It is also more resistant to brute force attacks than MD4 or MD5 simply because of the longer hash result. The US Government owns the SHA-1 and DSA algorithms (a digital signature authentication 5 algorithm defined as part of DSS [29]) and has at least one relevant patent (US patent 5,231,688 granted in 1993). However, according to NIST [61]: "The DSA patent and any foreign counterparts that may issue are available for use without any written permission from or any payment of royalties to the U.S. government." 10 In a much stronger declaration, NIST states in the same document [61] that DSA and SHA-1 do not infringe third party's rights: "NIST reviewed all of the asserted patents and concluded that none of them would be infringed by DSS. Extra protection will be written into the PKI pilot project that will 15 prevent an organization or individual from suing anyone except the government for patent infringement during the course of the project." It must however, be noted that the Schnorr authentication algorithm [81] (US patent number 4,995,082) patent holder claims that DSA infringes his patent. The Schnorr patent is not due to 20 expire until 2008. Fortunately this does not affect SHA-1. 5.5.3.4 RIPEMD-160 RIPEMD-160 [66] is a hash function derived from its predecessor RIPEMD [11] (developed for the European Community's RIPE project in 1992). As its name suggests, RIPEMD-160 produces a 25 160-bit hash result. Tuned for software implementations on 32-bit architectures, RIPEMD-160 is intended to provide a high level of security for 10 years or more. Although there have been no successful attacks on RIPEMD-160, it is comparatively new and has not been extensively cryptanalyzed. The original RIPEMD algorithm [11] was specifically designed 30 to resist known cryptographic attacks on MD4. The recent attacks on MD5 (detailed in [201) showed similar weaknesses in the RIPEMD 128-bit hash function. Although the attacks showed only theoretical weaknesses, Dobbertin, Preneel and Bosselaers further strengthened RIPEMD into a new algorithm RIPEMD-1 60. 35 RIPEMD-160 is in the public domain, and requires no licensing or royalty payments. 5.5.4 Message authentication codes WO 2004/050369 PCTIAU2003/001616 669 The problem of message authentication can be summed up as follows: How can A be sure that a message supposedly from B is in fact from B? Message authentication is different from entity authentication (described in the section on 5 cryptographic challenge-response protocols). With entity authentication, one entity (the claimant) proves its identity to another (the verifier). With message authentication, we are concerned with making sure that a given message is from who we think it is from i.e. it has not been tampered with en route from the source to its destination. While this section has a brief overview of message authentication, a more detailed survey can be found in [88]. 10 A one-way hash function is not sufficient protection for a message. Hash functions such as MD5 rely on generating a hash value that is representative of the original input, and the original input cannot be derived from the hash value. A simple attack by E, who is in-between A and B, is to intercept the message from B, and substitute his own. Even if A also sends a hash of the original 15 message, E can simply substitute the hash of his new message. Using a one-way hash function alone, A has no way of knowing that B's message has been changed. One solution to the problem of message authentication is the Message Authentication Code, or MAC. 20 When B sends message M, it also sends MAC[M] so that the receiver will know that M is actually from B. For this to be possible, only B must be able to produce a MAC of M, and in addition, A should be able to verify M against MAC[M]. Notice that this is different from encryption of M - MACs are useful when M does not have to be secret. 25 The simplest method of constructing a MAC from a hash function is to encrypt the hash value with a symmetric algorithm: 1. Hash the input message H[M] 2. Encrypt the hash EK[H[M]] 30 This is more secure than first encrypting the message and then hashing the encrypted message. Any symmetric or asymmetric cryptographic function can be used, with the appropriate advantages and disadvantage of each type described in Section 5.2 on page 656 and Section 5.3 on page 659. 35 However, there are advantages to using a key-dependent one-way hash function instead of techniques that use encryption (such as that shown above): 0 Speed, because one-way hash functions in general work much faster than encryption; WO 2004/050369 PCTIAU2003/001616 670 * Message size, because EK[M] is at least the same size as M, while H[M] is a fixed size (usually considerably smaller than M); * Hardware/software requirements - keyed one-way hash functions are typically far less complex than their encryption-based counterparts; and 5 e One-way hash function implementations are not considered to be encryption or decryption devices and therefore are not subject to US export controls. It should be noted that hash functions were never originally designed to contain a key or to support message authentication. As a result, some ad hoc methods of using hash functions to perform message authentication, including various functions that concatenate messages with secret 10 prefixes, suffixes, or both have been proposed [56][56]. Most of these ad hoc methods have been successfully attacked by sophisticated means [42][42][42]. Additional MACs have been suggested based on XOR schemes [8] and Toeplitz matrices [49] (including the special case of LFSR-based (Linear Feed Shift Register) constructions). 15 5.5.4.1 HMAC The HMAC construction [6][6] in particular is gaining acceptance as a solution for Internet message authentication security protocols. The HMAC construction acts as a wrapper, using the underlying hash function in a black-box way. Replacement of the hash function is straightforward if desired due to security or performance reasons. However, the major advantage of the HMAC construct is that it 20 can be proven secure provided the underlying hash function has some reasonable cryptographic strengths -that is, HMAC's strengths are directly connected to the strength of the hash function [6]. Since the HMAC construct is a wrapper, any iterative hash function can be used in an HMAC. Examples include HMAC-MD5, HMAC-SHA1, HMAC-RIPEMD1 60 etc. 25 Given the following definitions: * H = the hash function (e.g. MD5 or SHA-1) * n = number of bits output from H (e.g. 160 for SHA-1, 128 bits for MD5) * M = the data to which the MAC function is to be applied 30 * K = the secret key shared by the two parties * ipad = 0x36 repeated 64 times * opad = Ox5C repeated 64 times The HMAC algorithm is as follows: 35 1. Extend K to 64 bytes by appending OxO bytes to the end of K 2. XOR the 64 byte string created in (1) with ipad 3. append data stream M to the 64 byte string created in (2) WO 2004/050369 PCTIAU2003/001616 671 4. Apply H to the stream generated in (3) 5. XOR the 64 byte string created in (1) with opad 6. Append the H result from (4) to the 64 byte string resulting from (5) 7. Apply H to the output of (6) and output the result 5 Thus: HMAC[M] = H[(K @ opad) I H[(K @ ipad) I MI] The recommended key length is at least n bits, although it should not be longer than 64 bytes (the 10 length of the hashing block). A key longer than n bits does not add to the security of the function. HMAC optionally allows truncation of the final output e.g. truncation to 128 bits from 160 bits. The HMAC designers' Request for Comments [51] was issued in 1997, one year after the algorithm 15 was first introduced. The designers claimed that the strongest known attack against HMAC is based on the frequency of collisions for the hash function H (see Section 14.10 on page 727), and is totally impractical for minimally reasonable hash functions: As an example, if we consider a hash function like MD5 where the output length is 128 bits, the attacker needs to acquire the correct message authentication tags 20 computed (with the same secret key K) on about 264 known plaintexts. This would require the processing of at least 264 blocks under H, an impossible task in any realistic scenario (for a block length of 64 bytes this would take 250,000 years in a continuous 1 Gbps link, and without changing the secret key K all this time). This attack could become realistic only if serious flaws in the collision behavior of the 25 function H are discovered (e.g. Collisions found after 20 messages). Such a discovery would determine the immediate replacement of function H (the effects of such a failure would be far more severe for the traditional uses of H in the context of digital signatures, public key certificates etc). 30 Of course, if a 160-bit hash function is used, then 264 should be replaced with 280. This should be contrasted with a regular collision attack on cryptographic hash functions where no secret key is involved and 264 off-line parallelizable operations suffice to find collisions. 35 More recently, HMAC protocols with replay prevention components [62] have been defined in order to prevent the capture and replay of any M, HMAC[M] combination within a given time period.
WO 2004/050369 PCTIAU2003/001616 672 Finally, it should be noted that HMAC is in the public domain [50], and incurs no licensing fees. There are no known patents infringed by HMAC. 5.6 RANDOM NUMBERS AND TIME VARYING MESSAGES 5 The use of a random number generator as a one-way function has already been examined. However, random number generator theory is very much intertwined with cryptography, security, and authentication. There are a large number of issues concerned with defining good random number generators. 10 Knuth, in (48] describes what makes a generator good (including statistical tests), and the general problems associated with constructing them. Moreau gives a high level survey of the current state of the field in [60]. One of the uses for random numbers is to ensure that messages vary over time. Consider a system 15 where A encrypts commands and sends them to B. If the encryption algorithm produces the same output for a given input, an attacker could simply record the messages and play them back to fool B. There is no need for the attacker to crack the encryption mechanism other than to know which message to play to B (while pretending to be A). Consequently messages often include a random number and a time stamp to ensure that the message (and hence its encrypted counterpart) varies 20 each time. Random number generators are also often used to generate keys. Although Klapper has recently shown [45] that a family of secure feedback registers for the purposes of building key-streams does exist, he does not give any practical construction. It is therefore best to say at the moment that all 25 generators are insecure for this purpose. For example, the Berlekamp-Massey algorithm [54], is a classic attack on an LFSR random number generator. If the LFSR is of length n, then only 2n bits of the sequence suffice to determine the LFSR, compromising the key generator. If, however, the only role of the random number generator is to make sure that messages vary over 30 time, the security of the generator and seed is not as important as it is for session key generation. If however, the random number seed generator is compromised, and an attacker is able to calculate future "random" numbers, it can leave some protocols open to attack. Any new protocol should be examined with respect to this situation. 35 The actual type of random number generator required will depend upon the implementation and the purposes for which the generator is used. Generators include Blum, Blum, and Shub [10], stream ciphers such as RC4 by Ron Rivest [71], hash functions such as SHA-1 [28] and RIPEMD-160 [66], WO 2004/050369 PCTIAU2003/001616 673 and traditional generators such LFSRs (Linear Feedback Shift Registers) [48] and their more recent counterpart FCSRs (Feedback with Carry Shift Registers) [44]. 5.7 ATTACKS 5 This section describes the various types of attacks that can be undertaken to break an authentication cryptosystem. The attacks are grouped into physical and logical attacks. Logical attacks work on the protocols or algorithms rather than their physical implementation, and attempt to do one of three things: 10 e Bypass the authentication process altogether * Obtain the secret key by force or deduction, so that any question can be answered * Find enough about the nature of the authenticating questions and answers in order to, without the key, give the right answer to each question. 15 Regardless of the algorithms and protocol used by a security chip, the circuitry of the authentication part of the chip can come under physical attack. Physical attacks come in four main ways, although the form of the attack can vary: * Bypassing the security chip altogether * Physical examination of the chip while in operation (destructive and non-destructive) 20 * Physical decomposition of chip * Physical alteration of chip The attack styles and the forms they take are detailed below. 25 This section does not suggest solutions to these attacks. It merely describes each attack type. The examination is restricted to the context of an authentication chip (as opposed to some other kind of system, such as Internet authentication) attached to some System. 5.7.1 Logical attacks 30 These attacks are those which do not depend on the physical implementation of the cryptosystem. They work against the protocols and the security of the algorithms and random number generators. 5.7.1.1 Ciphertext only attack This is where an attacker has one or more encrypted messages, all encrypted using the same 35 algorithm. The aim of the attacker is to obtain the plaintext messages from the encrypted messages. Ideally, the key can be recovered so that all messages in the future can also be recovered.
WO 2004/050369 PCTIAU2003/001616 674 5.7.1.2 Known plaintext attack This is where an attacker has both the plaintext and the encrypted form of the plaintext. In the case of an authentication chip, a known-plaintext attack is one where the attacker can see the data flow 5 between the system and the authentication chip. The inputs and outputs are observed (not chosen by the attacker), and can be analyzed for weaknesses (such as birthday attacks or by a search for differentially interesting input/output pairs). A known plaintext attack can be carried out by connecting a logic analyzer to the connection 10 between the system and the authentication chip. 5.7.1.3 Chosen plaintext attacks A chosen plaintext attack describes one where a cryptanalyst has the ability to send any chosen message to the cryptosystem, and observe the response. If the cryptanalyst knows the algorithm, 15 there may be a relationship between inputs and outputs that can be exploited by feeding a specific output to the input of another function. The chosen plaintext attack is much stronger than the known plaintext attack since the attacker can choose the messages rather than simply observe the data flow. 20 On a system using an embedded authentication chip, it is generally very difficult to prevent chosen plaintext attacks since the cryptanalyst can logically pretend he/she is the system, and thus send any chosen bit-pattern streams to the authentication chip. 25 5.7.1.4 Adaptive chosen plaintext attacks This type of attack is similar to the chosen plaintext attacks except that the attacker has the added ability to modify subsequent chosen plaintexts based upon the results of previous experiments. This is certainly the case with any system / authentication chip scenario described for consumables such as photocopiers and toner cartridges, especially since both systems and consumables are made 30 available to the public. 5.7.1.5 Brute force attack A guaranteed way to break any key-based cryptosystem algorithm is simply to try every key. Eventually the right one will be found. This is known as a brute force attack. However, the more key 35 possibilities there are, the more keys must be tried, and hence the longer it takes (on average) to find the right one. If there are N keys, it will take a maximum of N tries. If the key is N bits long, it will take a maximum of 2N tries, with a 50% chance of finding the key after only half the attempts WO 2004/050369 PCTIAU2003/001616 675 (2m). The longer N becomes, the longer it will take to find the key, and hence the more secure the key is. Of course, an attack may guess the key on the first try, but this is more unlikely the longer the key is. 5 Consider a key length of 56 bits. In the worst case, all 2" tests (7.2 x 1016 tests) must be made to find the key. In 1977, Diffie and Hellman described a specialized machine for cracking DES, consisting of one million processors, each capable of running one million tests per second 117]. Such a machine would take 20 hours to break any DES code. 10 Consider a key length of 128 bits. In the worst case, all 2"' tests (3.4 x 10" tests) must be made to find the key. This would take ten billion years on an array of a trillion processors each running 1 billion tests per second. With a long enough key length, a brute force attack takes too long to be worth the attacker's efforts. 15 5.7.1.6 Guessing attack This type of attack is where an attacker attempts to simply "guess" the key. As an attack it is identical to the brute force attack (see Section 5.7.1.5 on page 674) where the odds of success depend on the length of the key. 20 5.7.1.7 Quantum computer attack To break an n-bit key, a quantum computer [83] (NMR, Optical, or Caged Atom) containing n qubits embedded in an appropriate algorithm must be built. The quantum computer effectively exists in 2" simultaneous coherent states. The trick is to extract the right coherent state without causing any 25 decoherence. To date this has been achieved with a 2 qubit system (which exists in 4 coherent states). It is thought possible to extend this to 6 qubits (with 64 simultaneous coherent states) within a few years. Unfortunately, every additional qubit halves the relative strength of the signal representing the key. 30 This rapidly becomes a serious impediment to key retrieval, especially with the long keys used in cryptographically secure systems. As a result, attacks on a cryptographically secure key (e.g. 160 bits) using a Quantum Computer are likely not to be feasible and it is extremely unlikely that quantum computers will have achieved 35 more than 50 or so qubits within the commercial lifetime of the authentication chips. Even using a 50 qubit quantum computer, 2110 tests are required to crack a 160 bit key.
WO 2004/050369 PCTIAU2003/001616 676 5.7.1.8 Purposeful error attack With certain algorithms, attackers can gather valuable information from the results of a bad input. This can range from the error message text to the time taken for the error to be generated. 5 A simple example is that of a userid/password scheme. If the error message usually says "Bad userid", then when an attacker gets a message saying "Bad password" instead, then they know that the userid is correct. If the message always says "Bad userid/password" then much less information is given to the attacker. A more complex example is that of the recent published method of cracking encryption codes from secure web sites [41]. The attack involves sending particular messages to a 10 server and observing the error message responses. The responses give enough information to learn the keys - even the lack of a response gives some information. An example of algorithmic time can be seen with an algorithm that returns an error as soon as an erroneous bit is detected in the input message. Depending on hardware implementation, it may be 15 a simple method for the attacker to time the response and alter each bit one by one depending on the time taken for the error response, and thus obtain the key. Certainly in a chip implementation the time taken can be observed with far greater accuracy than over the Internet. 5.7.1.9 Birthday attack 20 This attack is named after the famous "birthday paradox" (which is not actually a paradox at all). The odds of one person sharing a birthday with another, is I in 365 (not counting leap years). Therefore there must be 183 people in a room for the odds to be more than 50% that one of them shares your birthday. However, there only needs to be 23 people in a room for there to be more than a 50% chance that any two share a birthday, as shown in the following relation: 25 nPr r 365P23 Prob = 1- - 36P0.507 n 365 Birthday attacks are common attacks against hashing algorithms, especially those algorithms that combine hashing with digital signatures. 30 If a message has been generated and already signed, an attacker must search for a collision message that hashes to the same value (analogous to finding one person who shares your birthday). However, if the attacker can generate the message, the birthday attack comes into play. The attacker searches for two messages that share the same hash value (analogous to any two people sharing a birthday), only one message is acceptable to the person signing it, and the other 35 is beneficial for the attacker. Once the person has signed the original message the attacker simply WO 2004/050369 PCTIAU2003/001616 677 claims now that the person signed the alternative message - mathematically there is no way to tell which message was the original, since they both hash to the same value. Assuming a brute force attack is the only way to determine a match, the weakening of an n-bit key 5 by the birthday attack is 2 ". A key length of 128 bits that is susceptible to the birthday attack has an effective length of only 64 bits. 5.7.1.10 Chaining attack These are attacks made against the chaining nature of hash functions. They focus on the 10 compression function of a hash function. The idea is based on the fact that a hash function generally takes arbitrary length input and produces a constant length output by processing the input n bits at a time. The output from one block is used as the chaining variable set into the next block. Rather than finding a collision against an entire input, the idea is that given an input chaining variable set, to find a substitute block that will result in the same output chaining variables as the 15 proper message. The number of choices for a particular block is based on the length of the block. If the chaining variable is c bits, the hashing function behaves like a random mapping, and the block length is b bits, the number of such b-bit blocks is- approximately 2 b / 2*. The challenge for finding a 20 substitution block is that such blocks are a sparse subset of all possible blocks. For SHA-1, the number of 512 bit blocks is approximately 2512/210, or 2352. The chance of finding a block by brute force search is about I in 216. 25 5.7.1.11 'Substitution with a complete lookup table If the number of potential messages sent to the chip is small, then there is no need for a clone manufacturer to crack the key. Instead, the clone manufacturer could incorporate a ROM in their chip that had a record of all of the responses from a genuine chip to the codes sent by the system. The larger the key, and the larger the response, the more space is required for such a lookup table. 30 5.7.1.12 Substitution with a sparse lookup table If the messages sent to the chip are somehow predictable, rather than effectively random, then the clone manufacturer need not provide a complete lookup table. For example: 35 e If the message is simply a serial number, the clone manufacturer need simply provide a lookup table that contains values for past and predicted future serial numbers. There are unlikely to be more than 109 of these.
WO 2004/050369 PCTIAU2003/001616 678 If the test code is simply the date, then the clone manufacturer can produce a lookup table using the date as the address. * If the test code is a pseudo-random number using either the serial number or the date as a seed, then the clone manufacturer just needs to crack the pseudo-random number generator in the 5 system. This is probably not difficult, as they have access to the object code of the system. The clone manufacturer would then produce a content addressable memory (or other sparse array lookup) using these codes to access stored authentication codes. 5.7.1.13 Differential cryptanalysis 10 Differential cryptanalysis describes an attack where pairs of input streams are generated with known differences, and the differences in the encoded streams are analyzed. Existing differential attacks are heavily dependent on the structure of S boxes, as used in DES and other similar algorithms. Although other algorithms such as HMAC-SHAI have no S boxes, an 15 attacker can undertake a differential-like attack by undertaking statistical analysis of: * Minimal-difference inputs, and their corresponding outputs * Minimal-difference outputs, and their corresponding inputs Most algorithms were strengthened against differential cryptanalysis once the process was 20 described. This is covered in the specific sections devoted to each cryptographic algorithm. However some recent algorithms developed in secret have been broken because the developers had not considered certain styles of differential attacks [94] and did not subject their algorithms to public scrutiny. 25 5.7.1.14 Message substitution attacks In certain protocols, a man-in-the-middle can substitute part or all of a message. This is where a real authentication chip is plugged into a reusable clone chip within the consumable. The clone chip intercepts all messages between the system and the authentication chip, and can perform a number of substitution attacks. 30 Consider a message containing a header followed by content. An attacker may not be able to generate a valid header, but may be able to substitute their own content, especially if the valid response is something along the lines of "Yes, I received your message". Even if the return message is "Yes, I received the following message ... ", the attacker may be able to substitute the 35 original message before sending the acknowledgment back to the original sender. Message Authentication Codes were developed to combat message substitution attacks.
WO 2004/050369 PCTIAU2003/001616 679 5.7.1.15 Reverse engineering the key generator If a pseudo-random number generator is used to generate keys, there is the potential for a clone manufacture to obtain the generator program or to deduce the random seed used. This was the 5 way in which the security layer of the Netscape browser program was initially broken [33]. 5.7.1.16 Bypassing the authentication process It may be that there are problems in the authentication protocols that can allow a bypass of the authentication process altogether. With these kinds of attacks the key is completely irrelevant, and 10 the attacker has no need to recover it or deduce it Consider an example of a system that authenticates at power-up, but does not authenticate at any other time. A reusable consumable with a clone authentication chip may make use of a real authentication chip. The clone authentication chip uses the real chip for the authentication call, and 15 then simulates the real authentication chip's state data after that. Another example of bypassing authentication is if the system authenticates only after the consumable has been used. A clone authentication chip can accomplish a simple authentication bypass by simulating a loss of connection after the use of the consumable but before the 20 authentication protocol has completed (or even started). One infamous attack known as the "Kentucky Fried Chip" hack [2] involved replacing a microcontroller chip for a satellite TV system. When a subscriber stopped paying the subscription fee, the system would send out a "disable" message. However the new micro-controller would 25 simply detect this message and not pass it on to the consumer's satellite TV system. 5.7.1.17 Garrote/bribe attack If people know the key, there is the possibility that they could tell someone else. The telling may be due to coercion (bribe, garrote etc.), revenge (e.g. a disgruntled employee), or simply for principle. 30 These attacks are usually cheaper and easier than other efforts at deducing the key. As an example, a number of people claiming to be involved with the development of the (now defunct) Divx standard for DVD claimed (before the standard was rejected by consumers) that they would like to help develop Divx specific cracking devices - out of principle. 35 5.7.2 Physical attacks The following attacks assume implementation of an authentication mechanism in a silicon chip that the attacker has physical access to. The first attack, Reading ROM, describes an attack when keys WO 2004/050369 PCTIAU2003/001616 680 are stored in ROM, while the remaining attacks assume that a secret key is stored in Flash memory. 5.7.2.1 Reading ROM 5 If a key is stored in ROM it can be read directly. A ROM can thus be safely used to hold a public key (for use in asymmetric cryptography), but not to hold a private key. In symmetric cryptography, a ROM is completely insecure. Using a copyright text (such as a haiku) as the key is not sufficient, because we are assuming that the cloning of the chip is occurring in a country where intellectual property is not respected. 10 5.7.2.2 Reverse engineering of chip Reverse engineering of the chip is where an attacker opens the chip and analyzes the circuitry. Once the circuitry has been analyzed the inner workings of the chip's algorithm can be recovered. Lucent Technologies have developed an active method [4] known as TOBIC (Two photon OBIC, 15 where OBIC stands for Optical Beam Induced Current), to image circuits. Developed primarily for static RAM analysis, the process involves removing any back materials, polishing the back surface to a mirror finish, and then focusing light on the surface. The excitation wavelength is specifically chosen not to induce a current in the IC. 20 A Kerckhoffs in the nineteenth century made a fundamental assumption about cryptanalysis: if the algorithm's inner workings are the sole secret of the scheme, the scheme is as good as broken [39]. He stipulated that the secrecy must reside entirely in the key. As a result, the best way to protect against reverse engineering of the chip is to make the inner workings irrelevant. 25 5.7.2.3 Usurping the authentication process It must be assumed that any clone manufacturer has access to both the system and consumable designs. If the same channel is used for communication between the system and a trusted system 30 authentication chip, and a non-trusted consumable authentication chip, it may be possible for the non-trusted chip to interrogate a trusted authentication chip in order to obtain the "correct answer". If this is so, a clone manufacturer would not have to determine the key. They would only have to trick the system into using the responses from the system authentication chip. 35 The alternative method of usurping the authentication process follows the same method as the logical attack described in Section 5.7.1.16 on page 679, involving simulated loss of contact with the system whenever authentication processes take place, simulating power-down etc.
WO 2004/050369 PCTIAU2003/001616 681 5.7.2.4 Modification of system This kind of attack is where the system itself is modified to accept clone consumables. The attack may be a change of system ROM, a rewiring of the consumable, or, taken to the extreme case, a 5 completely clone system. Note that this kind of attack requires each individual system to be modified, and would most likely require the owner's consent. There would usually have to be a clear advantage for the consumer to undertake such a modification, since it would typically void warranty and would most likely be 10 costly. An example of such a modification with a clear advantage to the consumer is a software patch to change fixed-region DVD players into region-free DVD players (although it should be noted that this is not to use clone consumables, but rather originals from the same companies simply targeted for sale in other countries). 15 5.7.2.5 Direct viewing of chip operation by conventional probing If chip operation could be directly viewed using an STM (Scanning Tunnelling Microscope) or an electron beam, the keys could be recorded as they are read from the internal non-volatile memory and loaded into work registers. 20 These forms of conventional probing require direct access to the top or front sides of the IC while it is powered. 5.7.2.6 Direct viewing of the non-volatile memory If.the chip were sliced so that the floating gates of the Flash memory were exposed, without 25 discharging them, then the key could probably be viewed directly using an STM or SKM (Scanning Kelvin Microscope). However, slicing the chip to this level without discharging the gates is probably impossible. Using wet etching, plasma etching, ion milling (focused ion beam etching), or chemical mechanical 30 polishing will almost certainly discharge the small charges present on the floating gates. 5.7.2.7 Viewing the light bursts caused by state changes Whenever a gate changes state, a small amount of infrared energy is emitted. Since silicon is transparent to infrared, these changes can be observed by looking at the circuitry from the 35 underside of a chip. While the emission process is weak, it is bright enough to be detected by highly sensitive equipment developed for use in astronomy. The technique [92], developed by IBM, is called PICA (Picosecond Imaging Circuit Analyzer). If the state of a register is known at time t, then WO 2004/050369 PCTIAU2003/001616 682 watching that register change over time will reveal the exact value at time t+n, and if the data is part of the key, then that part is compromised. 5.7.2.8 Viewing the keys using an SEPM 5 A non-invasive testing device, known as a Scanning Electric Potential Microscope (SEPM), allows the direct viewing of charges within a chip [37]. The SEPM has a tungsten probe that is placed a few micrometers above the chip, with the probe and circuit forming a capacitor. Any AC signal flowing beneath the probe causes displacement current to flow through this capacitor. Since the value of the current change depends on the amplitude and phase of the AC signal, the signal can 10 be imaged. If the signal is part of the key, then that part is compromised. 5.7.2.9 Monitoring EMI Whenever electronic circuitry operates, faint electromagnetic signals are given off. Relatively inexpensive equipment can monitor these signals and could give enough information to allow an 15 attacker to deduce the keys. 5.7.2.10 Viewing /dd fluctuations Even if keys cannot be viewed, there is a fluctuation in current whenever registers change state. If there is a high enough signal to noise ratio, an attacker can monitor the difference in ldd that may 20 occur when programming over either a high or a low bit. The change in ldd can reveal information about the key. Attacks such as these have already been used to break smart cards [46]. 5.7.2.11 Differential Fault Analysis This attack assumes introduction of a bit error by ionization, microwave radiation, or environmental 25 stress. In most cases such an error is more likely to adversely affect the chip (e.g. cause the program code to crash) rather than cause beneficial changes which would reveal the key. Targeted faults such as ROM overwrite, gate destruction etc. are far more likely to produce useful results. 5.7.2.12 Clock glitch attacks 30 Chips are typically designed to properly operate within a certain clock speed range. Some attackers attempt to introduce faults in logic by running the chip at extremely high clock speeds or introduce a clock glitch at a particular time for a particular duration [1]. The idea is to create race conditions where the circuitry does not function properly. An example could be an AND gate that (because of race conditions) gates through Input 1 all the time instead of the AND of Input 1 and Input 2 . 35 WO 2004/050369 PCTIAU2003/001616 683 If an attacker knows the internal structure of the chip, they can attempt to introduce race conditions at the correct moment in the algorithm execution, thereby revealing information about the key (or in the worst case, the key itself). 5 5.7.2.13 Power supply attacks Instead of creating a glitch in the clock signal, attackers can also produce glitches in the power supply where the power is increased or decreased to be outside the working operating voltage range. The net effect is the same as a clock glitch - introduction of error in the execution of a particular instruction. The idea is to stop the CPU from XORing the key, or from shifting the data 10 one bit-position etc. Specific instructions are targeted so that information about the key is revealed. 5.7.2.14 Overwriting ROM Single bits in a ROM can be overwritten using a laser cutter microscope [1], to either 1 or 0 depending on the sense of the logic. If the ROM contains instructions, it may be a simple matter for 15 an attacker to change a conditional jump to a non-conditional jump, or perhaps change the destination of a register transfer. If the target instruction is chosen carefully, it may result in the key being revealed. 5.7.2.15 Modifying EEPROM/Flash 20 These attacks fall into two categories: * those similar to the ROM attacks except that the laser cutter microscope technique can be used to both set and reset individual bits. This gives much greater scope in terms of modification of algorithms. * Electron beam programming of floating gates. As described in [89] and [32], a focused 25 electron beam can change a gate by depositing electrons onto it. Damage to the rest of the circuit can be avoided, as described in [31]. 5.7.2.16 Gate destruction Anderson and Kuhn described the rump session of the 1997 workshop on Fast Software Encryption 30 [1], where Biham and Shamir presented an attack on DES. The attack was to use a laser cutter to destroy an individual gate in the hardware implementation of a known block cipher (DES). The net effect of the attack was to force a particular bit of a register to be "stuck". Biham and Shamir described the effect of forcing a particular register to be affected in this way - the least significant bit of the output from the round function is set to 0. Comparing the 6 least significant bits of the left half 35 and the right half can recover several bits of the key. Damaging a number of chips in this way can reveal enough information about the key to make complete key recovery easy.
WO 2004/050369 PCTIAU2003/001616 684 An encryption chip modified in this way will have the property that encryption and decryption will no longer be inverses. 5.7.2.17 Overwrite attacks 5 Instead of trying to read the Flash memory, an attacker may simply set a single bit by use of a laser cutter microscope. Although the attacker doesn't know the previous value, they know the new value. If the chip still works, the bit's original state must be the same as the new state. If the chip doesn't work any longer, the bit's original state must be the logical NOT of the current state. An attacker can perform this attack on each bit of the key and obtain the n-bit key using at most n chips 10 (if the new bit matched the old bit, a new chip is not required for determining the next bit). 5.7.2.18 Test circuitry attack Most chips contain test circuitry specifically designed to check for manufacturing defects. This includes BIST (Built In Self Test) and scan paths. Quite often the scan paths and test circuitry 15 includes access and readout mechanisms for all the embedded latches. In some cases the test circuitry could potentially be used to give information about the contents of particular registers. Test circuitry is often disabled once the chip has passed all manufacturing tests, in some cases by blowing a specific connection within the chip. A determined attacker, however, can reconnect the 20 test circuitry and hence enable it. 5.7.2.19 Memory remnants Values remain in RAM long after the power has been removed [351, although they do not remain long enough to be considered non-volatile. An attacker can remove power once sensitive 25 information has been moved into RAM (for example working registers), and then attempt to read the value from RAM. This attack is most useful against security systems that have regular RAM chips. A classic example is cited by [1], where a security system was designed with an automatic power-shut-off that is triggered when the computer case is opened. The attacker was able to simply open the case, remove the RAM chips, and retrieve the key because the values persisted. 30 5.7.2.20 Chip theft attack If there are a number of stages in the lifetime of an authentication chip, each of these stages must be examined in terms of ramifications for security should chips be stolen. For example, if information is programmed into the chip in stages, theft of a chip between stages may allow an 35 attacker to have access to key information or reduced efforts for attack. Similarly, if a chip is stolen directly after manufacture but before programming, does it give an attacker any logical or physical advantage? WO 2004/050369 PCTIAU2003/001616 685 5.7.2.21 Trojan horse attack At some stage the authentication chips must be programmed with a secret key. Suppose an attacker builds a clone authentication chip and adds it to the pile of chips to be programmed. The attacker has especially built the clone chip so that it looks and behaves just like a real 5 authentication chip, but will give the key out to the attacker when a special attacker-known command is issued to the chip. Of course the attacker must have access to the chip after the programming has taken place, as well as physical access to add the Trojan horse authentication chip to the genuine chips. 10 6 Requirements Existing solutions to the problem of authenticating consumables have typically relied on patents covering physical packaging. However this does not stop home refill operations or clone manufacture in countries with weak industrial property protection. Consequently a much higher level of protection is required. 15 The authentication mechanism is therefore built into an authentication chip that is embedded in the consumable and allows a system to authenticate that consumable securely and easily. Limiting ourselves to the system authenticating consumables (we don't consider the consumable authenticating the system), two levels of protection can be considered: 20 Presence Only Authentication: This is where only the presence of an authentication chip is tested. The authentication chip can be removed and used in other consumables as long as be used indefinitely. 25 Consumable Lifetime Authentication: This is where not only is the presence of the authentication chip tested for, but also the authentication chip must only last the lifetime of the consumable. For the chip to be re used it must be completely erased and reprogrammed. 30 The two levels of protection address different requirements. We are primarily concerned with Consumable Lifetime authentication in order to prevent cloned versions of high volume consumables. In this case, each chip should hold secure state information about the consumable being authenticated. It should be noted that a Consumable Lifetime authentication chip could be used in any situation requiring a Presence Only authentication chip. 35 Requirements for authentication, data storage integrity and manufacture are considered separately. The following sections summarize requirements of each.
WO 2004/050369 PCTIAU2003/001616 686 6.1 AUTHENTICATION The authentication requirements for both Presence Only and Consumable Lifetime authentication are restricted to the case of a system authenticating a consumable. We do not consider bi 5 directional authentication where the consumable also authenticates the system. For example, it is not necessary for a valid toner cartridge to ensure it is being used in a valid photocopier. For Presence Only authentication, we must be assured that an authentication chip is physically present. For Consumable Lifetime authentication we also need to be assured that state data 10 actually came from the authentication chip, and that it has not been altered en route. These issues cannot be separated - data that has been altered has a new source, and if the source cannot be determined, the question of alteration cannot be settled. It is not enough to provide an authentication method that is secret, relying on a home-brew security 15 method that has not been scrutinized by security experts. The primary requirement therefore is to provide authentication by means that have withstood the scrutiny of experts. The authentication scheme used by the authentication chip should be resistant to defeat by logical means. Logical types of attack are extensive, and attempt to do one of three things: 20 * Bypass the authentication process altogether * Obtain the secret key by force or deduction, so that any question can be answered * Find enough about the nature of the authenticating questions and answers in order to, without the key, give the right answer to each question. 25 The logical attack styles and the forms they take are detailed in Section 5.7.1 on page 673. The algorithm should have a flat keyspace, allowing any random bit string of the required length to be a possible key. There should be no weak keys. 30 6.2 DATA STORAGE INTEGRITY Although authentication protocols take care of ensuring data integrity in communicated messages, data storage integrity is also required. Two kinds of data must be stored within the authentication chip: * Authentication data, such as secret keys 35 e Consumable state data, such as serial numbers, and media remaining etc.
WO 2004/050369 PCTIAU2003/001616 687 The access requirements of these two data types differ greatly. The authentication chip therefore requires a storage/access control mechanism that allows for the integrity requirements of each type. 5 6.2.1 Authentication data Authentication data must remain confidential. It needs to be stored in the chip during a manufacturing/programming stage of the chip's life, but from then on must not be permitted to leave the chip. It must be resistant to being read from non-volatile memory. The authentication scheme is responsible for ensuring the key cannot be obtained by deduction, and the manufacturing process 10 is responsible for ensuring that the key cannot be obtained by physical means. The size of the authentication data memory area must be large enough to hold the necessary keys and secret information as mandated by the authentication protocols. 15 6.2.2 Consumable state data Consumable state data can be divided into the following types. Depending on the application, there will be different numbers of each of these types of data items. * Read Only * ReadWrite 20 * Decrement Only Read Only data needs to be stored in the chip during a manufacturing/programming stage of the chip's life, but from then on should not be allowed to change. Examples of Read Only data items are consumable batch numbers and serial numbers. 25 ReadWrite data is changeable state information, for example, the last time the particular consumable was used. ReadWrite data items can be read and written an unlimited number of times during the lifetime of the consumable. They can be used to store any state information about the consumable. The only requirement for this data is that it needs to be kept in non volatile memory. Since an attacker can obtain access to a system (which can write to 30 ReadWrite data), any attacker can potentially change data fields of this type. This data type should not be used for secret information, and must be considered insecure. Decrement Only data is used to count down the availability of consumable resources. A photocopier's toner cartridge, for example, may store the amount of toner remaining as a Decrement Only data item. An ink cartridge for a color printer may store the amount of each 35 ink color as a Decrement Only data item, requiring 3 (one for each of Cyan, Magenta, and Yellow), or even as many as 5 or 6 Decrement Only data items. The requirement for this kind of data item is that once programmed with an initial value at the manufacturing/programming WO 2004/050369 PCTIAU2003/001616 688 stage, it can only reduce in value. Once it reaches the minimum value, it cannot decrement any further. The Decrement Only data item is only required by Consumable Lifetime authentication. 5 Note that the size of the consumable state data storage required is only for that information required to be authenticated. Information which would be of no use to an attacker, such as ink color-curve characteristics or ink viscosity do not have to be stored in the secure state data memory area of the authentication chip. 10 6.3 MANUFACTURE The authentication chip must have a low manufacturing cost in order to be included as the authentication mechanism for low cost consumables. The authentication chip should use a standard manufacturing process, such as Flash. This is 15 necessary to: * Allow a great range of manufacturing location options * Use well-defined and well-behaved technology e Reduce cost 20 Regardless of the authentication scheme used, the circuitry of the authentication part of the chip must be resistant to physical attack. Physical attack comes in four main ways, although the form of the attack can vary: * Bypassing the authentication chip altogether * Physical examination of chip while in operation (destructive and non-destructive) 25 * Physical decomposition of chip e Physical alteration of chip The physical attack styles and the forms they take are detailed in Section 5.7.2 on page 679. Ideally, the chip should be exportable from the USA, so it should not be possible to use an 30 authentication chip as a secure encryption device. This is low priority requirement since there are many companies in other countries able to manufacture the authentication chips. In any case, the export restrictions from the USA may change. AUTHENTICATION 35 7 Introduction Existing solutions to the problem of authenticating consumables have typically relied on physical patents on packaging. However this does not stop home refill operations or clone manufacture in WO 2004/050369 PCTIAU2003/001616 689 countries with weak industrial property protection. Consequently a much higher level of protection is required. It is not enough to provide an authentication method that is secret, relying on a home-brew security 5 method that has not been scrutinized by security experts. Security systems such as Netscape's original proprietary system and the GSM Fraud Prevention Network used by cellular phones are examples where design secrecy caused the vulnerability of the security [33][33]. Both security systems were broken by conventional means that would have been detected if the companies had followed an open design process. The solution is to provide authentication by means that have 10 withstood the scrutiny of experts. In this section, we examine a number of protocols that can be used for consumables authentication. We only use security methods that are publicly described, using known behaviors in this new way. Readers should be familiar with the concepts and terms described in Section 5 on page 656. We 15 avoid the Zero Knowledge Proof protocol since it is patented. For all protocols, the security of the scheme relies on a secret key, not a secret algorithm. In the nineteenth century, A Kerckhoffs made a fundamental assumption about cryptanalysis: if the algorithm's inner workings are the sole secret of the scheme, the scheme is as good as broken [39]. 20 He stipulated that the secrecy must reside entirely in the key. As a result, the best way to protect against reverse engineering of any authentication chip is to make the algorithmic inner workings irrelevant (the algorithm of the inner workings must still be must be valid, but not the actual secret). The QA Chip is a programmable device, and can therefore be setup with an application-specific 25 program together with an application-specific set of protocols. This section describes the following sets of protocols: * single key single memory vector * multiple key single memory vector * multiple key multiple memory vector 30 These protocols refer to the number of valid keys that an QA Chip knows about, and the size of data required to be stored in the chip. From these protocols it is straightforward to construct protocol sets for the single key multiple 35 memory vector case (of course the multiple memory vector can be considered to be . and multiple key single memory vector. Other protocol sets can also be defined as necessary. Of course multiple memory vector can be conveniently WO 2004/050369 PCTIAU2003/001616 690 All the protocols rely on a time-variant challenge (i.e. the challenge is different each time), where the response depends on the challenge and the secret. The challenge involves a random number so that any observer will not be able to gather useful information about a subsequent identification. 5 8 Single Key Single Memory Vector 8.1 PROTOCOL BACKGROUND This protocol set is provided for two reasons: 1 the other protocol sets defined in this document are simply extensions of this one; and 10 e it is useful in its own right The single key protocol set is useful for applications where only a single key is required. Note that there can be many consumables and systems, but there is only a single key that connects them all. Examples include: 15 e car and keys. A car and the car-key share a single key. There can be multiple sets of car keys, each effectively cut to the same key. A company could have a set of cars, each with the same key. Any of the car-keys could then be used to drive any of the cars. * printer and ink cartridge. All printers of a certain model use the same ink cartridge, with printer and cartridge sharing only a single key. Note that to introduce a new printer model 20 that accepts the old ink cartridge the new model would need the same key as the old model. See the multiple-key protocols for alternative solutions to this problem. 8.2 REQUIREMENTS OF PROTOCOL Each QA Chip contains the following values: 25 K The secret key for calculating FK[X]. K must not be stored directly in the QA Chip. Instead, each chip needs to store a random number RK (different for each chip), KGRK, and -,KeRx. The stored KGRK can be XORed with RK to obtain the real K. Although ,K@RK must be stored to protect against differential attacks, it is not used. 30 R Current random number used to ensure time varying messages. Each chip instance must be seeded with a different initial value. Changes for each signature generation. M Memory vector of QA Chip. P 2 element array of access permissions for each part of M. Entry 0 holds access 35 permissions for non-authenticated writes to M (no key required). Entry I holds access permissions for authenticated writes to M (key required). Permission choices for each part of M are Read Only, Read/Write, and Decrement Only.
WO 2004/050369 PCTIAU2003/001616 691 C 3 constants used for generating signatures. C 1 , C 2 , and C3 are constants that pad out a submessage to a hashing boundary, and all 3 must be different. Each QA Chip contains the following private function: SK[X] Internal function only. Returns SK[X], the result of applying a digital signature 5 function S to X based upon key K. The digital signature must be long enough to counter the chances of someone generating a random signature. The length depends on the signature scheme chosen, although the scheme chosen for the QA Chip is HMAC-SHA1 (see Section 13 on page 718), and therefore the length of the signature is 160 bits. 10 Additional functions are required in certain QA Chips, but these are described as required. 8.3 READS OF M In this case, we have a trusted chip (ChipT) connected to a System. The System wants to 15 authenticate an object that contains a non-trusted chip (ChipA). In effect, the System wants to know that it can securely read a memory vector (M) from ChipA: to be sure that ChipA is valid and that M has not been altered. The protocol requires the following publicly available function in ChipA: Read[X] Advances R, and returns R, M, SK[XIR|C1|M]. The time taken to calculate the 20 signature must not be based on the contents of X, R, M, or K. The protocol requires the following publicly available functions in ChipT: Random[] Returns R (does not advance R). Test[X, Y, Z] Advances R and returns 1 if SK[RIX|C1|Y] = Z. Otherwise returns 0. The time 25 taken to calculate and compare signatures must be independent of data content. To authenticate ChipA and read ChipA's memory M: a. System calls ChipT's Random function; b. ChipT returns RT to System; 30 c. System calls ChipA's Read function, passing in the result from b; d. ChipA updates RA, then calculates and returns RA, MA, SK[RTIRAIC1|MA]; e. System calls ChipT's Test function, passing in RA, MA, SK[RTIRAICi IMA]; f. System checks response from ChipT. If the response is 1, then ChipA is considered authentic. If 0, ChipA is considered invalid. 35 The data flow for read authentication is shown in Figure 334.
WO 2004/050369 PCTIAU2003/001616 692 The protocol allows System to simply pass data from one chip to another, with no special processing. The protection relies on ChipT being trusted, even though System does not know K. When ChipT is physically separate from System (eg is chip on a board connected to System) 5 System must also occassionally (based on system clock for example) call ChipT's Test function with bad data, expecting a 0 response. This is to prevent someone from inserting a fake ChipT into the system that always returns 1 for the Test function. 8.4 WRITES 10 In this case, the System wants to update M in some chip referred to as ChipU. This can be non authenticated (for example, anyone is allowed to count down the amount of consumable remaining), or authenticated (for example, replenishing the amount of consumable remaining). 8.4.1 Non-authenticated writes 15 This is the most frequent type of write, and takes place between the System / consumable during normal everyday operation. In this kind of write, System wants to change M in a way that doesn't require special authorization. For example, the System could be decrementing the amount of consumable remaining. Although System does not need to know K or even have access to a trusted chip, System must follow a non-authenticated write by an authenticated read if it needs to 20 know that the write was successful. The protocol requires the following publicly available function: Write[X] Writes X over those parts of M subject to P 0 and the existing value for M. 25 To authenticate a write of M,, to ChipA's memory M: a. System calls ChipU's Write function, passing in Mnew; b. The authentication procedure for a Read is carried out (see Section 8.3 on page 691); c. If ChipU is authentic and Me, = M returned in b, the write succeeded. If not, it failed. 30 8.4.2 Authenticated writes In this kind of write, System wants to change Chip U's M in an authorized way, without being subject to the permissions that apply during normal operation (Po). For example, the consumable may be at a refilling station and the normally Decrement Only section of M should be updated to include the new valid consumable. In this case, the chip whose M is being updated must 35 authenticate the writes being generated by the external System and in addition, apply permissions
P
1 to ensure that only the correct parts of M are updated.
WO 2004/050369 PCTIAU2003/001616 693 In this transaction protocol, the System's chip is referred to as ChipS, and the chip being updated is referred to as ChipU. Each chip distrusts the other. The protocol requires the following publicly available functions in ChipU: Read[X] Advances R, and returns R, M, SK[XIRIC1|M]. The time taken to calculate the 5 signature must be identical for all inputs. WriteA[X, Y, Z]Returns 1, advances R, and replaces M by Y subject to P 1 only if SK[RIXC1 IY] = Z. Otherwise returns 0. The time taken to calculate and compare signatures must be independent of data content. This function is identical to ChipT's Test function except that it additionally writes Y over those 10 parts of M subject to P 1 when the signature matches. Authenticated writes require that the System has access to a ChipS that is capable of generating appropriate signatures. ChipS requires the following variables and function: CountRemaining Part of M that contains the number of signatures that ChipS is allowed to 15 generate. Decrements with each successful call to SignM and SignP. Permissions in ChipS's Po for this part of M needs to be ReadOnly once ChipS has been setup. Therefore CountRemaining can only be updated by another ChipS that will perform updates to that part of M (assuming ChipS's P 1 allows that part of M to be updated), 20 Q Part of M that contains the write permissions for updating ChipU's M. By adding Q to ChipS we allow different ChipSs that can update different parts of Mu. Permissions in ChipS's P 0 for this part of M needs to be ReadOnly once ChipS has been setup. Therefore Q can only be updated by another ChipS that will perform updates to that part of M. 25 SignM[V,W,X,Y,Z] Advances R, decrements CountRemaining and returns R, Zax (Z applied to X with permissions Q), followed by SK[WIRIC1|Zax] only if SK[VlWICl|X] = Y and CountRemaining > 0. Otherwise returns all Os. The time taken to calculate and compare signatures must be independent of data content. 30 To update ChipU's M vector: a. System calls ChipU's Read function, passing in 0 as the input parameter; b. ChipU produces Ru, Mu, SK[OIRuICIMu] and returns these to System; c. System calls ChipS's SignM function, passing in 0 (as used in a), Ru, Mu, SK[ORuiClIMu], and MD (the desired vector to be written to ChipU); 35 d. ChipS produces Rs, MQD (processed by running MD against Mu using Q) and SK[RuIRslClIMaDI if the inputs were valid, and 0 for all outputs if the inputs were not valid.
WO 2004/050369 PCTIAU2003/001616 694 e. If values returned in d are non zero, then ChipU is considered authentic. System can then call ChipU's WriteA function with these values. f. ChipU should return a I to indicate success. A 0 should only be returned if the data generated by ChipS is incorrect (e.g. a transmission error). 5 The data flow for authenticated writes is shown in Figure 335. Note that Q in ChipS is part of ChipS's M. This allows a user to set up ChipS with a permission set for upgrades. This should be done to ChipS and that part of M designated by P 0 set to ReadOnly before ChipS is programmed with Ku. If Ks is programmed with Ku first, there is a risk of someone 10 obtaining a half-setup ChipS and changing all of Mu instead of only the sections specified by Q. The same is true of CountRemaining. The CountRemaining value needs to be setup (including making it ReadOnly in PO) before ChipS is programmed with Ku. ChipS is therefore programmed to only perform a limited number of SignM operations (thereby limiting compromise exposure if a 15 ChipS is stolen). Thus ChipS would itself need to be upgraded with a new CountRemaining every so often. 8.4.3 Updating permissions for future writes In order to reduce exposure to accidental and malicious attacks on P and certain parts of M, only 20 authorized users are allowed to update P. Writes to P are the same as authorized writes to M, except that they update Pn instead of M. Initially (at manufacture), P is set to be Read/Write for all parts of M. As different processes fill up different parts of M, they can be sealed against future change by updating the permissions. Updating a chip's P 0 changes permissions for unauthorized writes, and updating P 1 changes permissions for authorized writes. 25 Pn is only allowed to change to be a more restrictive form of itself. For example, initially all parts of M have permissions of Read/Write. A permission of Read/Write can be updated to Decrement Only or Read Only. A permission of Decrement Only can be updated to become Read Only. A Read Only permission cannot be further restricted. 30 In this transaction protocol, the System's chip is referred to as ChipS, and the chip being updated is referred to as ChipU. Each chip distrusts the other. The protocol requires the following publicly available functions in ChipU: 35 Random[] Returns R (does not advance R). SetPermission[nX,Y,Z] Advances R, and updates Pn according to Y and returns 1 followed by the resultant Pn only if SK[RIXIYlC 2 ] = Z. Otherwise returns 0. P, can only WO 2004/050369 PCTIAU2003/001616 695 become more restricted. Passing in 0 for any permission leaves it unchanged (passing in Y=0 returns the current P,). Authenticated writes of permissions require that the System has access to a ChipS that is capable 5 of generating appropriate signatures. ChipS requires the following variables and function: CountRemaining Part of M that contains the number of signatures that ChipS is allowed to generate. Decrements with each successful call to SignM and SignP. Permissions in ChipS's P 0 for this part of M needs to be ReadOnly once ChipS has been setup. Therefore CountRemaining can only be updated by 10 another ChipS that will perform updates to that part of M (assuming ChipS's
P
1 allows that part of M to be updated). SignP[X,Y] Advances R, decrements CountRemaining and returns R and SK[XIRIYIC 2 ] only if CountRemaining > 0. Otherwise returns all Os. The time taken to calculate and compare signatures must be independent of data content. 15 To update ChipU's Po: a. System calls ChipU's Random function; b. ChipU returns Ru to System; c. System calls ChipS's SignP function, passing in Ru and PD (the desired P to be written to 20 ChipU); d. ChipS produces Rs and SK[RuIRsIPDIC 2 ] if it is still permitted to produce signatures. e. If values returned in d are non zero, then System can then call ChipU's SetPermission function with the desired n, Rs, PD and SK[RUIRs|PDC2]. f. ChipU verifies the received signature against SK[RuIRsIPDIC 2 ] and applies PD to P, if the 25 signature matches g. System checks 1st output parameter. I = success, 0 = failure. The data flow for authenticated writes to permissions is shown in Figure 336 below. 8.5 PROGRAMMING K 30 In this case, we have a factory chip (ChipF) connected to a System. The System wants to program the key in another chip (ChipP). System wants to avoid passing the new key to ChipP in the clear, and also wants to avoid the possibility of the key-upgrade message being replayed on another ChipP (even if the user doesn't know the key). The protocol assumes that ChipF and ChipP already share a secret key Kod. This key is used to 35 ensure that only a chip that knows KId can set Knew. The protocol requires the following publicly available functions in ChipP: Random[ Returns R (does not advance R).
WO 2004/050369 PCTIAU2003/001616 696 ReplaceKey[X, Y, Z] Replaces K by SKod[RIX|C3]eY, advances R, and returns 1 only if SKoId[XIYIC 3 ] = Z. Otherwise returns 0. The time taken to calculate signatures and compare values must be identical for all inputs. And the following data and function in ChipF: 5 CountRemaining Part of M with contains the number of signatures that ChipF is allowed to generate. Decrements with each successful call to GetProgramKey. Permissions in P for this part of M needs to be ReadOnly once ChipF has been setup. Therefore can only be updated by a ChipS that has authority to perform updates to that part 10 of M. Knew The new key to be transferred from ChipF to ChipP. Must not be visible. SetPartialKey[X,Y] If word X of Knew has not yet been set, set word X of Knew to Y and return 1. Otherwise return 0. This function allows Knew to be pro 15 grammed in multiple steps, thereby allowing different people or systems to know different parts of the key (but not the whole Knew). Kn, is stored in ChipF's flash memory. Since there is a small number of ChipFs, it is theoretically not necessary to store the inverse of Knew, but it is stronger protection to do so. 20 GetProgramKey[X] Advances RF, decrements CountRemaining, outputs RF, the encrypted key SKoId[XIRFIC 3 ]6Knew and a signature of the first two outputs plus C3 if CountRemaining>0. Otherwise outputs 0. The time to calculate the encrypted key & signature must be identical for all inputs. 25 To update P's key: a. System calls ChipP's Random function; b. ChipP returns Re to System; c. System calls ChipF's GetProgramKey function, passing in the result from b; d. ChipF updates RF, then calculates and returns RF, SKold[RPIRFC 3 ]9Knew, and 30 SKold{RFISKold[RpIRFIC3]oKnew1C3]; e. If the response from d is not 0, System calls ChipP's ReplaceKey function, passing in the response from d; f. System checks response from ChipP. If the response is 1, then Kp has been correctly updated to Knew. If the response is 0, K, has not been updated. 35 The data flow for key updates is shown in Figure 337.
WO 2004/050369 PCTIAU2003/001616 697 Note that Knew is never passed in the open. An attacker could send its own Rp, but cannot produce SKold[RpIRFIC3] without Kold. The third parameter, a signature, is sent to ensure that ChipP can determine if either of the first two parameters have been changed en route. 5 CountRemaining needs to be setup in MF (including making it ReadOnly in P) before ChipF is programmed with Kp. ChipF should therefore be programmed to only perform a limited number of GetProgramKey operations (thereby limiting compromise exposure if a ChipF is stolen). An authorized ChipS can be used to update this counter if neccesary (see Section 8.4 on page 692). 10 8.5.1 Chicken and Egg Of course, for the Program Key protocol to work, both ChipF and ChipP must both know KoId. Obviously both chips had to be programmed with Kold, and thus Kod can be thought of as an older Knew: Kord can be placed in chips if another ChipF knows Kolder, and so on. 15 Although this process allows a chain of reprogramming of keys, with each stage secure, at some stage the very first key (Kfrt) must be placed in the chips. Karst is in fact programmed with the chip's microcode at the manufacturing test station as the last step in manufacturing test. Kflrt can be a manufacturing batch key, changed for each batch or for each customer etc, and can have as short a life as desired. Compromising Kfrt need not result in a complete compromise of the chain of Ks. 20 9 Multiple Key Single Memory Vector 9.1 PROTOCOL BACKGROUND This protocol set is an extension to the single key single memory vector protocol set, and is provided for two reasons: 25 . the multiple key multiple memory vector protocol set defined in this document is simply extensions of this one; and * it is useful in its own right The multiple key protocol set is typically useful for applications where there are multiple types of systems and consumables, and they need to work with each other in various ways. This is typically 30 in the following situations: * when different systems want to share some consumables, but not others. For example printer models may share some ink cartridges and not share others. * when there are different owners of data in M. Part of the memory vector may be owned by one company (eg the speed of the printer) and another may be owned by another (eg the 35 serial number of the chip). In this case a given key K, needs to be able to write to a given part of M, and other keys K, need to be disallowed from writing to these same areas. 9.2 REQUIREMENTS OF PROTOCOL WO 2004/050369 PCTIAU2003/001616 698 Each QA Chip contains the following values: N The maximum number of keys known to the chip. KN Array of N secret keys used for calculating FKn[X] where Kn is the nth element of the array. Each Kn must not be stored directly in the QA Chip . Instead, each chip needs to 5 store a single random number RK (different for each chip), Kn@RK, and -,Kn@RK. The stored Kn®RK can be XORed with RK to obtain the real K. Although ,KnERK must be stored to protect against differential attacks, it is not used. R Current random number used to ensure time varying messages. Each chip instance must be seeded with a different initial value. Changes for each signature generation. 10 M Memory vector of QA Chip. A fixed part of M contains N in ReadOnly form so users of the chip can know the number of keys known by the chip. P N+1 element array of access permissions for each part of M. Entry 0 holds access permissions for non-authenticated writes to M (no key required). Entries 1 to N+1 hold access permissions for authenticated writes to M, one for each K. Permission choices 15 for each part of M are Read Only, Read/Write, and Decrement Only. C 3 constants used for generating signatures. C 1 , C 2 , and C 3 are constants that pad out a submessage to a hashing boundary, and all 3 must be different. Each QA Chip contains the following private function: 20 SKn[N,X] Internal function only. Returns SKn[X], the result of applying a digital signature function S to X based upon the appropriate key Kn. The digital signature must be long enough to counter the chances of someone generating a random signature. The length depends on the signature scheme chosen, although the scheme chosen for the QA Chip is HMAC-SHA1 (see Section 13 on page 718), and therefore the length of the signature is 25 160 bits. Additional functions are required in certain QA Chips, but these are described as required. 9.3 READS As with the single key scenario, we have a trusted chip (ChipT) connected to a System. The 30 System wants to authenticate an object that contains a non-trusted chip (ChipA). In effect, the System wants to know that it can securely read a memory vector (M) from ChipA: to be sure that ChipA is valid and that M has not been altered. The protocol requires the following publicly available functions: Random[] Returns R (does not advance R). 35 Read[n, X] Advances R, and returns R, M, SKn[XRIC1IMI]. The time taken to calculate the signature must not be based on the contents of X, R, M, or K.
WO 2004/050369 PCTIAU2003/001616 699 Test[n,X, Y, Z] Advances R and returns 1 if SKn[R|XICjY] = Z. Otherwise returns 0. The time taken to calculate and compare signatures must be independent of data content. To authenticate ChipA and read ChipA's memory M: 5 a. System calls ChipT's Random function; b. ChipT returns RT to System; c. System calls ChipA's Read function, passing in some key number n1 and the result from b; d. ChipA updates RA, then calculates and returns RA, MA, SKAnI[RrTIRAIC1|MA]; e. System calls ChipT's Test function, passing in n2, RA, MA, SKAn1[RTIRAC1 IMA; 10 f. System checks response from ChipT. If the response is 1, then ChipA is considered authentic. If 0, ChipA is considered invalid. The choice of n1 and n2 must be such that ChipA's Kn 1 = ChipT's Kn 2 . 15 The data flow for read authentication is shown in Figure 338. The protocol allows System to simply pass data from one chip to another, with no special processing. The protection relies on ChipT being trusted, even though System does not know K. 20 When ChipT is physically separate from System (eg is chip on a board connected to System) System must also occasionally (based on system clock for example) call ChipT's Test function with bad data, expecting a 0 response. This is to prevent someone from inserting a fake ChipT into the system that always returns 1 for the Test function. 25 It is important that n1 is chosen by System. Otherwise ChipA would need to return NA sets of signatures for each read, since ChipA does not know which of the keys will satisfy ChipT. Similarly, system must also choose n2, so it can potentially restrict the number of keys in ChipT that are matched against (otherwise ChipT would have to match against all its keys). This is important in order to restrict how different keys are used. For example, say that ChipT contains 6 keys, keys 0-2 30 are for various printer-related upgrades, and keys 3-6 are for inks. ChipA contains say 4 keys, one key for each printer model. At power-up, System goes through each of chipA's keys 0-3, trying each out against ChipT's keys 3-6. System doesn't try to match against ChipT's keys 0-2. Otherwise knowledge of a speed-upgrade key could be used to provide ink QA Chip chips. This matching needs to be done only once (eg at power up). Once matching keys are found, System can continue 35 to use those key numbers.
WO 2004/050369 PCTIAU2003/001616 700 Since System needs to know NT and NA, part of M is used to hold N (eg in Read Only form), and the system can obtain it by calling the Read function, passing in key 0. 9.4 WRITES 5 As with the single key scenario, the System wants to update M in ChipU. As before, this can be done in a non-authenticated and authenticated way. 9.4.1 Non-authenticated writes This is the most frequent type of write, and takes place between the System / consumable during 10 normal everyday operation. In this kind of write, System wants to change M subject to P. For example, the System could be decrementing the amount of consumable remaining. Although System does not need to know any of the Ks or even have access to a trusted chip to perform the write, System must follow a non-authenticated write by an authenticated read if it needs to know that the write was successful. 15 The protocol requires the following publicly available function: Write[X] Writes X over those parts of M subject to P 0 and the existing value for M. To authenticate a write of Mne, to ChipA's memory M: a. System calls ChipU's Write function, passing in Mnew; 20 b. The authentication procedure for a Read is carried out (see Section 9.3 on page 698); c. If ChipU is authentic and Mne = M returned in b, the write succeeded. If not, it failed. 9.4.2 Authenticated writes In this kind of write, System wants to change Chip U's M in an authorized way, without being 25 subject to the permissions that apply during normal operation (Po). For example, the consumable may be at a refilling station and the normally Decrement Only section of M should be updated to include the new valid consumable. In this case, the chip whose M is being updated must authenticate the writes being generated by the external System and in addition, apply the appropriate permission for the key to ensure that only the correct parts of M are updated. Having a 30 different permission for each key is required as when multiple keys are involved, all keys should not necessarily be given open access to M. For example, suppose M contains printer speed and a counter of money available for franking. A ChipS that updates printer speed should not be capable of updating the amount of money. Since P 0 is used for non-authenticated writes, each K" has a corresponding permission P,,, that determines what can be updated in an authenticated write. 35 In this transaction protocol, the System's chip is referred to as ChipS, and the chip being updated is referred to as ChipU. Each chip distrusts the other.
WO 2004/050369 PCT/AU2003/001616 701 The protocol requires the following publicly available functions in ChipU: Read[n, X] Advances R, and returns R, M, SKn[XIRIC1|M]. The time taken to calculate the signature must not be based on the contents of X, R, M, or K. WriteA[n, X, Y, Z] Advances R, replaces M by Y subject to P,, 1 , and returns 1 only if 5 SKn[RIXIC1 Y] = Z. Otherwise returns 0. The time taken to calculate and compare signatures must be independent of data content. This function is identical to ChipT's Test function except that it additionally writes Y subject to Pn,1 to its M when the signature matches. Authenticated writes require that the System has access to a ChipS that is capable of gen 10 erating appropriate signatures. ChipS requires the following variables and function: CountRemaining Part of M that contains the number of signatures that ChipS is allowed to generate. Decrements with each successful call to SignM and SignP. Permissions in ChipS's P 0 for this part of M needs to be ReadOnly once ChipS has been setup. Therefore CountRemaining can only be updated by 15 another ChipS that will perform updates to that part of M (assuming ChipS's P allows that part of M to be updated). Q Part of M that contains the write permissions for updating ChipU's M. By adding Q to ChipS we allow different ChipSs that can update different parts of Mu. Permissions in ChipS's P 0 for this part of M needs to be ReadOnly 20 once ChipS has been setup. Therefore Q can only be updated by another ChipS that will perform updates to that part of M. SignM[n,V,W,X,Y,Z] Advances R, decrements CountRemaining and returns R, Zox (Z applied to X with permissions Q), SKn[WIRIC1|Zax] only if Y= SKn[VIWIC1IX] and CountRemaining > 0. Otherwise returns all Os. The time taken to calculate 25 and compare signatures must be independent of data content. To update ChipU's M vector: a. System calls ChipU's Read function, passing in n1 and 0 as the input parameters; b. ChipU produces Ru, Mu, SKn1[0RuIC1Mu] and returns these to System; 30 c. System calls ChipS's SignM function, passing in n2 (the key to be used in ChipS), 0 (as used in a), Ru, Mu, SKn1[0[RuJC1|Mu], and MD (the desired vector to be written to ChipU); d. ChipS produces Rs, MQD (processed by running MD against Mu using Q) and SKn 2 [RuIRsIC1|MQD if the inputs were valid, and 0 for all outputs if the inputs were not valid. e. If values returned in d are non zero, then ChipU is considered authentic. System can then call 35 ChipU's WriteA function with these values from d. f. ChipU should return a 1 to indicate success. A 0 should only be returned if the data generated by ChipS is incorrect (e.g. a transmission error).
WO 2004/050369 PCT/AU2003/001616 702 The choice of n1 and n2 must be such that ChipU's K, 1 = ChipS's K, 2 . The data flow for authenticated writes is shown in Figure 339 below. 5 Note that Q in ChipS is part of ChipS's M. This allows a user to set up ChipS with a permission set for upgrades. This should be done to ChipS and that part of M designated by P 0 set to ReadOnly before ChipS is programmed with Ku. If Ks is programmed with Ku first, there is a risk of someone obtaining a half-setup ChipS and changing all of Mu instead of only the sections specified by Q. 10 In addition, CountRemaining in ChipS needs to be setup (including making it ReadOnly in Ps) before ChipS is programmed with Ku. ChipS should therefore be programmed to only perform a limited number of SignM operations (thereby limiting compromise exposure if a ChipS is stolen). Thus ChipS would itself need to be upgraded with a new CountRemaining every so often. 15 9.4.3 Updating permissions for future writes In order to reduce exposure to accidental and malicious attacks on P (and certain parts of M), only authorized users are allowed to update P. Writes to P are the same as authorized writes to M, except that they update P, instead of M. Initially (at manufacture), P is set to be Read/Write for all parts of M. As different processes fill up different parts of M, they can be sealed against future 20 change by updating the permissions. Updating a chip's P 0 changes permissions for unauthorized writes, and updating Pn+ 1 changes permissions for authorized writes with key Kn. Pn is only allowed to change to be a more restrictive form of itself. For example, initially all parts of M have permissions of Read/Write. A permission of Read/Write can be updated to Decrement Only 25 or Read Only. A permission of Decrement Only can be updated to become Read Only. A Read Only permission cannot be further restricted. In this transaction protocol, the System's chip is referred to as ChipS, and the chip being updated is referred to as ChipU. Each chip distrusts the other. 30 The protocol requires the following publicly available functions in ChipU: Random[] Returns R (does not advance R). SetPermission[n,p,X,Y,Z] Advances R, and updates P, according to Y and returns I followed by the resultant Pp only if SKn[RIXIYIC 2 ] = Z. Otherwise returns 0. P, can only become more restricted. Passing in 0 for any permission leaves it unchanged (passing in 35 Y=0 returns the current PP).
WO 2004/050369 PCT/AU2003/001616 703 Authenticated writes of permissions require that the System has access to a ChipS that is capable of generating appropriate signatures. ChipS requires the following variables and function: CountRemaining Part of M that contains the number of signatures that ChipS is allowed to generate. Decrements with each successful call to SignM and SignP. 5 Permissions in ChipS's P 0 for this part of M needs to be ReadOnly once ChipS has been setup. Therefore CountRemaining can only be updated by another ChipS that will perform updates to that part of M (assuming ChipS's Pn allows that part of M to be updated). SignP[n,X,Y] Advances R, decrements CountRemaining and returns R and SKn[XIRIYIC2] 10 only if CountRemaining > 0. Otherwise returns all Os. The time taken to calculate and compare signatures must be independent of data content. To update ChipU's P,: a. System calls ChipU's Random function; 15 b. ChipU returns Ru to System; c. System calls ChipS's SignP function, passing in ni, Ru and PD (the desired P to be written to ChipU); d. ChipS produces Rs and SKn1[RulRs|PDC 2 ] if it is still permitted to produce signatures. e. If values returned in d are non zero, then System can then call ChipU's SetPermission function 20 with n2, the desired permission entry p, Rs, PD and SKn1[RuIRsPDC 2 I. f. ChipU verifies the received signature against SKn2[RuIRsIPDIC2] and applies PD to Pn if the signature matches g. System checks 1st output parameter. I = success, 0 = failure. 25 The choice of n1 and n2 must be such that ChipU's Kn 1 = ChipS's Kn2 The data flow for authenticated writes to permissions is shown in Figure 340 below. 9.4.4 Protecting M in a multiple key system 30 To protect the appropriate part of M, the SetPermission function must be called after the part of M has been set to the desired value. For example, if adding a serial number to an area of M that is currently ReadWrite so that noone is permitted to update the number again: 35 a the Write function is called to write the serial number to M * SetPermission is called for n = {1, ... , N} to set that part of M to be ReadOnly for authorized writes using key n-1.
WO 2004/050369 PCT/AU2003/001616 704 * SetPermission is called for 0 to set that part of M to be ReadOnly for non-authorized writes For example, adding a consumable value to M such that only keys 1-2 can update it, and keys 0, and 3-N cannot: 5 a the Write function is called to write the amount of consumable to M " SetPermission is called for n = {1, 4, 5, ..., N-1} to set that part of M to be ReadOnly for authorized writes using key n-1. This leaves keys 1 and 2 with ReadWrite permissions. " SetPermission is called for 0 to set that part of M to be DecrementOnly for non-authorized writes. This allows the amount of consumable to decrement. 10 It is possible for someone who knows a key to further restrict other keys, but it is not in anyone's interest to do so. 9.5 PROGRAMMING K 15 In this case, we have a factory chip (ChipF) connected to a System. The System wants to program the key in another chip (ChipP). System wants to avoid passing the new key to ChipP in the clear, and also wants to avoid the possibility of the key-upgrade message being replayed on another ChipP (even if the user doesn't know the key). 20 The protocol is a simple extension of the single key protocol in that it assumes that ChipF and ChipP already share a secret key Kold. This key is used to ensure that only a chip that knows Kdd can set Kn. The protocol requires the following publicly available functions in ChipP: 25 Random[] Returns R (does not advance R). ReplaceKey[n, X, Y, Z] Replaces Kn by SKn[R|XIC 3 ]eY, advances R, and returns I only if Sn{XIYIC 3 ] = Z. Otherwise returns 0. The time taken to calculate sig natures and compare values must be identical for all inputs. 30 And the following data and functions in ChipF: CountRemaining Part of M with contains the number of signatures that ChipF is allowed to generate. Decrements with each successful call to GetProgramKey. Permissions in P for this part of M needs to be ReadOnly once ChipF has been setup. Therefore can only be updated by a ChipS that has 35 authority to perform updates to that part of M. Know The new key to be transferred from ChipF to ChipP. Must not be visible.
WO 2004/050369 PCT/AU2003/001616 705 SetPartiaKey[X,Y] If word X of Knew has not yet been set, set word X of Knew to Y and return 1. Otherwise return 0. This function allows Knev to be programmed in multiple steps, thereby allowing different people or systems to know different parts of the key (but not the whole K,,,). Knew is stored in 5 ChipF's flash memory. Since there is a small number of ChipFs, it is theoretically not necessary to store the inverse of K,,,, but it is stronger protection to do so. GetProgramKey[n, X] Advances RF, decrements CountRemaining, outputs RF, the encrypted key SKn[XIRFIC3]eKneW and a signature of the first two outputs plus C 3 if 10 CountRemaining>0. Otherwise outputs 0. The time to calculate the encrypted key & signature must be identical for all inputs. To update P's key: a. System calls ChipP's Random function; 15 b. ChipP returns Rp to System; c. System calls ChipF's GetProgramKey function, passing in n1 (the desired key to use) and the result from b; d. ChipF updates RF, then calculates and returns RF, SKn1[Rp|RFjC 3 ]@Knew, and SKn1 [RF SKn1[RpIRFIC3]OKeIC 3 ; 20 e. If the response from d is not 0, System calls ChipP's ReplaceKey function, passing in n2 (the key to use in ChipP) and the response from d; f. System checks response from ChipP. If the response is 1, then Ken 2 has been correctly updated to Knew. If the response is 0, Ken 2 has not been updated. 25 The choice of n1 and n2 must be such that ChipF's Kn 1 = ChipP's Kn 2 . The data flow for key updates is shown in Figure 341 below. Note that Kne is never passed in the open. An attacker could send its own Rp, but cannot produce 30 SKn1[RpIRFIC3] without Kn 1 .The signature based on K,,, is sent to ensure that ChipP will be able to determine if either of the first two parameters have been changed en route. CountRemaining needs to be setup in MF (including making it ReadOnly in P) before ChipF is programmed with Kp. ChipF should therefore be programmed to only perform a limited number of GetProgramKey operations (thereby limiting compromise exposure if a ChipF is stolen). An 35 authorized ChipS can be used to update this counter if neccesary (see Section 9.4 on page 700). 9.5.1 Chicken and Egg WO 2004/050369 PCT/AU2003/001616 706 As with the single key protocol, for the Program Key protocol to work, both ChipF and ChipP must both know Kold. Obviously both chips had to be programmed with Kid, and thus Koid can be thought of as an older Knew: Kid can be placed in chips if another ChipF knows Koider, and so on. 5 Although this process allows a chain of reprogramming of keys, with each stage secure, at some stage the very first key (Kflrst) must be placed in the chips. Kirsi is in fact programmed with the chip's microcode at the manufacturing test station as the last step in manufacturing test. Kfest can be a manufacturing batch key, changed for each batch or for each customer etc, and can have as short a life as desired. Compromising Km 1 need not result in a complete compromise of the chain of Ks. 10 Depending on the reprogramming requirements, Kfri can be the same or different for all K. 10 Multiple Keys Multiple Memory Vectors 10.1 PROTOCOL BACKGROUND 15 This protocol set is a slight restriction of the multiple key single memory vector protocol set, and is the expected protocol. It is a restriction in that M has been optimized for Flash memory utilization. M is broken into multiple memory vectors (semi-fixed and variable components) for the purposes of optimizing flash memory utilization. Typically M contains some parts that are fixed at some stage of 20 the manufacturing process (eg a batch number, serial number etc), and once set, are not ever updated. This information does not contain the amount of consumable remaining, and therefore is not read or written to with any great frequency. We therefore define Mo to be the M that contains the frequently updated sections, and the 25 remaining Ms to be rarely written to. Authenticated writes only write to M 0 , and non-authenticated writes can be directed to a specific Mn. This reduces the size of permissions that are stored in the QA Chip (since key-based writes are not required for Ms other than Mo). It also means that Mo and the remaining Ms can be manipulated in different ways, thereby increasing flash memory longevity. 30 10.2 REQUIREMENTS OF PROTOCOL Each QA Chip contains the following values: N The maximum number of keys known to the chip. T The number of vectors M is broken into. KN Array of N secret keys used for calculating FKn[X] where K, is the nth element of the array. 35 Each K, must not be stored directly in the QA Chip . Instead, each chip needs to store a single random number RK (different for each chip), K,@RK, and -,KEoRK. The stored KnERK can be WO 2004/050369 PCT/AU2003/001616 707 XORed with RK to obtain the real K. Although KnERK must be stored to protect against differential attacks, it is not used. R Current random number used to ensure time varying messages. Each chip instance must be seeded with a different initial value. Changes for each signature generation. 5 MT Array of T memory vectors. Only Mo can be written to with an authorized write, while all Ms can be written to in an unauthorized write. Writes to Mo are optimized for Flash usage, while updates to any other M, are expensive with regards to Flash utilization, and are expected to be only performed once per section of Mn. M 1 contains T and N in ReadOnly form so users of the chip can know these two values. 10 PTN T+N element array of access permissions for each part of M. Entries n={0... T-1} hold access permissions for non-authenticated writes to Mn (no key required). Entries n={T to T+N-1}hold access permissions for authenticated writes to Mo for Kn. Permission choices for each part of M are Read Only, Read/Write, and Decrement Only. C 3 constants used for generating signatures. C 1 , C 2 , and C 3 are constants that pad out a 15 submessage to a hashing boundary, and all 3 must be different. Each QA Chip contains the following private function: SKn[N,X] Internal function only. Returns SKn[X], the result of applying a digital signature function S to X based upon the appropriate key Kn. The digital signature must be 20 long enough to counter the chances of someone generating a random signature. The length depends on the signature scheme chosen, although the scheme chosen for the QA Chip is HMAC-SHAI, and therefore the length of the signature is 160 bits. 25 Additional functions are required in certain QA Chips, but these are described as required. 10.3 READS As with the previous scenarios, we have a trusted chip (ChipT) connected to a System. The System wants to authenticate an object that contains a non-trusted chip (ChipA). In effect, the System 30 wants to know that it can securely read a memory vector (Mt) from ChipA: to be sure that ChipA is valid and that M has not been altered. The protocol requires the following publicly available functions: Random[] Returns R (does not advance R). Read[n, t, X] Advances R, and returns R, Mt, SKn[XIRICIM]. The time taken to calculate the 35 signature must not be based on the contents of X, R, Mt, or K. If t is invalid, the function assumes t=0.
WO 2004/050369 PCT/AU2003/001616 708 Test[n,X, Y, Z] Advances R and returns 1 if SK,[RIXICI JY] = Z. Otherwise returns 0. The time taken to calculate and compare signatures must be independent of data content. 5 To authenticate ChipA and read ChipA's memory M: a. System calls ChipT's Random function; b. ChipT returns R-r to System; c. System calls ChipA's Read function, passing in some key number n1, the desired M number t, and the result from b; 10 d. ChipA updates RA, then calculates and returns RA, MAt, SKAn1[RT|RAIC11MAt; e. System calls ChipT's Test function, passing in n2, RA, MAt, SKAn1[[RTIRAIC1IMAd; f. System checks response from ChipT. If the response is 1, then ChipA is considered authentic. If 0, ChipA is considered invalid. 15 The choice of n1 and n2 must be such that ChipA's Kn 1 = ChipT's Kn 2 . The data flow for read authentication is shown in Figure 342 below. The protocol allows System to simply pass data from one chip to another, with no special 20 processing. The protection relies on ChipT being trusted, even though System does not know K. When ChipT is physically separate from System (eg is chip on a board connected to System) System must also occassionally (based on system clock for example) call ChipT's Test function with bad data, expecting a 0 response. This is to prevent someone from inserting a fake ChipT into 25 the system that always returns 1 for the Test function. It is important that n1 is chosen by System. Otherwise ChipA would need to return NA sets of signatures for each read, since ChipA does not know which of the keys will satisfy ChipT. Similarly, system must also choose n2, so it can potentially restrict the number of keys in ChipT that are 30 matched against (otherwise ChipT would have to match against all its keys). This is important in order to restrict how different keys are used. For example, say that ChipT contains 6 keys, keys 0-2 are for various printer-related upgrades, and keys 3-6 are for inks. ChipA contains say 4 keys, one key for each printer model. At power-up, System goes through each of chipA's keys 0-3, trying each out against ChipT's keys 3-6. System doesn't try to match against ChipT's keys 0-2. Otherwise 35 knowledge of a speed-upgrade key could be used to provide ink QA Chip chips. This matching needs to be done only once (eg at power up). Once matching keys are found, System can continue to use those key numbers.
WO 2004/050369 PCT/AU2003/001616 709 Since System needs to know Nr, NA, and TA, part of M 1 is used to hold N (eg in Read Only form), and the system can obtain it by calling the Read function, passing in key 0 and t=1. 10.4 WRITES 5 As with the previous scenarios, the System wants to update Mt in ChipU. As before, this can be done in a non-authenticated and authenticated way. 10.4.1 Non-authenticated writes This is the most frequent type of write, and takes place between the System / consumable during 10 normal everyday operation for Mo, and during the manufacturing process for Mt. In this kind of write, System wants to change M subject to P. For example, the System could be decrementing the amount of consumable remaining. Although System does not need to know and of the Ks or even have access to a trusted chip to perform the write, System must follow a non 15 authenticated write by an authenticated read if it needs to know that the write was successful. The protocol requires the following publicly available function: Write[t, X] Writes X over those parts of Mt subject to Pt and the existing value for M. 20 To authenticate a write of Mnew to ChipA's memory M: a. System calls ChipU's Write function, passing in Mnew; b. The authentication procedure for a Read is carried out (see Section 9.3 on page 698); c. If ChipU is authentic and Mnew = M returned in b, the write succeeded. If not, it failed. 25 10.4.2 Authenticated writes In the multiple memory vectors protocol, only Mo can be written to an an authenticated way. This is because only Mo is considered to have components that need to be upgraded. 30 In this kind of write, System wants to change Chip U's Mo in an authorized way, without being subject to the permissions that apply during normal operation. For example, the consumable may be at a refilling station and the normally Decrement Only section of Mo should be updated to include the new valid consumable. In this case, the chip whose Mo is being updated must authenticate the writes being generated by the external System and in addition, apply the appropriate permission for 35 the key to ensure that only the correct parts of Mo are updated. Having a different permission for each key is required as when multiple keys are involved, all keys should not necessarily be given open access to Mo. For example, suppose Mo contains printer speed and a counter of money WO 2004/050369 PCT/AU2003/001616 710 available for franking. A ChipS that updates printer speed should not be capable of updating the amount of money. Since Po..T1 is used for non-authenticated writes, each K, has a corresponding permission PT+n that determines what can be updated in an authenticated write. 5 In this transaction protocol, the System's chip is referred to as ChipS, and the chip being updated is referred to as ChipU. Each chip distrusts the other. The protocol requires the following publicly available functions in ChipU: Read[n, t, X] Advances R, and returns R, Mt, SKn[X|RIC1JM]. The time taken to cal 10 culate the signature must not be based on the contents of X, R, Mt, or K. WriteA[n, X, Y, ZI Advances R, replaces Mo by Y subject to PT1n, and returns 1 only if SKn[RIXICiIY] = Z. Otherwise returns 0. The time taken to calculate and compare signatures must be independent of data content. This 15 function is identical to ChipT's Test function except that it additionally writes Y subject to PT+n to its M when the signature matches. Authenticated writes require that the System has access to a ChipS that is capable of generating appropriate signatures. ChipS requires the following variables and function: 20 CountRemaining Part of M that contains the number of signatures that ChipS is allowed to generate. Decrements with each successful call to SignM and SignP. Permissions in ChipS's Po..T.1 for this part of M needs to be ReadOnly once ChipS has been setup. Therefore CountRemaining can only be updated by another ChipS that will 25 perform updates to that part of M (assuming ChipS's P allows that part of M to be updated). Q Part of M that contains the write permissions for updating ChipU's M. By adding Q to ChipS we allow different ChipSs that can update different parts of Mu. Permissions in ChipS's Po..T-1 for this part of M 30 needs to be ReadOnly once ChipS has been setup. Therefore Q can only be updated by another ChipS that will perform updates to that part of M. SignM[nVWXYZ] Advances R, decrements CountRemaining and returns R, Zox (Z applied to X with permissions Q), SKn[WIRICl Zax] only if Y = 35 SKn[V|W|C1IX] and CountRemaining > 0. Otherwise returns all Os. The time taken to calculate and compare signatures must be independent of data content.
WO 2004/050369 PCT/AU2003/001616 711 To update ChipU's M vector: a. System calls ChipU's Read function, passing in n1, 0 and 0 as the input parameters; b. ChipU produces Ru, Muo, SKn1[0RuC1!Muo] and returns these to System; 5 c. System calls ChipS's SignM function, passing in n2 (the key to be used in ChipS), 0 (as used in a), Ru, Muo, SKn1[0|RulC1|Muo], and MD (the desired vector to be written to ChipU); d. ChipS produces Rs, MQD (processed by running MD against Muo using 0) and SKn2[RuIRsICI|MQD] if the inputs were valid, and 0 for all outputs if the inputs were not valid. e. If values returned in d are non zero, then ChipU is considered authentic. System can then call 10 ChipU's WriteA function with these values from d. f. ChipU should return a 1 to indicate success. A 0 should only be returned if the data generated by ChipS is incorrect (e.g. a transmission error). The choice of n1 and n2 must be such that ChipU's K, 1 = ChipS's K, 2 . 15 The data flow for authenticated writes is shown in Figure 343 below. Note that Q in ChipS is part of ChipS's M. This allows a user to set up ChipS with a permission set for upgrades. This should be done to ChipS and that part of M designated by Po..T1 set to ReadOnly 20 before ChipS is programmed with Ku. If Ks is programmed with Ku first, there is a risk of someone obtaining a half-setup ChipS and changing all of Mu instead of only the sections specified by Q. In addition, CountRemaining in ChipS needs to be setup (including making it ReadOnly in Ps) before ChipS is programmed with Ku. ChipS should therefore be programmed to only perform a 25 limited number of SignM operations (thereby limiting compromise exposure if a ChipS is stolen). Thus ChipS would itself need to be upgraded with a new CountRemaining every so often. 10.4.3 Updating permissions for future writes In order to reduce exposure to accidental and malicious attacks on P (and certain parts of M), only 30 authorized users are allowed to update P. Writes to P are the same as authorized writes to M, except that they update Po instead of M. Initially (at manufacture), P is set to be Read/Write for all M. As different processes fill up different parts of M, they can be sealed against future change by updating the permissions. Updating a chip's PoMT changes permissions for unauthorized writes to Mn, and updating PT..T+N-1 changes permissions for authorized writes with key Kn. 35 P, is only allowed to change to be a more restrictive form of itself. For example, initially all parts of M have permissions of Read/Write. A permission of Read/Write can be updated to Decrement Only WO 2004/050369 PCT/AU2003/001616 712 or Read Only. A permission of Decrement Only can be updated to become Read Only. A Read Only permission cannot be further restricted. In this transaction protocol, the System's chip is referred to as ChipS, and the chip being updated is 5 referred to as ChipU. Each chip distrusts the other. The protocol requires the following publicly available functions in ChipU: Random[] Returns R (does not advance R). SetPermission[n,p,X,Y,Z] Advances R, and updates Pp according to Y and returns I followed by 10 the resultant Pp only if SKn[RIXIYIC 2 ] = Z. Otherwise returns 0. Pp can only become more restricted. Passing in 0 for any permission leaves it unchanged (passing in Y=0 returns the current PP). Authenticated writes of permissions require that the System has access to a ChipS that is capable of generating appropriate signatures. ChipS requires the following variables and function: 15 CountRemaining Part of ChipS's Mo that contains the number of signatures that ChipS is allowed to generate. Decrements with each successful call to SignM and SignP. Permissions in ChipS's Po..-rj for this part of Mo needs to be ReadOnly once ChipS has been setup. Therefore 20 CountRemaining can only be updated by another ChipS that will perform updates to that part of Mo (assuming ChipS's Pn allows that part of Mo to be updated). SignP[n,X,Y} Advances R, decrements CountRemaining and returns R and SKn[XIRIYIC 2 ] only if CountRemaining > 0. Otherwise returns all Os. 25 The time taken to calculate and compare signatures must be independent of data content. To update ChipU's Pn: a. System calls ChipU's Random function; 30 b. ChipU returns Ru to System; c. System calls ChipS's SignP function, passing in n1, Ru and PD (the desired P to be written to ChipU); d. ChipS produces Rs and SKn[RujRs1PDIC 2 ] if it is still permitted to produce signatures. e. If values returned in d are non zero, then System can then call ChipU's SetPermission function 35 with n2, the desired permission entry p, Rs, PD and SKn,1Ru|Rs|PDIC 2 f. ChipU verifies the received signature against SKn 2 [RUjRSIPDIC 2 ] and applies PD to P, if the signature matches WO 2004/050369 PCT/AU2003/001616 713 g. System checks 1st output parameter. 1 = success, 0 = failure. The choice of n1 and n2 must be such that ChipU's K, 1 = ChipS's Kn2 5 The data flow for authenticated writes to permissions is shown in Figure 344 below. 10.4.4 Protecting M in a multiple key multiple M system To protect the appropriate part of M, against unauthorized writes, call SetPermissions[n] for n = 0 to T-1. To protect the appropriate part of Mo against authorized writes with key n, call 10 SetPermissions[T+n] for n=0 to N-1. Note that only Mo can be written in an authenticated fashion. Note that the SetPermission function must be called after the part of M has been set to the desired 15 value. For example, if adding a serial number to an area of M 1 that is currently ReadWrite so that noone is permitted to update the number again: * the Write function is called to write the serial number to M 1 20 * SetPermission(1) is called for to set that part of M to be ReadOnly for non-authorized writes. If adding a consumable value to Mo such that only keys 1-2 can update it, and keys 0, and 3-N cannot: * the Write function is called to write the amount of consumable to M 25 * SetPermission is called for 0 to set that part of Mo to be DecrementOnly for non-authorized writes. This allows the amount of consumable to decrement. * SetPermission is called for n = {T, T+3, T+4 ... , T+N-1} to set that part of Mo to be ReadOnly for authorized writes using all but keys 1 and 2. This leaves keys 1 and 2 with ReadWrite permissions to Mo. 30 It is possible for someone who knows a key to further restrict other keys, but it is not in anyone's interest to do so. 10.5 PROGRAMMING K 35 This section is identical to the multiple key single memory vector ( Section 9.5 on page 704). It is repeated here with mention to Mo instead of M for CountRemaining.
WO 2004/050369 PCT/AU2003/001616 714 In this case, we have a factory chip (ChipF) connected to a System. The System wants to program the key in another chip (ChipP). System wants to avoid passing the new key to ChipP in the clear, and also wants to avoid the possibility of the key-upgrade message being replayed on another ChipP (even if the user doesn't know the key). 5 The protocol is a simple extension of the single key protocol in that it assumes that ChipF and ChipP already share a secret key Kold. This key is used to ensure that only a chip that knows K 0 Id can set Knew. 10 The protocol requires the following publicly available functions in ChipP: Random[] Returns R (does not advance R). ReplaceKey[n, X, Y, Z] Replaces Kn by SKn[RIXIC3]Y, advances R, and returns 1 only if SKn[XIYIC3] = Z. Otherwise returns 0. The time taken to calculate signatures and compare values must be identical for all inputs. 15 And the following data and functions in ChipF: CountRemaining Part of Mo with contains the number of signatures that ChipF is allowed to generate. Decrements with each successful call to GetProgramKey. Permission in P for this part of Mt needs to be ReadOnly once ChipF has been setup. Therefore can only be 20 updated by a ChipS that has authority to perform updates to that part of Mo. Knew The new key to be transferred from ChipF to ChipP. Must not be visible. SetPartialKey[XY] If word X of Knew has not yet been set, set word X of Knew to Y and 25 return 1. Otherwise return 0. This function allows Knew to be pro grammed in multiple steps, thereby allowing different people or systems to know different parts of the key (but not the whole Knew). Knew is stored in ChipF's flash memory. Since there is a small number of ChipFs, it is theoretically not necessary to store the 30 inverse of Knew, but it is stronger protection to do so. GetProgramKey[n, X] Advances RF, decrements CountRemaining, outputs RF, the encrypted key SKn[XIRFIC3]oKnew and a signature of the first two outputs plus C 3 if CountRemaining>0. Otherwise outputs 0. The time to calculate the encrypted key & signature must be identical 35 for all inputs. To update P's key: WO 2004/050369 PCT/AU2003/001616 715 a. System calls ChipP's Random function; b. ChipP returns Rp to System; c. System calls ChipF's GetProgramKey function, passing in n1 (the desired key to use) and the result from b; 5 d. ChipF updates RF, then calculates and returns RF, SKn1[RpIRFIC3] Knew, and SKn1[RFISKn1 [Rp|RFjC3]@Kn.WIC 3 ]; e. If the response from d is not 0, System calls ChipP's ReplaceKey function, passing in n2 (the key to use in ChipP) and the response from d; f. System checks response from ChipP. If the response is 1, then Ken 2 has been correctly updated 10 to Knew. If the response is 0, Ken 2 has not been updated. The choice of n1 and n2 must be such that ChipF's Kn 1 = ChipP's Kn 2 . The data flow for key updates is shown in Figure 345below. Note that Knew is never passed in the open. An attacker could send its own Rp, but cannot produce SKn1[RPRFIC3] without Kn 1 .The signature based on Knew is sent to ensure that ChipP will be able to 15 determine if either of the first two parameters have been changed en route. CountRemaining needs to be setup in MFO (including making it ReadOnly in P) before ChipF is programmed with Kr. ChipF should therefore be programmed to only perform a limited number of GetProgramKey operations (thereby limiting compromise exposure if a ChipF is stolen). An authorized ChipS can be used to update this counter if neccesary (see Section 9.4 on page 700). 20 10.5.1 Chicken and Egg As with the single key protocol, for the Program Key protocol to work, both ChipF and ChipP must both know Koid. Obviously both chips had to be programmed with Kjdd, and thus Kold can be thought of as an older Knew: KoId can be placed in chips if another ChipF knows Kolder, and so on. 25 Although this process allows a chain of reprogramming of keys, with each stage secure, at some stage the very first key (Kfit) must be placed in the chips. Karst is in fact programmed with the chip's microcode at the manufacturing test station as the last step in manufacturing test. Kfirs can be a manufacturing batch key, changed for each batch or for each customer etc, and can have as short 30 a life as desired. Compromising Kflrst need not result in a complete compromise of the chain of Ks. Depending on reprogramming requirements, Kfrsi can be the same or different for all K. 10.5.2 Security Note Different ChipFs should have different RF values to prevent K,,w from being determined as follows: 35 The attacker needs 2 ChipFs, both with the same RF and Kn but different values for K,,w. By knowing Knew1 the attacker can determine Knew2. The size of RF is 2160, and assuming a lifespan of approximately 232 Rs, an attacker needs about 260 ChipFs with the same K, to locate the correct WO 2004/050369 PCT/AU2003/001616 716 chip. Given that there are likely to be only hundreds of ChipFs with the same Ka, this is not a likely attack. The attack can be eliminated completely by making C3 different per chip and transmitting it with the new signature. 5 11 Summary of functions for all protocols All protocol sets, whether single key, multiple key, single M or multiple M, all rely on the same set of functions. The function set is listed here: 11.1 ALL CHIPS 10 Since every chip must act as ChipP, ChipA and potentially ChipU, all chips require the following functions: * Random * ReplaceKey * Read 15 e Write * WriteA e SetPermissions 11.2 CHIPT 20 Chips that are to be used as ChipT also require: * Test 11.3 CHIPS Chips that are to be used as ChipS also require either or both of: 25 * SignM e SignP 11.4 CHIPF Chips that are to be used as ChipF also require: 30 - SetPartialKey * GetProgramKey 12 Remote Upgrades 12.1 BASIC REMOTE UPGRADES 35 Regardless of the number of keys and the number of memory vectors, the use of authenticated reads and writes, and of replacing a new key without revealing Knew or KoId allows the possibility of WO 2004/050369 PCT/AU2003/001616 717 remote upgrades of ChipU and ChipP. The upgrade typically involves a remote server and follows two basic steps: a. During the first stage of the upgrade, the remote system authenticates the user's system to ensure the user's system has the setup that it claims to have. 5 b. During the second stage of the upgrade, the user's system authenticates the remote system to ensure that the upgrade is from a trusted source. 12.1.1 User requests upgrade The user requests that he wants to upgrade. This can be done by running a specific upgrade 10 application on the user's computer, or by visiting a specific website. 12.1.2 Remote system gathers info securely about user's current setup In this step, the remote system determines the current setup for the user. The current setup must be authenticated, to ensure that the user truly has the setup that is claimed. Traditionally, this has 15 been by checking the existence of files, generating checksums from those files, or by getting a serial number from a hardware dongle, although these traditional methods have difficulties since they can be generated locally by "hacked" software. The authenticated read protocol described in Section 8.3 on page 691 can be used to accomplish 20 this step. The use of random numbers has the advantage that the local user cannot capture a successful transaction and play it back on another computer system to fool the remote system. 12.1.3 Remote system gives user choice of upgrade possibilities & user chooses If there is more than one upgrade possibility, the various upgrade options are now presented to the 25 user. The upgrade options could vary based on a number of factors, including, but not limited to: e current user setup * user's preference for payment schemes (e.g. single payment vs. multiple payment) e number of other products owned by user 30 The user selects an appropriate upgrade and pays if necessary (by some scheme such as via a secure web site). What is important to note here is that the user chooses a specific upgrade and commences the upgrade operation. 12.1.4 Remote system sends upgrade request to local system 35 The remote system now instructs the local system to perform the upgrade. However, the local system can only accept an upgrade from the remote system if the remote system is also WO 2004/050369 PCT/AU2003/001616 718 authenticated. This is effectively an authenticated write. The use of Ru in the signature prevents the upgrade message from being replayed on another ChipU. If multiple keys are used, and each chip has a unique key, the remote system can use a serial 5 number obtained from the current setup (authenticated by a common key) to lookup the unique key for use in the upgrade. Although the random number provides time varying messages, use of an unknown K that is different for each chip means that collection and examination of messages and their signatures is made even more difficult. 10 12.2 OEM UPGRADES OEM upgrades are effectively the same as remote upgrades, except that the user interacts with an OEM server for upgrade selection. The OEM server may send sub-requests to the manufacturer's remote server to provide authentication, upgrade availability lists, and base-level pricing information. 15 An additional level of authentication may be incorporated into the protocol to ensure that upgrade requests are coming from the OEM server, and not from a 3rd party. This can readily be incorporated into both authentication steps. 20 13 Choice of Signature Function Given that all protocols make use of keyed signature functions, the choice of function is examined here. Table 232 outlines the attributes of the applicable choices (see Section 5.2 on page 656 and 25 Section 5.5 on page 663 for more information). The attributes are phrased so that the attribute is seen as an advantage. Table 232. Attributes of Applicable Signature Functions Triple Blowfis RC5 IDEA Rando HMAC- HMAC- HMAC DES h m MD5 SHA1 RIPEM Seque D160 nces Free of patents . . . . . . Random key generation . . . Can be exported from the . . .
USA
WO 2004/050369 PCT/AU2003/001616 719 Fast . . . Preferred Key Size (bits)168 128 128 128 512 128 160 160 for use in this application Block size (bits) 64 64 64 64 256 512 512 512 Cryptanalysis Attack-Free . (apart from weak keys) Output size given input2N 2N N N 128 128 160 160 size N Low storage requirements . . . Low silicon complexity . . . . NSA designed . An examination of Table 232 shows that the choice is effectively between the 3 HMAC constructs and the Random Sequence. The problem of key size and key generation eliminates the Random Sequence. Given that a number of attacks have already been carried out on MD5 and since the 5 hash result is only 128 bits, HMAC-MD5 is also eliminated. The choice is therefore between HMAC SHA1 and HMAC-RIPEMD160. Of these, SHA-1 is the preferred function, since: e SHA-1 has been more extensively cryptanalyzed without being broken; . SHA-1 requires slightly less intermediate storage than RIPE-MD-1 60; * SHA-1 is algorithmically less complex than RIPE-MD-160; 10 Although SHA-1 is slightly faster than RIPE-MD-1 60, this was not a reason for choosing SHA-1. 13.1 HMAC-SHA1 The mechanism for authentication is the HMAC-SHA1 algorithm. This section examines the HMAC SHA1 algorithm in greater detail than covered so far, and describes an optimization of the algorithm 15 that requires fewer memory resources than the original definition. 13.1.1 HMAC Given the following definitions: e H = the hash function (e.g. MD5 or SHA-1) 20 . n = number of bits output from H (e.g. 160 for SHA-1, 128 bits for MD5) e M = the data to which the MAC function is to be applied e K = the secret key shared by the two parties e ipad = 0x36 repeated 64 times Only gives protection equivalent to 112-bit DES WO 2004/050369 PCT/AU2003/001616 720 e opad = Ox5C repeated 64 times The HMAC algorithm is as follows: a. Extend K to 64 bytes by appending OxO bytes to the end of K 5 b. XOR the 64 byte string created in (1) with ipad c. append data stream M to the 64 byte string created in (2) d. Apply H to the stream generated in (3) e. XOR the 64 byte string created in (1) with opad f. Append the H result from (4) to the 64 byte string resulting from (5) 10 g. Apply H to the output of (6) and output the result Thus: HMAC[M] = H[(K ( opad) I H[(K D ipad) I M]] The HMAC-SHAI algorithm is simply HMAC with H = SHA-1. 15 13.1.2 SHA-1 The SHA1 hashing algorithm is described in the context of other hashing algorithms in Section 5.5.3.3 on page 667, and completely defined in [28]. The algorithm is summarized here. Nine 32-bit constants are defined in Table 233. There are 5 constants used to initialize the chaining 20 variables, and there are 4 additive constants. Table 233. Constants used in SHA-1 Initial Chaining Values Additive Constants h 1 ox67452301 y, ox5A827999 h 2 OxEFCDAB89 Y2 0x6ED9EBA1 h 3 Ox98BADCFE y3 Ox8F1BBCDC h 4 0x10325476 y 4 OxCA62C1D6 h 5 0xC3D2E1FO Non-optimized SHA-1 requires a total of 2912 bits of data storage: 25 * Five 32-bit chaining variables are defined: H 1 , H 2 , H 3 , H 4 and H 5 . * Five 32-bit working variables are defined: A, B, C, D, and E. * One 32-bit temporary variable is defined: t. o Eighty 32-bit temporary registers are defined: XO 0
..
WO 2004/050369 PCT/AU2003/001616 721 The following functions are defined for SHA-1: Table 234. Functions used in SHA-1 Symbolic Nomenclature Description + Addition modulo 232 X x Y Result of rotating X left through Y bit positions f(X, Y, Z) (X A Y) V (,X A Z) g(X, Y, Z) (XAY)V (XAZ)V(YAZ) h(X, Y, Z) X e Y E Z 5 The hashing algorithm consists of firstly padding the input message to be a multiple of 512 bits and initializing the chaining variables H 1
.
5 with h 1
.
5 .The padded message is then processed in 512-bit chunks, with the output hash value being the final 160-bit value given by the concatenation of the chaining variables: H 1 I H 2 J H 3 I H 4 I H 5 . 10 The steps of the SHA-1 algorithm are now examined in greater detail. 13.1.2.1 Step 1. Preprocessing The first step of SHA-1 is to pad the input message to be a multiple of 512 bits as follows and to initialize the chaining variables. 15 Table 235. Steps to follow to preprocess the input message Pad the input message Append a I bit to the message Append 0 bits such that the length of the padded message is 64-bits short of a multiple of 512 bits. Append a 64-bit value containing the length in bits of the original input message. Store the length as most significant bit through to least significant bit. Initialize the chaining H 1 <- h 1 , H 2 <- h2, H 3 +- h3, H 4 +- h4, H 5 +- h5 variables WO 2004/050369 PCT/AU2003/001616 722 13.1.2.2 Step 2. Processing The padded input message is processed in 512-bit blocks. Each 512-bit block is in the form of 16 x 32-bit words, referred to as inputWordo-15. 5 Table 236. Steps to follow for each 512 bit block (InputWordo.
1 5 ) Copy the 512 input bits into For j=0 to 15 X0-15 Xj = InputWord; Expand XO.
1 5 into X 16
.
7 9 For j=16 to 79 Xj <- ((Xj-3 G XG.3 G X;.
14 E X 1 6 ) <( 1) Initialize working variables A +- H 1 , B +- H 2 , C +- H 3 , D <- H 4 , E <- H 5 Round 1 For j=O to 19 t <- ((A a< 5) + f(B, C, D) + E + Xj + y1) E <- D, D +- C, C +- (B < 30), B +- A, A +- t Round 2 For j=20 to 39 t +- ((A 5) + h(B, C, D) + E + Xj + y2) E +- D, D - C, C <- (B ( 30), B <- A, A +- t Round 3 For j=40 to 59 t +- ((A a< 5) + g(B, C, D) + E + Xj + y3) E +- D, D <- C, C +- (B x 30), B +- A, A +- t Round 4 For j=60 to 79 t +- ((A < 5) + h(B, C, D) + E + Xj + y4) E <- D, D <- C, C <- (B <( 30), B <- A, A +- t Update chaining variables H 1 + - H 1 + A, H 2 +- H 2 + B,
H
3 <- H 3 + C, H 4 <- H 4 + D,
H
5
+
-
H
5 + E The bold text is to emphasize the differences between each round. 10 13.1.2.3 Step 3. Completion After all the 512-bit blocks of the padded input message have been processed, the output hash value is the final 160-bit value given by: H 1
H
2 1 H 3 1 H 4 1 H 5 . 13.1.2.4 Optimization for hardware implementation 15 The SHA-1 Step 2 procedure is not optimized for hardware. In particular, the 80 temporary 32-bit registers use up valuable silicon on a hardware implementation. This section describes an WO 2004/050369 PCT/AU2003/001616 723 optimization to the SHA-1 algorithm that only uses 16 temporary registers. The reduction in silicon is from 2560 bits down to 512 bits, a saving of over 2000 bits. It may not be important in some applications, but in the QA Chip storage space must be reduced where possible. 5 The optimization is based on the fact that although the original 16-word message block is expanded into an 80-word message block, the 80 words are not updated during the algorithm. In addition, the words rely on the previous 16 words only, and hence the expanded words can be calculated on the-fly during processing, as long as we keep 16 words for the backward references. We require rotating counters to keep track of which register we are up to using, but the effect is to save a large 10 amount of storage. Rather than index X by a single value j, we use a 5 bit counter to count through the iterations. This can be achieved by initializing a 5-bit register with either 16 or 20, and decrementing it until it reaches 0. In order to update the 16 temporary variables as if they were 80, we require 4 indexes, 15 each a 4-bit register. All 4 indexes increment (with wraparound) during the course of the algorithm. Table 237. Optimised Steps to follow for each 512 bit block (InputWordo.
1 5 ) Initialize working variables A +- H 1 , B <- H 2 , C +- H 3 , D +- H 4 , E +- H 5
N
1 +- 13, N 2 +- 8, N 3 +- 2, N 4 +- 0 Round 0 Do 16 times Copy the 512 input bits into XN4 = InputWordN 4 XO-15 [fN 1 , RN 2 , fIN3]optiona1 N 4 Round 1A Do 16 times t +- ((A <5) + f(B, C, D) + E + XN 4 + y) [9N 1 , 9N 2 , lN3]optional 9N 4 E +- D, D +- C, C +- (B < 30), B+- A, A +- t Round 1B Do 4 times XN4 +- ((XN1 ( XN2 ( XN3 @ XN4) 1) t +- ((A a 5) + f(B, C, D) + E + XN4 + y) 9N 1 , 9N 2 , 9N 3 , 9N 4 E +- D, D +- C, C <- (B a( 30), B +- A, A +- t Round 2 Do 20 times XN4 +- ((XNI ) XN2 G XN3 ( XN4) a 1) t +- ((A a 5) + h(B, C, D) + E + XN 4 + Y2) fN 1 , fN 2 , fiN 3 , N 4 WO 2004/050369 PCT/AU2003/001616 724 E <- D, D <- C, C +- (B < 30), B +- A, A <- t Round 3 Do 20 times XN4 <- ((XN1 ( XN2 e XN3 @ XN4) x 1) t 4- ((A a< 5) + g(B, C, D) + E + XN4 + Y3) fN 1 , ON 2 , N 3 , 9N 4 E <- D, D <- C, C <- (B < 30), B +- A, A <- t Round 4 Do 20 times XN4 <- ((XN1 E XN2 G XN3 @ XN4) a 1) t <- ((A < 5) + h(B, C, D) + E + XN4 + Y4)
IN
1 , N 2 , 9N 3 , N 4 E <- D, D +- C, C +- (B a 30), B +- A, A <- t Update chaining variables H 1 <- H 1 + A, H 2 +- H 2 + B,
H
3 <- H 3 + C, H 4 <- H 4 + D,
H
5 <- H 5 + E The bold text is to emphasize the differences between each round. The incrementing of N 1 , N 2 , and N 3 during Rounds 0 and 1A is optional. A software implementation 5 would not increment them, since it takes time, and at the end of the 16 times through the loop, all 4 counters will be their original values. Designers of hardware may wish to increment all 4 counters together to save on control logic. Round 0 can be completely omitted if the caller loads the 512 bits of X-1a. 10 14 Holding Out Against Attacks The authentication protocols described in Section 7 on page 688 onward should be resistant to defeat by logical means. This section details each type of attack in turn with reference to the Read Authentication protocol. 15 14.1~ BRUTE FORCE ATTACK A brute force attack is guaranteed to break any protocol. However the length of the key means that the time for an attacker to perform a brute force attack is too long to be worth the effort. An attacker only needs to break K to build a clone authentication chip. A brute force attack on K 20 must therefore break a 160-bit key.
WO 2004/050369 PCT/AU2003/001616 725 An attack against K requires a maximum of 2160 attempts, with a 50% chance of finding the key after only 2159 attempts. Assuming an array of a trillion processors, each running one million tests per second, 2159 (7.3 x 10 47 ) tests takes 2.3 x 1022 years, which is longer than the total lifetime of the universe. There are around 100 million personal computers in the world. Even if these were all 5 connected in an attack (e.g. via the Internet), this number is still 10,000 times smaller than the trillion-processor attack described. Further, if the manufacture of one trillion processors becomes a possibility in the age of nanocomputers, the time taken to obtain the key is still longer than the total lifetime of the universe. 10 14.2 GUESSING THE KEY ATTACK It is theoretically possible that an attacker can simply "guess the key". In fact, given enough time, and trying every possible number, an attacker will obtain the key. This is identical to the brute force attack described above, where 2159 attempts must be made before a 50% chance of success is obtained. 15 The chances of someone simply guessing the key on the first try is 2 0. For comparison, the chance of someone winning the top prize in a U.S. state lottery and being killed by lightning in the same day is only 1 in 261 [78]. The chance of someone guessing the authentication chip key on the first go is 1 in 2160, which is comparable to two people choosing exactly the same atoms from a 20 choice of all the atoms in the Earth i.e. extremely unlikely. 14.3 QUANTUM COMPUTER ATTACK To break K, a quantum computer containing 160 qubits embedded in an appropriate algorithm must be built. As described in Section 5.7.1.7 on page 675, an attack against a 160-bit key is not 25 feasible. An outside estimate of the possibility of quantum computers is that 50 qubits may be achievable within 50 years. Even using a 50 qubit quantum computer, 2110 tests are required to crack a 160 bit key. Assuming an array of 1 billion 50 qubit quantum computers, each able to try 250 keys in 1 microsecond (beyond the current wildest estimates) finding the key would take an average of 18 billion years. 30 14.4 CIPHERTEXT ONLY ATTACK An attacker can launch a ciphertext only attack on K by monitoring calls to Random and Read. However, given that all these calls also reveal the plaintext as well as the hashed form of the plaintext, the attack would be transformed into a stronger form of attack - a known plaintext attack. 35 14.5 KNOWN PLAINTEXT ATTACK WO 2004/050369 PCT/AU2003/001616 726 It is easy to connect a logic analyzer to the connection between the System and the authentication chip, and thereby monitor the flow of data. This flow of data results in known plaintext and the hashed form of the plaintext, which can therefore be used to launch a known plaintext attack against K. 5 To launch an attack against K, multiple calls to Random and Test must be made (with the call to Test being successful, and therefore requiring a call to Read on a valid chip). This is straightforward, requiring the attacker to have both a system authentication chip and a consumable authentication chip. For each set of calls, an X, SK[X] pair is revealed. The attacker must collect these pairs for further analysis. 10 The question arises of how many pairs must be collected for a meaningful attack to be launched with this data. An example of an attack that requires collection of data for statistical analysis is differential cryptanalysis (see Section 14.13 on page 730). However, there are no known attacks against SHA-1 or HMAC-SHA1 [7][7][7], so there is no use for the collected data at this time. 15 14.6 CHOSEN PLAINTEXT ATTACKS The golden rule for the QA Chip is that it never signs something that is simply given to it - i.e. it never lets the user choose the message that is signed. Although the attacker can choose both RT and possibly M, ChipA advances its random number RA 20 with each call to Read. The resultant message X therefore contains 160 bits of changing data each call that are not chosen by the attacker. To launch a chosen text attack the attacker would need to locate a chip whose R was the desired R. This makes the search effectively impossible. 25 14.7 ADAPTIVE CHOSEN PLAINTEXT ATTACKS The HMAC construct provides security against all forms of chosen plaintext attacks [7]. This is primarily because the HMAC construct has 2 secret input variables (the result of the original hash, and the secret key). Thus finding collisions in the hash function itself when the input variable is 30 secret is even harder than finding collisions in the plain hash function. This is because the former requires direct access to SHA-1 in order to generate pairs of input/output from SHA-1. Since R changes with each call to Read, the user cannot choose the complete message. The only value that can be collected by an attacker is HMAC[R 1 I R 2 I M 2 ]. These are not attacks against the 35 SHA-1 hash function itself, and reduce the attack to a differential cryptanalysis attack (see Section 14.13 on page 730), examining statistical differences between collected data. Given that there is no WO 2004/050369 PCT/AU2003/001616 727 differential cryptanalysis attack known against SHA-1 or HMAC, the protocols are resistant to the adaptive chosen plaintext attacks. 14.8 PURPOSEFUL ERROR ATTACK 5 An attacker can only launch a purposeful error attack on the Test function, since this is the only function in the Read protocol that validates input against the keys. With the Test function, a 0 value is produced if an error is found in the input - no further information is given. In addition, the time taken to produce the 0 result is independent of the input, giving the 10 attacker no information about which bit(s) were wrong. A purposeful error attack is therefore fruitless. 14.9 CHAINING ATTACK Any form of chaining attack assumes that the message to be hashed is over several blocks, or the 15 input variables can somehow be set. The HMAC-SHA1 algorithm used by Protocol C1 only ever hashes one or two 512-bit blocks. Chaining attacks are not possible when only one block is used, and are extremely limited when two blocks are used. 14.10 BIRTHDAY ATTACK 20 The strongest attack known against HMAC is the birthday attack, based on the frequency of collisions for the hash function [7][7]. However this is totally impractical for minimally reasonable hash functions such as SHA-1. And the birthday attack is only possible when the attacker has control over the message that is hashed. Since in the protocols described for the QA Chip, the message to be signed is never chosen by the 25 attacker (at least one 160-bit R value is chosen by the chip doing the signing), the attacker has no control over the message that is hashed. An attacker must instead search for a collision message that hashes to the same value (analogous to finding one person who shares your birthday). The clone chip must therefore attempt to find a new value R 2 such that the hash of R 1 , R 2 and a 30 chosen M 2 yields the same hash value as H[RIR 2 |M]. However ChipT does not reveal the correct hash value (the Test function only returns 1 or 0 depending on whether the hash value is correct). Therefore the only way of finding out the correct hash value (in order to find a collision) is to interrogate a real ChipA. But to find the correct value means to update M, and since the decrement only parts of M are one-way, and the read-only parts of M cannot be changed, a clone consumable 35 would have to update a real consumable before attempting to find a collision. The alternative is a brute force attack search on the Test function to find a success (requiring each clone consumable WO 2004/050369 PCT/AU2003/001616 728 to have access to a System consumable). A brute force search, as described above, takes longer than the lifetime of the universe, in this case, per authentication. There is no point for a clone consumable to launch this kind of attack. 5 14.11 SUBSTITUTION WITH A COMPLETE LOOKUP TABLE The random number seed in each System is 160 bits. The best case situation for an attacker is that no state data has been changed. Assuming also that the clone consumable does not advance its R, there is a constant value returned as M. A clone chip must therefore return SK[R I c] (where c is a 10 constant), which is a 160 bit value. Assuming a 160-bit lookup of a 160-bit result, this requires 2.9 x 1049 bytes, or 2.6 x 1037 terabytes, certainly more space than is feasible for the near future. This of course does not even take into account the method of collecting the values for the ROM. A complete lookup table is therefore 15 completely impossible. 14.12 SUBSTITUTION WITH A SPARSE LOOKUP TABLE A sparse lookup table is only feasible if the messages sent to the authentication chip are somehow predictable, rather than effectively random. 20 The random number R is seeded with an unknown random number, gathered from a naturally System authentication chip's Random function, and iterating some random event. There is no possibility for a clone manufacturer to know what the possible range of R is for all Systems, since each bit has an unrelated chance of being 1 or 0. 25 Since the range of R in all systems is unknown, it is not possible to build a sparse lookup table that can be used in all systems. The general sparse lookup table is therefore not a possible attack. However, it is possible for a clone manufacturer to know what the range of R is for a given System. This can be accomplished by loading a LFSR with the current result from a call to a specific number 30 of times into the future. If this is done, a special ROM can be built which will only contain the responses for that particular range of R, i.e. a ROM specifically for the consumables of that particular System. But the attacker still needs to place correct information in the ROM. The attacker will therefore need to find a valid authentication chip and call it for each of the values in R. Suppose the clone authentication chip reports a full consumable, and then allows a single use 35 before simulating loss of connection and insertion of a new full consumable. The clone consumable would therefore need to contain responses for authentication of a full consumable and authentication of a partially used consumable. The worst case ROM contains entries for full and WO 2004/050369 PCT/AU2003/001616 729 partially used consumables for R over the lifetime of System. However, a valid authentication chip must be used to generate the information, and be partially used in the process. If a given System only produces n R-values, the sparse lookup-ROM required is 20n bytes (20 = 160 / 8) multiplied by the number of different values for M. The time taken to build the ROM depends on the amount of 5 time enforced between calls to Read. After all this, the clone manufacturer must rely on the consumer returning for a refill, since the cost of building the ROM in the first place consumes a single consumable. The clone manufacturer's business in such a situation is consequently in the refills. 10 The time and cost then, depends on the size of R and the number of different values for M that must be incorporated in the lookup. In addition, a custom clone consumable ROM must be built to match each and every System, and a different valid authentication chip must be used for each System (in order to provide the full and partially used data). The use of an authentication chip in a System must therefore be examined to determine whether or not this kind of attack is worthwhile for 15 a clone manufacturer. As an example, of a camera system that has about 10,000 prints in its lifetime. Assume it has a single Decrement Only value (number of prints remaining), and a delay of 1 second between calls to Read. In such a system, the sparse table will take about 3 hours to build, and consumes 1OOK. 20 Remember that the construction of the ROM requires the consumption of a valid authentication chip, so any money charged must be worth more than a single consumable and the clone consumable combined. Thus it is not cost effective to perform this function for a single consumable (unless the clone consumable somehow contained the equivalent of multiple authentic consumables). 25 If a clone manufacturer is going to go to the trouble of building a custom ROM for each owner of a System, an easier approach would be to update System to completely ignore the authentication chip. 30 Consequently, this attack is possible as a per-System attack, and a decision must be made about the chance of this occurring for a given System/Consumable combination. The chance will depend on the cost of the consumable and authentication chips, the longevity of the consumable, the profit margin on the consumable, the time taken to generate the ROM, the size of the resultant ROM, and whether customers will come back to the clone manufacturer for refills that use the same clone chip 35 etc.
WO 2004/050369 PCT/AU2003/001616 730 14.13 DIFFERENTIAL CRYPTANALYSIS Existing differential attacks are heavily dependent on the structure of S boxes, as used in DES and other similar algorithms. Although HMAC-SHAI has no S boxes, an attacker can undertake a differential-like attack by undertaking statistical analysis of: 5 - Minimal-difference inputs, and their corresponding outputs e Minimal-difference outputs, and their corresponding inputs To launch an attack of this nature, sets of input/output pairs must be collected. The collection can be via known plaintext, or from a partially adaptive chosen plaintext attack. Obviously the latter, 10 being chosen, will be more useful. Hashing algorithms in general are designed to be resistant to differential analysis. SHA-1 in particular has been specifically strengthened, especially by the 80 word expansion so that minimal differences in input will still produce outputs that vary in a larger number of bit positions (compared 15 to 128 bit hash functions). In addition, the information collected is not a direct SHA-1 input/output set, due to the nature of the HMAC algorithm. The HMAC algorithm hashes a known value with an unknown value (the key), and the result of this hash is then rehashed with a separate unknown value. Since the attacker does not know the secret value, nor the result of the first hash, the inputs and outputs from SHA-1 are not known, making any differential attack extremely difficult. 20 There are no known differential attacks against SHA-1 or HMAC-SHA-1 [56][56]. The following is a more detailed discussion of minimally different inputs and outputs from the QA Chip. 25 14.13.1 Minimal difference inputs This is where an attacker takes a set of X, SK[X) values where the X values are minimally different, and examines the statistical differences between the outputs SK[XI. The attack relies on X values that only differ by a minimal number of bits. The question then arises as to how to obtain minimally different X values in order to compare the SK[X] values. 30 Although the attacker can choose both RT and possibly M, ChipA advances its random number RA with each call to Read. The resultant X therefore contains 160 bits of changing data each call, and is therefore not minimally different.
WO 2004/050369 PCT/AU2003/001616 731 14.13.2 Minimal difference outputs This is where an attacker takes a set of X, SK[X] values where the SK[X] values are minimally different, and examines the statistical differences between the X values. The attack relies on SK[X] values that only differ by a minimal number of bits. 5 There is no way for an attacker to generate an X value for a given SK[X]. To do so would violate the fact that S is a one-way function (HMAC-SHAI). Consequently the only way for an attacker to mount an attack of this nature is to record all observed X, SK[X] pairs in a table. A search must then be made through the observed values for enough minimally different SK[X] values to undertake a 10 statistical analysis of the X values. 14.14 MESSAGE SUBSTITUTION ATTACKS In order for this kind of attack to be carried out, a clone consumable must contain a real authentication chip, but one that is effectively reusable since it never gets decremented. The clone 15 authentication chip would intercept messages, and substitute its own. However this attack does not give success to the attacker. A clone authentication chip may choose not to pass on a Write command to the real authentication chip. However the subsequent Read command must return the correct response (as if the Write 20 had succeeded). To return the correct response, the hash value must be known for the specific R and M. An attacker can only determine the hash value by actually updating M in a real Chip, which the attacker does not want to do. Even changing the R sent by System does not help since the System authentication chip must match the R during a subsequent Test. 25 A message substitution attack would therefore be unsuccessful. This is only true if System updates the amount of consumable remaining before it is used. 14.15 REVERSE ENGINEERING THE KEY GENERATOR If a pseudo-random number generator is used to generate keys, there is the potential for a clone 30 manufacture to obtain the generator program or to deduce the random seed used. This was the way in which the security layer of the Netscape browser was initially broken [33]. 14.16 BYPASSING THE AUTHENTICATION PROCESS The System should ideally update the consumable state data before the consumable is used, and 35 follow every write by a read (to authenticate the write). Thus each use of the consumable requires an authentication. If the System adheres to these two simple rules, a clone manufacturer will have to simulate authentication via a method above (such as sparse ROM lookup).
WO 2004/050369 PCT/AU2003/001616 732 14.17 REUSE OF AUTHENTICATION CHIPS Each use of the consumable requires an authentication. If a consumable has been used up, then its authentication chip will have had the appropriate state-data values decremented to 0. The chip can 5 therefore not be used in another consumable. Note that this only holds true for authentication chips that hold Decrement-Only data items. If there is no state data decremented with each usage, there is nothing stopping the reuse of the chip. This is the basic difference between Presence-Only authentication and Consumable Lifetime 10 authentication. All described protocols allow both. The bottom line is that if a consumable has Decrement Only data items that are used by the System, the authentication chip cannot be reused without being completely reprogrammed by a valid programming station that has knowledge of the secret key (e.g. an authorized refill station). 15 14.18 MANAGEMENT DECISION TO OMIT AUTHENTICATION TO SAVE COSTS Although not strictly an external attack, a decision to omit authentication in future Systems in order to save costs will have widely varying effects on different markets. 20 In the case of high volume consumables, it is essential to remember that it is very difficult to introduce authentication after the market has started, as systems requiring authenticated consumables will not work with older consumables still in circulation. Likewise, it is impractical to discontinue authentication at any stage, as older Systems will not work with the new, unauthenticated, consumables. In the second case, older Systems can be individually altered by 25 replacing the System program code. Without any form of protection, illegal cloning of high volume consumables is almost certain. However, with the patent and copyright protection, the probability of illegal cloning may be, say 50%. However, this is not the only loss possible. If a clone manufacturer were to introduce clone 30 consumables which caused damage to the System (e.g. clogged nozzles in a printer due to poor quality ink), then the loss in market acceptance, and the expense of warranty repairs, may be significant. In the case of a specialized pairing, such as a car/car-keys, or door/door-key, or some other similar 35 situation, the omission of authentication in future systems is trivial and without repercussions. This is because the consumer is sold the entire set of System and Consumable authentication chips at the one time.
WO 2004/050369 PCT/AU2003/001616 733 14.19 GARROTE/BRIBE ATTACK If humans do not know the key, there is no amount of force or bribery that can reveal them. The use of ChipF and the ReplaceKey protocol is specifically designed to avoid the requirement of the programming station having to know the new key. However ChipF must be told the new key at 5 some stage, and therefore it is the person(s) who enter the new key into ChipF that are at risk. The level of security against this kind of attack is ultimately a decision for the System/Consumable owner, to be made according to the desired level of service. 10 For example, a car company may wish to keep a record of all keys manufactured, so that a person can request a new key to be made for their car. However this allows the potential compromise of the entire key database, allowing an attacker to make keys for any of the manufacturer's existing cars. It does not allow an attacker to make keys for any new cars. Of course, the key database itself may also be encrypted with a further key that requires a certain number of people to combine their 15 key portions together for access. If no record is kept of which key is used in a particular car, there is no way to make additional keys should one become lost. Thus an owner will have to replace his car's authentication chip and all his car-keys. This is not necessarily a bad situation. By contrast, in a consumable such as a printer ink cartridge, the one key combination is used for all 20 Systems and all consumables. Certainly if no backup of the keys is kept, there is no human with knowledge of the key, and therefore no attack is possible. However, a no-backup situation is not desirable for a consumable such as ink cartridges, since if the key is lost no more consumables can be made. The manufacturer should therefore keep a backup of the key information in several parts, where a certain number of people must together combine their portions to reveal the full key 25 information. This may be required if case the chip programming station needs to be reloaded. In any case, none of these attacks are against the authenticated read protocol, since no humans are involved in the authentication process. 30 LOGICAL INTERFACE 15 Introduction The QA Chip has a physical and a logical external interface. The physical interface defines how the QA Chip can be connected to a physical System, while the logical interface determines how that System can communicate with the QA Chip. This section deals with the logical interface. 35 15.1 OPERATING MODES The QA Chip has four operating modes - Idle Mode, Program Mode, Trim Mode and Active Mode.
WO 2004/050369 PCT/AU2003/001616 734 * Idle Mode is used to allow the chip to wait for the next instruction from the System. * Trim Mode is used to determine the clock speed of the chip and to trim the frequency during the initial programming stage of the chip (when Flash memory is garbage). The clock frequency must be trimmed via Trim Mode before Program Mode is used to store the 5 program code. " Program Mode is used to load up the operating program code, and is required because the operating program code is stored in Flash memory instead of ROM (for security reasons). " Active Mode is used to execute the specific authentication command specified by the System. Program code is executed in Active Mode. When the results of the command have 10 been returned to the System, the chip enters Idle Mode to wait for the next instruction. 15.1.1 Idle Mode The QA Chip starts up in /d/e Mode. When the Chip is in Idle Mode, it waits for a command from the master by watching the primary id on the serial line. 15 e If the primary id matches the global id (OxO, common to all QA Chips), and the following byte from the master is the Trim Mode id byte, the QA Chip enters Trim Mode and starts counting the number of internal clock cycles until the next byte is received. * If the primary id matches the global id (0x00, common to all QA Chips), and the following byte from the master is the Program Mode id byte, the QA Chip enters Program Mode. 20 If the primary id matches the global id (0x0, common to all QA Chips), and the following byte from the master is the Active Mode id byte, the QA Chip enters Active Mode and executes startup code, allowing the chip to set itself into a state to receive authentication commands (includes setting a local id). * If the primary id matches the chip's local id, and the following byte is a valid command code, 25 the QA Chip enters Active Mode, allowing the command to be executed. The valid 8-bit serial mode values sent after a global id are as shown in Table 238. They are specified to minimize the chances of them occurring by error after a global id (e.g. OxFF and OxOO are not used): 30 Table 238. Id byte values to place chip in specific mode Value Interpretation 10100101 (0xA5) Trim Mode 10001110 (Ox8E) Program Mode 01111000 (0x78) Active Mode WO 2004/050369 PCT/AU2003/001616 735 15.1.2 Trim Mode Trim Mode is enabled by sending a global id byte (0x00) followed by the Trim Mode command byte. The purpose of Trim Mode is to set the trim value (an internal register setting) of the internal ring oscillator so that Flash erasures and writes are of the correct duration. This is necessary due to the 5 variation of the clock speed due to process variations. If writes an erasures are too long, the Flash memory will wear out faster than desired, and in some cases can even be damaged. Trim Mode works by measuring the number of system clock cycles that occur inside the chip from the receipt of the Trim Mode command byte until the receipt of a data byte. When the data byte is received, the data byte is copied to the trim register and the current value of the count is transmitted 10 to the outside world. Once the count has been transmitted, the QA Chip returns to /d/e Mode. At reset, the internal trim register setting is set to a known value r. The external user can now 15 perform the following operations: * send the global id+write followed by the Trim Mode command byte e send the 8-bit value v over a specified time t * send a stop bit to signify no more data * send the global id+read followed by the Trim Mode command byte 20 e receive the count c * send a stop bit to signify no more data At the end of this procedure, the trim register will be v, and the external user will know the relationship between external time t and internal time c. Therefore a new value for v can be 25 calculated. The Trim Mode procedure can be repeated a number of times, varying both t and v in known ways, measuring the resultant c. At the end of the process, the final value for v is established (and stored in the trim register for subsequent use in Program Mode). This value v must also be written to the 30 flash for later use (every time the chip is placed in Active Mode for the first time after power-up). 15.1.3 Program Mode Program Mode is enabled by sending a global id byte (OxOO) followed by the Program Mode command byte. 35 The QA Chip determines whether or not the internal fuse has been blown (by reading 32-bit word 0 of the information block of flash memory).
WO 2004/050369 PCT/AU2003/001616 736 If the fuse has been blown the Program Mode command is ignored, and the QA Chip returns to Idle Mode. If the fuse is still intact, the chip enters Program Mode and erases the entire contents of Flash 5 memory. The QA Chip then validates the erasure. If the erasure was successful, the QA Chip receives up to 4096 bytes of data corresponding to the new program code and variable data. The bytes are transferred in order byteo to byte 40 95 . Once all bytes of data have been loaded into Flash, the QA Chip returns to Idle Mode. 10 Note that Trim Mode functionality must be performed before a chip enters Program Mode for the first time. Once the desired number of bytes have been downloaded in Program Mode, the LSS Master must 15 wait for 80ps (the time taken to write two bytes to flash at nybble rates) before sending the new transaction (eg Active Mode). Otherwise the last nybbles may not be written to flash. 15.1.4 Active Mode Active Mode is entered either by receiving a global id byte (OxO) followed by the Active Mode 20 command byte, or by sending a local id byte followed by a command opcode byte and an appropriate number of data bytes representing the required input parameters for that opcode. In both cases, Active Mode causes execution of program code previously stored in the flash memory via Program Mode. As a result, we never enter Active Mode after Trim Mode, without a 25 Program Mode in between. However once programmed via Program Mode, a chip is allowed to enter Active Mode after power-up, since valid data will be in flash. If Active Mode is entered by the global id mechanism, the QA Chip executes specific reset startup code, typically setting up the local id and other 10 specific data. 30 If Active Mode is entered by the local id mechanism, the QA Chip executes specific code depending on the following byte, which functions as an opcode. The opcode command byte format is shown in Table 239: Table 239. Command byte 35 bits Description 2-0 Opcode WO 2004/050369 PCT/AU2003/001616 737 5-3 ,opcode 7-6 count of number of bits set in opcode (0 to 3) The interpretation of the 3-bit opcode is shown in Table 240: Table 240. QA Chip opcodes Opz Mnd Description 000 RST Reset 001 RND Random 010 RDM Read M 011 TST est 100 WRM rite M with no authentication 101 WRA rite with Authentication (to M, P, or K) 110 chip specific - reserved for ChipF, ChipS etc 111 chip specific - reserved for ChipF, ChipS etc 5 The command byte is designed to ensure that errors in transmission are detected. Regular QA Chip commands are therefore comprised of an opcode plus any associated parameters. The commands are listed in Table 241: Table 241. QA Chip commands 10 Command Input Output opcode Additional parms Return value Reset RST - Random RND - [20] Read RDM [1, 1, 20] [20, 64, 20]4 Test TST [1, 20, 64, 20] 89' if successful, 76 if not Write WRM [1, 64, 20] 89 if successful, 76 if not 2 Opcode 3 Mnemonic 4 [n, m] = list of parameters where n bytes for first parameter, and m bytes for the second etc. 6 n = actual byte pattern required (in hex). The bytes 0x76 and 0x89 were chosen as the bool ean values 0 and 1 as they are inverses of each other, and should not be generated acciden tally.
WO 2004/050369 PCT/AU2003/001616 738 WriteAuth WRA 76 [20, 64, 20] 89 if successful, 76 if not ReplaceKey WRA 89 76 [1, 20, 20, 20] 89 if successful, 76 if not SetPermissions WRA 89 89 [1, 1, 20, 4, 20] [4] SignM" ChipS only [1, 20, 20, 64, 20, 64] [20, 64, 20] SignP' ChipS only [1, 20, 20, 4, 20, 4] [20, 64, 20] GetProgKey ChipF only [1, 20] [20, 20, 20] SetPartialKey ChipF only [1, 4] 89 if successful, 76 if not Apart from the Reset command, the next four commands are the commands most likely to be used during regular operation. The next three commands are used to provide authenticated writes (which are expected to be uncommon). The final set of commands (including SignM), are expected to be 5 specially implemented on ChipS and ChipF QA Chips only. The input parameters are sent in the specified order, with each parameter being sent least significant byte first and most significant byte last. Return (output) values are read in the same way - least significant byte first and most significant byte last. The client must know how many bytes to retrieve. The QA Chip will time out and return to 10 Idle Mode if an incorrect number of bytes is provided or read. In most cases, the output bytes from one chip's command (the return values) can be fed directly as the input bytes to another chip's command. An example of this is the RND and RD commands. The output data from a call to RND on a trusted QA Chip does not have to be kept by the System. Instead, the System can transfer the output bytes directly to the input of the non-trusted QA Chip's 15 RD command. The description of each command points out where this is so. Each of the commands is examined in detail in the subsequent sections. Note that some algorithms are specifically designed because flash memory is assumed for the implementation of non-volatile variables. 15.1.5 Non volatile variables 20 The memory within the QA Chip contains some non-volatile (Flash) memory to store the variables required by the authentication protocol. Table 242 summarizes the variables. Table 242. Non volatile variables required by the authentication protocol Name Size Description It is expected that most QA Chips will implement SignM as a function that returns xO. Only a limited number of chips will be programmed to allow SignM functionality. It is included here as an example of how signatures can be generated for authenticated writes. 7 It is expected that most QA Chips will implement SignP as a function that returns OxOO. Only a limited number of chips will be programmed to allow SignP functionality. It is included here as an example of how signatures can be generated for authenticated writes.
WO 2004/050369 PCT/AU2003/001616 739 (bits) N 8 Number of keys known to the chip T 8 Number of vectors M is broken into K, 160 per key, Array of N secret keys used for calculating FKnX] RK 160 for RK where K, is the nth element of the array. Each K, must not be stored directly in the QA Chip. Instead, each chip needs to store a single random number RK (different for each chip), Kf@RK, and -,KeRK. The stored KneRK can be XORed with RK to obtain the real Kn. Although -,Kn@RK must be stored to protect against differential attacks, it is not used. R 160 Current random number used to ensure time varying messages. Each chip instance must be seeded with a different initial value. Changes for each signature generation. MT 512 per M Array of T memory vectors. Only Mo can be written to with an authorized write, while all Ms can be written to in an unauthorized write. Writes to Mo are optimized for Flash usage, while updates to any other Mn are expensive with regards to Flash utilization, and are expected to be only performed once per section of Mn. M 1 contains T and N in ReadOnly form so users of the chip can know hese two values. PT+N 32 per P T+N element array of access permissions for each part of M. Entries n={0... T-1} hold access permissions for non-authenticated writes to M, (no key required). Entries n={T to T+N-1}hold access permissions for authenticated writes to Mo for K. Permission choices for each part of M are Read Only, Read/Write, and Decrement Only MinTicks 32 The minimum number of clock ticks between calls to key-based functions. Note that since these variables are in Flash memory, writes should be minimized. The it is not a simple matter to write a new value to replace the old. Care must be taken with flash endurance, and speed of access. This has an effect on the algorithms used to change Flash memory based registers. For example, Flash memory should not be used as a shift register.
WO 2004/050369 PCT/AU2003/001616 740 A reset of the QA Chip has no effect on the non-volatile variables. 15.1.5.1 MandP Mn contains application specific state data, such as serial numbers, batch numbers, and amount of 5 consumable remaining. Mn can be read using the Read command and written to via the Write and WriteA commands. Mo is expected to be updated frequently, while each part of M 1 .- should only be written to once. Only Mo can be written to via the WriteA command. 10
M
1 contains the operating parameters of the chip as shown in Table 243, and M 2 n are application specific. Table 243. Interpretation of M 1 Length Bits interpretation 8 7-0 Number of available keys 8 15-8 Number of available M vectors 16 31-16 Revision of chip 96 127-32 Manufacture id information 128 255-128 Serial number 8 263-256 Local id of chip 248 511-264 reserved 15 Each Mn is 512 bits in length, and is interpreted as a set of 16 x 32-bit words. Although Ma may contain a number of different elements, each 32-bit word differs only in write permissions. Each 32 bit word can always be read. Once in client memory, the 512 bits can be interpreted in any way chosen by the client. The different write permissions for each P are outlined in Table 244: 20 Table 244. Write permissions Data type permission description Read Only Can never be written to ReadWrite Can always be written to Decrement Only Can only be written to if the new value is less than the old value. Decrement Only values can be any multiple of 32 bits. To accomplish the protection required for writing, a 2-bit permission value P is defined for each of the 32-bit words. Table 245 defines the interpretation of the 2-bit permission bit-pattern: WO 2004/050369 PCT/AU2003/001616 741 Table 245. Permission bit interpretation Bits Op Interpretation Action taken during Write command 00 RW ReadWrite The new 32-bit value is always written to M[n]. 01 MSR Decrement Only The new 32-bit value is only written to (Most Significant M[n] if it is less than the value currently Region) in M[n]. This is used for access to the Most Significant 16 bits of a Decrement Only number. 10 NMSR Decrement Only The new 32-bit value is only written to (Not the Most M[n] if M[n-1] could also be written. The Significant Region) NMSR access mode allows multiple precision values of 32 bits and more (multiples of 32 bits) to decrement. 11 RO Read Only The new 32-bit value is ignored. M[n] is left unchanged. The 16 sets of permission bits for each 512 bits of M are gathered together in a single 32-bit 5 variable P, where bits 2n and 2n+1 of P correspond to word n of M as follows: Each 2-bit value is stored as a pair with the msb in bit 1, and the Isb in bit 0. Consequently, if words 0 to 5 of M had permission MSR, with words 6-15 of M permission RO, the 32-bit P variable would be OxFFFFF555: 10 11-11-11-11-11-11-11-11-11-11-01-01-01-01-01-01 During execution of a Write and WriteA command, the appropriate Permissions[n] is examined for each M[n] starting from n=1 5 (msw of M) to n=0 (Isw of M), and a decision made as to whether the 15 new M[n] value will replace the old. Note that it is important to process the M[n] from msw to isw to correctly interpret the access permissions. Permissions are set and read using the QA Chip's SetPermissions command. The default for P is all Os (RW) with the exception of certain parts of Mi. 20 Note that the Decrement Only comparison is unsigned, so any Decrement Only values that require negative ranges must be shifted into a positive range. For example, a consumable with a WO 2004/050369 PCT/AU2003/001616 742 Decrement Only data item range of -50 to 50 must have the range shifted to be 0 to 100. The System must then interpret the range 0 to 100 as being -50 to 50. Note that most instances of Decrement Only ranges are N to 0, so there is no range shift required. 5 For Decrement Only data items, arrange the data in order from most significant to least significant 32-bit quantities from M[n] onward. The access mode for the most significant 32 bits (stored in M[n]) should be set to MSR. The remaining 32-bit entries for the data should have their permissions set to NMSR. 10 If erroneously set to NMSR, with no associated MSR region, each NMSR region will be considered independently instead of being a multi-precision comparison. Examples of allocating M and Permission bits can be found in [86]. 15 15.1.5.2 K and RK K is the 160-bit secret key used to protect M and to ensure that the contents of M are valid (when M is read from a non trusted chip). K is initially programmed after manufacture, and from that point on, K can only be updated to a new value if the old K is known. Since K must be kept secret, there is no command to directly read it. 20 K is used in the keyed one-way hash function HMAC-SHA1. As such it should be programmed with a physically generated random number, gathered from a physically random phenomenon. K must NOT be generated with a computer-run random number generator. The security of the QA Chips depends on K being generated in a way that is not deterministic. 25 Each K, must not be stored directly in the QA Chip. Instead, each chip needs to store a single random number RK (different for each chip), KEDRK, and ,KERK. The stored Kf@RK can be XORed with RK to obtain the real K. Although -,K,,eRK must be stored to protect against differential attacks, it is not used. 30 15.1.5.3 R R is a 160-bit random number seed that is set up after manufacture (when the chip is programmed) and from that point on, cannot be changed. R is used to ensure that each signed item contains time varying information (not chosen by an attacker), and each chip's R is unrelated from one chip to the 35 next.
WO 2004/050369 PCT/AU2003/001616 743 R is used during the Test command to ensure that the R from the previous call to Random was used as the session key in generating the signature during Read. Likewise, R is used during the WriteAuth command to ensure that the R from the previous call to Read was used as the session key during generation of the signature in the remote Authenticated chip. 5 The only invalid value for R is 0. This is because R is changed via a 160-bit maximal period LFSR (Linear Feedback Shift Register) with taps on bits 0, 2, 3, and 5, and is changed only by a successful call to a signature generating function (e.g. Test, WriteAuth). 10 The logical security of the QA Chip relies not only upon the randomness of K and the strength of the HMAC-SHAI algorithm. To prevent an attacker from building a sparse lookup table, the security of the QA Chip also depends on the range of R over the lifetime of all Systems. What this means is that an attacker must not be able to deduce what values of R there are in produced and future Systems. Ideally, R should be programmed with a physically generated random number, gathered 15 from a physically random phenomenon (must not be deterministic). R must NOT be generated with a computer-run random number generator. 15.1.5.4 MinTicks There are two mechanisms for preventing an attacker from generating multiple calls to key-based 20 functions in a short period of time. The first is an internal ring oscillator that is temperature-filtered. The second mechanism is the 32-bit MinTicks variable, which is used to specify the minimum number of QA Chip clock ticks that must elapse between calls to key-based functions. The MinTicks variable is set to a fixed value when the QA Chip is programmed. It could possibly be 25 stored in M 1 . The effective value of MinTicks depends on the operating clock speed and the notion of what constitutes a reasonable time between key-based function calls (application specific). The duration of a single tick depends on the operating clock speed. This is the fastest speed of the ring oscillator 30 generated clock (i.e. at the lowest valid operating temperature). Once the duration of a tick is known, the MinTicks value can to be set. The value for MinTicks will be the minimum number of ticks required to pass between calls to the key-based functions (there is no need to protect Random as this produces the same output each time it is called multiple times in a 35 row). The value is a real-time number, and divided by the length of an operating tick.
WO 2004/050369 PCT/AU2003/001616 744 It should be noted that the MinTicks variable only slows down an attacker and causes the attack to cost more since it does not stop an attacker using multiple System chips in parallel. 15.1.6 GetProgramKey 5 Input: n, RE [1 byte, 20 bytes] Output: RL, EKx[SKf[REIRLIC 3 ], SKx[RjEV[Sn[RERLIC 3 ]IGs] = [20, 20, 20] Changes: RL Note: The GetProgramKey command is only implemented in ChipF, and not in all QA Chips. The GetProgramKey command is used to produce the bytestream required for updating a specified 10 key in ChipP. Only an QA Chip programmed with the correct values of the old Kn can respond correctly to the GetProgramKey request. The output bytestream from the Random command can be fed as the input bytestream to the ReplaceKey command on the QA Chip being programmed (ChipP). 15 The input bytestream consists of the appropriate opcode followed by the desired key to generate the signature, followed by 20 bytes of RE(representing the random number read in from ChipP). The local random number RL is advanced, and signed in combination with RE and C 3 by the chosen key to generate a time varying secret number known to both ChipF and ChipP. This signature is 20 then XORed with the new key K, (this encrypts the new key). The first two output parameters are signed with the old key to ensure that ChipP knows it decoded K, correctly. This whole procedure should only be allowed a given number of times. The actual number can conveniently be stored in the local Mo[0] (eg word 0 of Mo) with ReadOnly permission. Of course 25 another chip could perform an Authorised write to update the number (via a ChipS) should it be desired. The GetProgramKey command is implemented by the following steps: Loop through all of Flash, reading each word (will trigger checks) 30 Accept n Restrict n to N Accept R, If (MO [0] = 0) Output 60 bytes of 0x00 # no more keys allowed to be generated 35 from this chipF Done Endlf WO 2004/050369 PCT/AU2003/001616 745 Advance RL SIG <- S,[RIREIC3] # calculation must take constant time Tmp <- SIG ( Kx 5 Output RL Output Tmp Decrement Mo 0] # reduce the number of allowable key generations by 1 SIG <- Sx[RITmpC 3 ] # calculation must take constant time 10 Output SIG 15.1.7 Random Input: None Output: RL = [20 bytes] Changes: None 15 The Random command is used by a client to obtain an input for use in a subsequent authentication procedure. Since the Random command requires no input parameters, it is therefore simply I byte containing the RND opcode. The output of the Random command from a trusted QA Chip can be fed straight into the non 20 trusted chip's Read command as part of the input parameters. There is no need for the client to store them at all, since they are not required again. However the Test command will only succeed if the data passed to the Read command was obtained first from the Random command. If a caller only calls the Random function multiple times, the same output will be returned each time. 25 R will only advance to the next random number in the sequence after a successful call to a function that returns or tests a signature (e.g. Test, see Section 15.1.13 on page 752 for more information). The Random command is implemented by the following steps: Loop through all of Flash, reading each word (will trigger checks) 30 output Ra 15.1.8 Read Input: n, t, RE = [1 byte, 1 byte, 20 bytes] Output: RL, Mu, SKn[REIRLIC1|MLd = [20 bytes, 64 bytes, 20 bytes] 35 Changes: RL The Read command is used to read the entire state data (Mt) from an QA Chip. Only an QA Chip programmed with the correct value of K, can respond correctly to the Read request. The output WO 2004/050369 PCT/AU2003/001616 746 bytestream from the Read command can be fed as the input bytestream to the Test command on a trusted QA Chip for verification, with Mt stored for later use if Test returns success. The input bytestream consists of the RD opcode followed by the key number to use for the 5 signature, which M to read, and the bytes 0-19 of RE. 23 bytes are transferred in total. RE is obtained by calling the trusted QA Chip's Random command. The 20 bytes output by the trusted chip's Random command can therefore be fed directly into the non-trusted chip's Read command, with no need for these bits to be stored by System. 10 Calls to Read must wait for MinTicksRemaining to reach 0 to ensure that a minimum time will elapse between calls to Read. The output values are calculated, MinTicksRemaining is updated, and the signature is returned. The contents of MU are transferred least significant byte to most significant byte. The signature 15 SKn[REIRLIC11MLt] must be calculated in constant time. The next random number is generated from R using a 160-bit maximal period LFSR (tap selections on bits 5, 3, 2, and 0). The initial 160-bit value for R is set up when the chip is programmed, and can be any random number except 0 (an LFSR filled with Os will produce a never-ending stream of Os). 20 R is transformed by XORing bits 0, 2, 3, and 5 together, and shifting all 160 bits right 1 bit using the XOR result as the input bit to b 1 5 9 . The process is shown in Figure 347 below. Care should be taken when updating R since it lives in Flash. Program code must assume power could be removed at any time. 25 The Read command is implemented with the following steps: Wait for MinTicksRemaining to become 0 Loop through all of Flash, reading each word (will trigger checks) Accept n 30 Accept t Restrict n to N Restrict t to T Accept RE Advance RL 35 Output RL Output Mst Sig +- Sm [RIjRLIC1|MLt] # calculation must take constant time WO 2004/050369 PCT/AU2003/001616 747 MinTicksRemaining <- MinTicks Output Sig Wait for MinTicksRemaining to become 0 5 15.1.9 Set Permissions Input: n, p, RE, PE, SIGE = [I byte, 1 byte, 20 bytes, 4 bytes, 20 bytes] Output: Pp Changes: Pp, RL 10 The SetPermissions command is used to securely update the contents of Pp (containing QA Chip permissions). The WriteAuth command only attempts to replace Pp if the new value is signed combined with our local R. It is only possible to sign messages by knowing Kn. This can be achieved by a call to the SignP 15 command (because only a ChipS can know Kn). It means that without a chip that can be used to produce the required signature, a write of any value to Pp is not possible. The process is very similar to Test, except that if the validation succeeds, the PE input parameter is additionally ORed with the current value for Pp. Note that this is an OR, and not a replace. Since the 20 SetParms command only sets bits in Pp, the effect is to allow the permission bits corresponding to M[n] to progress from RW to either MSR, NMSR, or RO. The SetPermissions command is implemented with the following steps: Wait for MinTicksRemaining to become 0 25 Loop through all of Flash, reading each word (will trigger checks) Accept n Restrict n to N Accept p 30 Restrict p to T+N Accept RE Accept PE SIGL <- SK.[RLI RIPE C 2 ] # calculation must take constant time Accept SIGE 35 If (SIGE = SIG) Update RL P, + P, v P WO 2004/050369 PCT/AU2003/001616 748 EndIf Output Pp # success or failure will be determined by receiver MinTicksRemaining +- MinTicks 15.1.10 ReplaceKey 5 Input: n, RE, V, SIGE = [I byte, 20 bytes, 20 bytes, 20 bytes] Output: Boolean (0x76=failure, ox89 =success) Changes:Kn, ML, RL . The ReplaceKey command is used to replace the specified key in the QA Chip flash memory. However Kn can only be replaced if the previous value is known. A return byte of 0x89 is produced if 10 the key was successfully updated, while ox76 is returned for failure. A ReplaceKey command consists of the WRA command opcode followed by 0x89, Ox76, and then the appropriate parameters. Note that the new key is not sent in the clear, it is sent encrypted with the signature of Rt, RE and C3 (signed with the old key), The first two input parameters must be 15 verified by generating a signature using the old key. The ReplaceKey command is implemented with the following steps: Loop through all of Flash, reading each word (will trigger checks) Accept n 20 Restrict n to N Accept RE # session key from ChipF Accept V # encrypted key SIG, +- S,,[REIVIC3] 4 calculation must take constant time 25 Accept SIGE If (SIGL = SIGE 2 ) # comparison must take constant time SIGL <- Srn[RLIREJC 3 4 calculation must take constant time Advance RL KE <- SIGL ( V 30 K. <- KE # involves storing (KE RK) and (-,KE ( R,) Output 0x89 4 success Else Output Ox76 4 failure 35 EndIf 15.1.11 SignM Input: n,Rx,RE,ME,SIGE,Mdaired = [1 byte, 20 bytes, 20 bytes, 64 bytes,32 bytes] WO 2004/050369 PCT/AU2003/001616 749 Output: RL, Mnew, SKn[RE I RL I C11 Mnew] = (20 bytes, 64 bytes, 20 bytes] Changes:RL Note: The SignM command is only implemented in ChipS, and not in all QA Chips. The SignM command is used to produce a valid signed M for use in an authenticated write 5 transaction. Only an QA Chip programmed with correct value of Kn can respond correctly to the SignM request. The output bytestream from the SignM command can be fed as the input bytestream to the WriteA command on a different QA Chip. The input bytestream consists of the SMR opcode followed by 1 byte containing the key number to use for generating the signature, 20 bytes of Rx (representing the number passed in as R to ChipU's 10 READ command, i.e. typically 0), the output from the READ command (namely RE, ME, and SIGE), and finally the desired M to write to ChipU. The SignM command only succeeds when SIGE = SK[Rx I RE I C1 ME], indicating that the request was generated from a chip that knows K. This generation and comparison must take the same amount of time regardless of whether the input parameters are correct or not. If the times are not the same, an 15 attacker can gain information about which bits of the supplied signature are incorrect. If the signatures match, then RL is updated to be the next random number in the sequence. Since the SignM function generates signatures, the function must wait for the MinTicksRemaining register to reach 0 before processing takes place. 20 Once all the inputs have been verified, a new memory vector is produced by applying a specially stored P value (eg word 1 of Mo) and Mdesired against ME. Effectively, it is performing a regular Write, but with separate P against someone else's M. The Mnew is signed with an updated Rt (and the passed in RE), and all three values are output (the random number RL, Mnew, and the signature). The 25 time taken to generate this signature must be the same regardless of the inputs. Typically, the SignM command will be acting as a form of consumable command, so that a given ChipS can only generate a given number of signatures. The actual number can conveniently be stored in Mo (eg word 0 of Mo) with ReadOnly permissions. Of course another chip could perform an 30 Authorised write to update the number (using another ChipS) should it be desired. The SignM command is implemented with the following steps: Wait for MinTicksRemaining to become 0 Loop through all of Flash, reading each word (will trigger checks) 35 Accept n Restrict n to N WO 2004/050369 PCT/AU2003/001616 750 Accept Rx # don't care what this number is Accept RE Accept ME SIG, +- Sza[RxIREIC2ME] # calculation must take constant time 5 Accept SIGE Accept Mdesired If ((SIGE SIGL) OR (ML[0] = 0)) # fail if bad signature or if allowed sigs = 0 Output appropriate number of 0 # report failure 10 Done Endlf Update RL 15 # Create the new version of M in ram from W and Permissions # This is the same as the core process of Write function # except that we don't write the results back to M DecEncountered <- 0 EqEncountered +- 0 20 Permissions = Mll)# assuming Mo contains appropriate permissions For n +- msw to lsw #(word 15 to 0) AM +- Permissions [n] LT +- (Mdesired [n] < ME [n] ) # comparison is unsigned 25 EQ <- (Mdesired [n] = ME [n] ) WE <- (AM = RW) v ( (AM = MSR) A LT) v ((AM = NMSR) A (DecEncountered v LT)) DecEncountered +- ((AM = MSR) A LT) v ((AM = NMSR) A DecEncountered) 30 v ((AM = NMSR) A EqEncountered A LT) EqEncountered +- ((AM = MSR) A EQ) v ((AM = NMSR) A EqEncountered A EQ) If (-WE) A (ME En] : Mdesired En] Output appropriate number of 0 # report failure 35 Endlf EndFor WO 2004/050369 PCT/AU2003/001616 751 4 At this point, Mdesired is correct Output RL Output Mdesitred # Mesired is now effectively Mnew 5 Sig +- Sxn [R, I RI Ci Mesired] 4 calculation must take constant time MinTicksRemaining <- MinTicks Decrement ML[01 4 reduce the number of allowable signatures by 1 Output Sig 10 15.1.12 SignP Input: n,REPdesired = [1 byte, 20 bytes, 4 bytes] Output: RL, SKn[RE I RL PdesiredjC2] = [20 bytes, 20 bytes] Changes:RL Note: The SignP command is only implemented in ChipS, and not in all QA Chips. 15 The SignP command is used to produce a valid signed P for use in a SetPermissions transaction. Only an QA Chip programmed with correct value of Kn can respond correctly to the SignP request. The output bytestream from the SignP command can be fed as the input bytestream to the SetPermissions command on a different QA Chip. 20 The input bytestream consists of the SMP opcode followed by 1 byte containing the key number to use for generating the signature, 20 bytes of RE (representing the number obtained from ChipU's RND command, and finally the desired P to write to ChipU. 25 Since the SignP function generates signatures, the function must wait for the MinTicksRemaining register to reach 0 before processing takes place. Once all the inputs have been verified, the Pdesired is signed with an updated RL (and the passed in RE), and both values are output (the random number RL and the signature). The time taken to 30 generate this signature must be the same regardless of the inputs. Typically, the SignP command will be acting as a form of consumable command, so that a given ChipS can only generate a given number of signatures. The actual number can conveniently be stored in Mo (eg word 0 of Mo) with ReadOnly permissions. Of course another chip could perform an 35 Authorised write to update the number (using another ChipS) should it be desired. The SignM command is implemented with the following steps: WO 2004/050369 PCT/AU2003/001616 752 Wait for MinTicksRemaining to become o Loop through all of Flash, reading each word (will trigger checks) Accept n 5 Restrict n to N Accept RE Accept Pdesired If (ML[0] = 0) # fail if allowed sigs = 0 Output appropriate number of 0 # report failure 10 Done EndIf Update RL Output RL 15 Sig <- Syj[RERLPdesiredC 2 ] # calculation must take constant time MinTicksRemaining <- MinTicks Decrement ML[0] # reduce the number of allowable signatures by 1 Output Sig 20 15.1.13 Test Input: n, RE, ME, SIGE = [I byte, 20 bytes, 64 bytes, 20 bytes] Output: Boolean (o x7 6=failure, oxs9 = success) Changes:RL 25 The Test command is used to authenticate a read of an M from a non-trusted QA Chip. The Test command consists of the TST command opcode followed by input parameters: n, RE, ME, and SIGE. The byte order is least significant byte to most significant byte for each command 30 component. All but the first input parameter bytes are obtained as the output bytes from a Read command to a non-trusted QA Chip. The entire data does not have to be stored by the client. Instead, the bytes can be passed directly to the trusted QA Chip's Test command, and only M should be kept from the Read. 35 Calls to Test must wait for the MinTicksRemaining register to reach 0. SK(RLREC1JMEj is then calculated, and compared against the input signature SIGE. If they are different, RL is not changed, and 0x76 is returned to indicate failure. If they are the same, then RL is WO 2004/050369 PCT/AU2003/001616 753 updated to be the next random number in the sequence and o x89 is returned to indicate success. Updating RL only after success forces the caller to use a new random number (via the Random command) each time a successful authentication is performed. 5 The calculation of SKn[RLIREIC11ME] and the comparison against SIGE must take identical time so that the time to evaluate the comparison in the TST function is always the same. Thus no attacker can compare execution times or number of bits processed before an output is given. The Test command is implemented with the following steps: 10 Wait for MinTicksRemaining to become 0 Loop through all of Flash, reading each word (will trigger checks) Accept n Restrict n to N 15 Accept RE Accept ME SIGy +- S [R RE I Ci I ME] # calculation must take constant time Accept SIGE If (SIGE = SIGL) 20 Update RL Output 0x89 # success Else Output Ox76 # report failure EndIf 25 MinTicksRemaining +- MinTicks 15.1.14 Write Input: t, Mnew, SIGE = [1 byte, 64 bytes, 20 bytes] Output: Boolean (ox76=failure, ox89 = success) Changes:Mt 30 The Write command is used to update Mt according to the permissions in Pt. The WR command by itself is not secure, since a clone QA Chip may simply return success every time. Therefore a Write command should be followed by an authenticated read of Mt (e.g. via a Read command) to ensure that the change was actually made. The Write command is called by passing the WR command opcode followed by which M to be 35 updated, the new data to be written to M, and a digital signature of M. The data is sent least significant byte to most significant byte.
WO 2004/050369 PCT/AU2003/001616 754 The ability to write to a specific 32-bit word within Mt is governed by the corresponding Permissions bits as stored in Pt. Pt can be set using the SetPermissions command. The fact that Mt is Flash memory must be taken into account when writing the new value to M. It is possible for an attacker to remove power at any time. In addition, only the changes to M should be 5 stored for maximum utilization. In addition, the longevity of M will need to be taken into account. This may result in the location of M being updated. The signature is not keyed, since it must be generated by the consumable user. The Write command is implemented with the following steps: Loop through all of Flash, reading each word (will trigger checks) 10 Accept t Restrict t to T Accept ME new M Accept SIGE 15 SIGL = Generate SHA1 [ME] If (SIGL = SIGE) output Ox76 # failure due to invalid signature exit EndIf 20 DecEncountered <- 0 EqEncountered <- 0 For i <- msw to lsw #(word 15 to 0) P <- Pt [i] LT <- (ME [i] < Mt [il ) # comparison is unsigned 25 EQ +- (ME [i] Mt [i] ) WE <- (P = RW) v ((P = MSR) A LT) V ((P = NMSR) A (DecEncountered V LT)) DecEncountered +- ((P = MSR) A LT) v ((P = NMSR) A DecEncountered) 30 V ((P = NMSR) A EqEncountered A LT) EqEncountered <- ( (P = MSR) A EQ) v ( (P = NMSR) A EqEncountered A EQ) If (-,WE) A (ME [i] # M [i]) 35 output Ox76 # failure due to wanting a change but not allowed it WO 2004/050369 PCT/AU2003/001616 755 Endlf EndFor # At this point, ME (desired) is correct to be written to the 5 flash Mt <- ME 4 update flash output Ox89 * success 15.1.15 WriteAuth Input: n, RE, ME, SIGE = [I byte, 20 bytes, 64 bytes, 20 bytes) 10 Output: Boolean (Ox76=failure, Ox89 = success) Changes:Mo, RL The WriteAuth command is used to securely replace the entire contents of Mo (containing QA Chip application specific data) according to the PTn. The WriteAuth command only attempts to replace Mo if the new value is signed combined with our local R. 15 It is only possible to sign messages by knowing Kn. This can be achieved by a call to the SignM command (because only a ChipS can know Kn). It means that without a chip that can be used to produce the required signature, a write of any value to Mo is not possible. The process is very similar to Write, except that if the validation succeeds, the ME input parameter is processed against Mo using permissions PT". 20 The WriteAuth command is implemented with the following steps: Wait for MinTicksRemaining to become 0 Loop through all of Flash, reading each word (will trigger checks) Accept n 25 Restrict n to N Accept RE Accept ME SIG, +- Sj[R|R|CdME # calculation must take constant time Accept SIGE 30 If (SIGE = SIG,) Update RL DecEncountered <- 0 EqEncountered <- 0 For i +- msw to lsw #(word 15 to 0) 35 P <- pTji] LT <- (ME [iJ < Mo[iJ) # comparison is unsigned EQ <- (ME [i] = Mo[il) WO 2004/050369 PCT/AU2003/001616 756 WE +- (P = RW) V ((P = MSR) A LT) v ((P =NMSR) A (DecEncountered V LT)) DecEncountered +- ((P = MSR) A LT) V ((P = NMSR) A DecEncountered) 5 V ((P = NMSR) A EqEncountered A LT) EqEncountered <- ((P = MSR) A EQ) V ((P = NMSR) A EqEncountered A EQ) If ((,WE) A (ME[ij # Mo[i])) output Ox76 # failure due to wanting a change but not 10 allowed it EndIf EndFor # At this point, ME (desired) is correct to be written to the flash 15 MO +- ME # update flash output Ox89 success Endlf MinTicksRemaining <- MinTicks 16 Manufacture 20 This chapter makes some general comments about the manufacture and implementation of authentication chips. While the comments presented here are general, see [84] for a detailed description of an implementation of an authentication chip. The authentication chip algorithms do not constitute a strong encryption device. The net effect is that they can be safely manufactured in any country (including the USA) and exported to anywhere 25 in the world. The circuitry of the authentication chip must be resistant to physical attack. A summary of manufacturing implementation guidelines is presented, followed by specification of the chip's physical defenses (ordered by attack). Note that manufacturing comments are in addition to any legal protection undertaken, such as 30 patents, copyright, and license agreements (for example, penalties if caught reverse engineering the authentication chip). 16.1 GUIDELINES FOR MANUFACTURING The following are general guidelines for implementation of an authentication chip in terms of manufacture (see [84] for a detailed description of an authentication chip). No special security is 35 required during the manufacturing process. . Standard process WO 2004/050369 PCT/AU2003/001616 757 e Minimum size (if possible) * Clock Filter e Noise Generator * Tamper Prevention and Detection circuitry 5 * Protected memory with tamper detection e Boot circuitry for loading program code * Special implementation of FETs for key data paths e Data connections in polysilicon layers where possible 1 OverUnderPower Detection Unit 10 * No test circuitry * Transparent epoxy packaging Finally, as a general note to manufacturers of Systems, the data line to the System authentication chip and the data line to the Consumable authentication chip must not be the same line. See Section 16.2.3 on page 763. 15 16.1.1 Standard Process The authentication chip should be implemented with a standard manufacturing process (such as Flash). This is necessary to: e allow a great range of manufacturing location options e take advantage of well-defined and well-behaved technology 20 * reduce cost Note that the standard process still allows physical protection mechanisms. 16.1.2 Minimum size The authentication chip must have a low manufacturing cost in order to be included as the authentication mechanism for low cost consumables. It is therefore desirable to keep the chip size 25 as low as reasonably possible. Each authentication chip requires 962 bits of non-volatile memory. In addition, the storage required for optimized HMAC-SHA1 is 1024 bits. The remainder of the chip (state machine, processor, CPU or whatever is chosen to implement Protocol C1) must be kept to a minimum in order that the number of transistors is minimized and thus the cost per chip is minimized. The circuit areas that 30 process the secret key information or could reveal information about the key should also be minimized (see Section 16.1.8 on page 761 for special data paths). 16.1.3 Clock Filter The authentication chip circuitry is designed to operate within a specific clock speed range. Since the user directly supplies the clock signal, it is possible for an attacker to attempt to introduce race 35 conditions in the circuitry at specific times during processing. An example of this is where a high clock speed (higher than the circuitry is designed for) may prevent an XOR from working properly, WO 2004/050369 PCT/AU2003/001616 758 and of the two inputs, the first may always be returned. These styles of transient fault attacks can be very efficient at recovering secret key information, and have been documented in [5] and [1]. The lesson to be learned from this is that the input clock signal cannot be trusted. Since the input clock signal cannot be trusted, it must be limited to operate up to a maximum 5 frequency. This can be achieved a number of ways. One way to filter the clock signal is to use an edge detect unit passing the edge on to a delay, which in turn enables the input clock signal to pass through. Figure 348 shows clock signal flow within the Clock Filter. The delay should be set so that the maximum clock speed is a particular frequency (e.g. about 4 10 MHz). Note that this delay is not programmable - it is fixed. The filtered clock signal would be further divided internally as required. 16.1.4 Noise Generator Each authentication chip should contain a noise generator that generates continuous circuit noise. The noise will interfere with other electromagnetic emissions from the chip's regular activities and 15 add noise to the ldd signal. Placement of the noise generator is not an issue on an authentication chip due to the length of the emission wavelengths. The noise generator is used to generate electronic noise, multiple state changes each clock cycle, and as a source of pseudo-random bits for the Tamper Prevention and Detection circuitry (see Section 16.1.5 on page 758). 20 A simple implementation of a noise generator is a 64-bit maximal period LFSR seeded with a non zero number. The clock used for the noise generator should be running at the maximum clock rate for the chip in order to generate as much noise as possible. 16.1.5 Tamper Prevention and Detection circuitry A set of circuits is required to test for and prevent physical attacks on the authentication chip. 25 However what is actually detected as an attack may not be an intentional physical attack. It is therefore important to distinguish between these two types of attacks in an authentication chip: e where you can be certain that a physical attack has occurred. * where you cannot be certain that a physical attack has occurred. The two types of detection differ in what is performed as a result of the detection. In the first case, 30 where the circuitry can be certain that a true physical attack has occurred, erasure of Flash memory key information is a sensible action. In the second case, where the circuitry cannot be sure if an attack has occurred, there is still certainly something wrong. Action must be taken, but the action should not be the erasure of secret key information. A suitable action to take in the second case is a chip RESET. If what was detected was an attack that has permanently damaged the chip, the 35 same conditions will occur next time and the chip will RESET again. If, on the other hand, what was detected was part of the normal operating environment of the chip, a RESET will not harm the key.
WO 2004/050369 PCT/AU2003/001616 759 A good example of an event that circuitry cannot have knowledge about, is a power glitch. The glitch may be an intentional attack, attempting to reveal information about the key. It may, however, be the result of a faulty connection, or simply the start of a power-down sequence. It is therefore best to only RESET the chip, and not erase the key. If the chip was powering down, nothing is lost. 5 If the System is faulty, repeated RESETs will cause the consumer to get the System repaired. In both cases the consumable is still intact. A good example of an event that circuitry can have knowledge about, is the cutting of a data line within the chip. If this attack is somehow detected, it could only be a result of a faulty chip (manufacturing defect) or an attack. In either case, the erasure of the secret information is a 10 sensible step to take. Consequently each authentication chip should have 2 Tamper Detection Lines - one for definite attacks, and one for possible attacks. Connected to these Tamper Detection Lines would be a number of Tamper Detection test units, each testing for different forms of tampering. In addition, we want to ensure that the Tamper Detection Lines and Circuits themselves cannot also be tampered 15 with. At one end of the Tamper Detection Line is a source of pseudo-random bits (clocking at high speed compared to the general operating circuitry). The Noise Generator circuit described above is an adequate source. The generated bits pass through two different paths -one carries the original data, and the other carries the inverse of the data. The wires carrying these bits are in the layer 20 above the general chip circuitry (for example, the memory, the key manipulation circuitry etc.). The wires must also cover the random bit generator. The bits are recombined at a number of places via an XOR gate. If the bits are different (they should be), a 1 is output, and used by the particular unit (for example, each output bit from a memory read should be ANDed with this bit value). The lines finally come together at the Flash memory Erase circuit, where a complete erasure is triggered by a 25 0 from the XOR. Attached to the line is a number of triggers, each detecting a physical attack on the chip. Each trigger has an oversize nMOS transistor attached to GND. The Tamper Detection Line physically goes through this nMOS transistor. If the test fails, the trigger causes the Tamper Detect Line to become 0. The XOR test will therefore fail on either this clock cycle or the next one (on average), thus RESETing or erasing the chip. 30 Figure 349 illustrates the basic principle of a Tamper Detection Line in terms of tests and the XOR connected to either the Erase or RESET circuitry. The Tamper Detection Line must go through the drain of an output transistor for each test, as illustrated by Figure 350: It is not possible to break the Tamper Detect Line since this would stop the flow of 1s and Os from 35 the random source. The XOR tests would therefore fail. As the Tamper Detect Line physically passes through each test, it is not possible to eliminate any particular test without breaking the Tamper Detect Line.
WO 2004/050369 PCT/AU2003/001616 760 It is important that the XORs take values from a variety of places along the Tamper Detect Lines in order to reduce the chances of an attack. Figure 351 illustrates the taking of multiple XORs from the Tamper Detect Line to be used in the different parts of the chip. Each of these XORs can be considered to be generating a ChipOK bit that can be used within each unit or sub-unit. 5 A sample usage would be to have an OK bit in each unit that is ANDed with a given ChipOK bit each cycle. The OK bit is loaded with 1 on a RESET. If OK is 0, that unit will fail until the next RESET. If the Tamper Detect Line is functioning correctly, the chip will either RESET or erase all key information. If the RESET or erase circuitry has been destroyed, then this unit will not function, thus thwarting an attacker. 10 The destination of the RESET and Erase line and associated circuitry is very context sensitive. It needs to be protected in much the same way as the individual tamper tests. There is no point generating a RESET pulse if the attacker can simply cut the wire leading to the RESET circuitry. The actual implementation will depend very much on what is to be cleared at RESET, and how those items are cleared. 15 Finally, Figure 352 shows how the Tamper Lines cover the noise generator circuitry of the chip. The generator and NOT gate are on one level, while the Tamper Detect Lines run on a level above the generator. 16.1.6 Protected memory with tamper detection It is not enough to simply store secret information or program code in Flash memory. The Flash 20 memory and RAM must be protected from an attacker who would attempt to modify (or set) a particular bit of program code or key information. The mechanism used must conform to being used in the Tamper Detection Circuitry (described above). The first part of the solution is to ensure that the Tamper Detection Line passes directly above each Flash or RAM bit. This ensures that an attacker cannot probe the contents of Flash or RAM. A 25 breach of the covering wire is a break in the Tamper Detection Line. The breach causes the Erase signal to be set, thus deleting any contents of the memory. The high frequency noise on the Tamper Detection Line also obscures passive observation. The second part of the solution for Flash is to use multi-level data storage, but only to use a subset of those multiple levels for valid bit representations. Normally, when multi-level Flash storage is 30 used, a single floating gate holds more than one bit. For example, a 4-voltage-state transistor can represent two bits. Assuming a minimum and maximum voltage representing 00 and 11 respectively, the two middle voltages represent 01 and 10. In the authentication chip, we can use the two middle voltages to represent a single bit, and consider the two extremes to be invalid states. If an attacker attempts to force the state of a bit one way or the other by closing or cutting 35 the gate's circuit, an invalid voltage (and hence invalid state) results. The second part of the solution for RAM is to use a parity bit. The data part of the register can be checked against the parity bit (which will not match after an attack).
WO 2004/050369 PCT/AU2003/001616 761 The bits coming from Flash and RAM can therefore be validated by a number of test units (one per bit) connected to the common Tamper Detection Line. The Tamper Detection circuitry would be the first circuitry the data passes through (thus stopping an attacker from cutting the data lines). While the multi-level Flash protection is enough for non-secret information, such as program code, 5 R, and MinTicks, it is not sufficient for protecting K 1 and K 2 . If an attacker adds electrons to a gate (see Section 5.7.2.15 on page 683) representing a single bit of K 1 , and the chip boots up yet doesn't activate the Tamper Detection Line, the key bit must have been a 0. If it does activate the Tamper Detection Line, it must have been a 1. For this reason, all other non-volatile memory can activate the Tamper Detection Line, but K 1 and K 2 must not. Consequently Checksum is used to 10 check for tampering of K 1 and K 2 .A signature of the expanded form of K 1 and K 2 (i.e. 320 bits instead of 160 bits for each of K 1 and K 2 ) is produced, and the result compared against the Checksum. Any non-match causes a clear of all key information. 16.1.7 Boot circuitry for loading program code Program code should be kept in multi-level Flash instead of ROM, since ROM is subject to being 15 altered in a non-testable way. A boot mechanism is therefore required to load the program code into Flash memory (Flash memory is in an indeterminate state after manufacture). The boot circuitry must not be in ROM - a small state-machine would suffice. Otherwise the boot code could be modified in an undetectable way. The boot circuitry must erase all Flash memory, check to ensure the erasure worked, and then load 20 the program code. Flash memory must be erased before loading the program code. Otherwise an attacker could put the chip into the boot state, and then load program code that simply extracted the existing keys. The state machine must also check to ensure that all Flash memory has been cleared (to ensure that an attacker has not cut the Erase line) before loading the new program code. 25 The loading of program code must be undertaken by the secure Programming Station before secret information (such as keys) can be loaded. This step must be undertaken as the first part of the programming process. 16.1.8 Special implementation of FETs for key data paths The normal situation for FET implementation for the case of a CMOS Inverter (which involves a 30 pMOS transistor combined with an nMOS transistor) as shown in Figure 353: During the transition, there is a small period of time where both the nMOS transistor and the pMOS transistor have an intermediate resistance. The resultant power-ground short circuit causes a temporary increase in the current, and in fact accounts for the majority of current consumed by a CMOS device. A small amount of infrared light is emitted during the short circuit, and can be viewed 35 through the silicon substrate (silicon is transparent to infrared light). A small amount of light is also emitted during the charging and discharging of the transistor gate capacitance and transmission line capacitance.
WO 2004/050369 PCT/AU2003/001616 762 For circuitry that manipulates secret key information, such information must be kept hidden. An alternative non-flashing CMOS implementation should therefore be used for all data paths that manipulate the key or a partially calculated value that is based on the key. The use of two non-overlapping clocks 1 and 42 can provide a non-flashing mechanism. $1 is 5 connected to a second gate of all nMOS transistors, and 42 is connected to a second gate of all pMOS transistors. The transition can only take place in combination with the clock. Since #1 and #2 are non-overlapping, the pMOS and nMOS transistors will not have a simultaneous intermediate resistance. The setup is shown in Figure 354: Finally, regular CMOS inverters can be positioned near critical non-Flashing CMOS components. 10 These inverters should take their input signal from the Tamper Detection Line above. Since the Tamper Detection Line operates multiple times faster than the regular operating circuitry, the net effect will be a high rate of light-bursts next to each non-Flashing CMOS component. Since a bright light overwhelms observation of a nearby faint light, an observer will not be able to detect what switching operations are occurring in the chip proper. These regular CMOS inverters will also 15 effectively increase the amount of circuit noise, reducing the SNR and obscuring useful EMI. There are a number of side effects due to the use of non-Flashing CMOS: * The effective speed of the chip is reduced by twice the rise time of the clock per clock cycle. This is not a problem for an authentication chip. * The amount of current drawn by the non-Flashing CMOS is reduced (since the short circuits 20 do not occur). However, this is offset by the use of regular CMOS inverters. * Routing of the clocks increases chip area, especially since multiple versions of $1 and 42 are required to cater for different levels of propagation. The estimation of chip area is double that of a regular implementation. " Design of the non-Flashing areas of the authentication chip are slightly more complex than to 25 do the same with a with a regular CMOS design. In particular, standard cell components cannot be used, making these areas full custom. This is not a problem for something as small as an authentication chip, particularly when the entire chip does not have to be protected in this manner. 16.1.9 Connections in polysilicon layers where possible 30 Wherever possible, the connections along which the key or secret data flows, should be made in the polysilicon layers. Where necessary, they can be in metal 1, but must never be in the top metal layer (containing the Tamper Detection Lines). 16.1.10 OverUnderPower Detection Unit Each authentication chip requires an OverUnderPower Detection Unit to prevent Power Supply 35 Attacks. An OverUnderPower Detection Unit detects power glitches and tests the power level against a Voltage Reference to ensure it is within a certain tolerance. The Unit contains a single WO 2004/050369 PCT/AU2003/001616 763 Voltage Reference and two comparators. The OverUnderPower Detection Unit would be connected into the RESET Tamper Detection Line, thus causing a RESET when triggered. A side effect of the OverUnderPower Detection Unit is that as the voltage drops during a power down, a RESET is triggered, thus erasing any work registers. 5 16.1.11 No test circuitry Test hardware on an authentication chip could very easily introduce vulnerabilities. As a result, the authentication chip should not contain any BIST or scan paths. The authentication chip must therefore be testable with external test vectors. This should be possible since the authentication chip is not complex. 10 16.1.12 Transparent epoxy packaging The authentication chip needs to be packaged in transparent epoxy so it can be photo-imaged by the programming station to prevent Trojan horse attacks. The transparent packaging does not compromise the security of the authentication chip since an attacker can fairly easily remove a chip from its packaging. For more information see Section 16.2.20 on page 770 and [861. 15 16.2 RESISTANCE To PHYSICAL ATTACKS While this chapter only describes manufacture in general terms (since this document does not cover a specific implementation of a Protocol C1 authentication chip), we can still make some observations about such a chip's resistance to physical attack. A description of the general form of each physical attack can be found in Section 5.7.2 on page 679. 20 16.2.1 Reading ROM This attack depends on the key being stored in an addressable ROM. Since each authentication chip stores its authentication keys in internal Flash memory and not in an addressable ROM, this attack is irrelevant. 16.2.2 Reverse engineering the chip 25 Reverse engineering a chip is only useful when the security of authentication lies in the algorithm alone. However our authentication chips rely on a secret key, and not in the secrecy of the algorithm. Our authentication algorithm is, by contrast, public, and in any case, an attacker of a high volume consumable is assumed to have been able to obtain detailed plans of the internals of the chip. 30 In light of these factors, reverse engineering the chip itself, as opposed to the stored data, poses no threat. 16.2.3 Usurping the authentication process There are several forms this attack can take, each with varying degrees of success. In all cases, it is assumed that a clone manufacturer will have access to both the System and the consumable 35 designs. An attacker may attempt to build a chip that tricks the System into returning a valid code instead of generating an authentication code. This attack is not possible for two reasons. The first reason is WO 2004/050369 PCT/AU2003/001616 764 that System authentication chips and Consumable authentication chips, although physically identical, are programmed differently. In particular, the RD opcode and the RND opcode are the same, as are the WR and TST opcodes. A System authentication Chip cannot perform a RD command since every call is interpreted as a call to RND instead. The second reason this attack 5 would fail is that separate serial data lines are provided from the System to the System and Consumable authentication chips. Consequently neither chip can see what is being transmitted to or received from the other. If the attacker builds a clone chip that ignores WR commands (which decrement the consumable remaining), Protocol C1 ensures that the subsequent RD will detect that the WR did not occur. The 10 System will therefore not go ahead with the use of the consumable, thus thwarting the attacker. The same is true if an attacker simulates loss of contact before authentication -since the authentication does not take place, the use of the consumable doesn't occur. An attacker is therefore limited to modifying each System in order for clone consumables to be accepted (see Section 16.2.4 on page 764 for details of resistance this attack). 15 16.2.4 Modification of system The simplest method of modification is to replace the System's authentication chip with one that simply reports success for each call to TST. This can be thwarted by System calling TST several times for each authentication, with the first few times providing false values, and expecting a fail from TST. The final call to TST would be expected to succeed. The number of false calls to TST 20 could be determined by some part of the returned result from RD or from the system clock. Unfortunately an attacker could simply rewire System so that the new System clone authentication chip can monitor the returned result from the consumable chip or clock. The clone System authentication chip would only return success when that monitored value is presented to its TST function. Clone consumables could then return any value as the hash result for RD, as the clone 25 System chip would declare that value valid. There is therefore no point for the System to call the System authentication chip multiple times, since a rewiring attack will only work for the System that has been rewired, and not for all Systems. A similar form of attack on a System is a replacement of the System ROM. The ROM program code can be altered so that the Authentication never occurs. There is nothing that can be done about 30 this, since the System remains in the hands of a consumer. Of course this would void any warranty, but the consumer may consider the alteration worthwhile if the clone consumable were extremely cheap and more readily available than the original item. The System/consumable manufacturer must therefore determine how likely an attack of this nature is, Such a study must include given the pricing structure of Systems and Consumables, frequency 35 of System service, advantage to the consumer of having a physical modification performed, and where consumers would go to get the modification performed.
WO 2004/050369 PCT/AU2003/001616 765 The likelihood of physical alteration increases with the perceived artificiality of the consumable marketing scheme. It is one thing for a consumable to be protected against clone manufacturers. It is quite another for a consumable's market to be protected by a form of exclusive licensing arrangement that creates what is viewed by consumers as artificial markets. In the former case, 5 owners are not so likely to go to the trouble of modifying their system to allow a clone manufacturer's goods. In the latter case, consumers are far more likely to modify their System. A case in point is DVD. Each DVD is marked with a region code, and will only play in a DVD player from that region. Thus a DVD from the USA will not play in an Australian player, and a DVD from Japan, Europe or Australia will not play in a USA DVD player. Given that certain DVD titles are not 10 available in all regions, or because of quality differences, pricing differences or timing of releases, many consumers have had their DVD players modified to accept DVDs from any region. The modification is usually simple (it often involves soldering a single wire), voids the owner's warranty, and often costs the owner some money. But the interesting thing to note is that the change is not made so the consumer can use clone consumables - the consumer will still only buy real 15 consumables, but from different regions. The modification is performed to remove what is viewed as an artificial barrier, placed on the consumer by the movie companies. In the same way, a System/Consumable scheme that is viewed as unfair will result in people making modifications to their Systems. The limit case of modifying a system is for a clone manufacturer to provide a completely clone 20 System which takes clone consumables. This may be simple competition or violation of patents. Either way, it is beyond the scope of the authentication chip and depends on the technology or service being cloned. 16.2.5 Direct viewing of chip operation by conventional probing In order to view the chip operation, the chip must be operating. However, the Tamper Prevention 25 and Detection circuitry covers those sections of the chip that process or hold the key. It is not possible to view those sections through the Tamper Prevention lines. An attacker cannot simply slice the chip past the Tamper Prevention layer, for this will break the Tamper Detection Lines and cause an erasure of all keys at power-up. Simply destroying the erasure circuitry is not sufficient, since the multiple ChipOK bits (now all 0) feeding into multiple 30 units within the authentication chip will cause the chip's regular operating circuitry to stop functioning. To set up the chip for an attack, then, requires the attacker to delete the Tamper Detection lines, stop the Erasure of Flash memory, and somehow rewire the components that relied on the ChipOK lines. Even if all this could be done, the act of slicing the chip to this level will most likely destroy the 35 charge patterns in the non-volatile memory that holds the keys, making the process fruitless. 16.2.6 Direct viewing of the non-volatile memory WO 2004/050369 PCT/AU2003/001616 766 If the authentication chip were sliced so that the floating gates of the Flash memory were exposed, without discharging them, then the keys could probably be viewed directly using an STM or SKM. However, slicing the chip to this level without discharging the gates is probably impossible. Using wet etching, plasma etching, ion milling, or chemical mechanical polishing will almost certainly 5 discharge the small charges present on the floating gates. This is true of regular Flash memory, but even more so of multi-level Flash memory. 16.2.7 Viewing the light bursts caused by state changes All sections of circuitry that manipulate secret key information are implemented in the non-Flashing CMOS described above. This prevents the emission of the majority of light bursts. Regular CMOS 10 inverters placed in close proximity to the non-Flashing CMOS will hide any faint emissions caused by capacitor charge and discharge. The inverters are connected to the Tamper Detection circuitry, so they change state many times (at the high clock rate) for each non-Flashing CMOS state change. 16.2.8 Viewing the keys using an SEPM 15 An SEPM attack can be simply thwarted by adding a metal layer to cover the circuitry. However an attacker could etch a hole in the layer, so this is not an appropriate defense. The Tamper Detection circuitry described above will shield the signal as well as cause circuit noise. The noise will actually be a greater signal than the one that the attacker is looking for. If the attacker attempts to etch a hole in the noise circuitry covering the protected areas, the chip will not function, 20 and the SEPM will not be able to read any data. An SEPM attack is therefore fruitless. 16.2.9 Monitoring EMI The Noise Generator described above will cause circuit noise. The noise will interfere with other electromagnetic emissions from the chip's regular activities and thus obscure any meaningful 25 reading of internal data transfers. 16.2.10 Viewing Idd fluctuations The solution against this kind of attack is to decrease the SNR in the ldd signal. This is accomplished by increasing the amount of circuit noise and decreasing the amount of signal. The Noise Generator circuit (which also acts as a defense against EMI attacks) will also cause 30 enough state changes each cycle to obscure any meaningful information in the ldd signal. In addition, the special Non-Flashing CMOS implementation of the key-carrying data paths of the chip prevents current from flowing when state changes occur. This has the benefit of reducing the amount of signal. 16.2.11 Differential fault analysis 35 Differential fault bit errors are introduced in a non-targeted fashion by ionization, microwave radiation, and environmental stress. The most likely effect of an attack of this nature is a change in WO 2004/050369 PCT/AU2003/001616 767 Flash memory (causing an invalid state) or RAM (bad parity). Invalid states and bad parity are detected by the Tamper Detection Circuitry, and cause an erasure of the key. Since the Tamper Detection Lines cover the key manipulation circuitry, any error introduced in the key manipulation circuitry will be mirrored by an error in a Tamper Detection Line. If the Tamper 5 Detection Line is affected, the chip will either continually RESET or simply erase the key upon a power-up, rendering the attack fruitless. Rather than relying on a non-targeted attack and hoping that "just the right part of the chip is affected in just the right way", an attacker is better off trying to introduce a targeted fault (such as overwrite attacks, gate destruction etc.). For information on these targeted fault attacks, see the 10 relevant sections below. 16.2.12 Clock glitch attacks The Clock Filter (described above) eliminates the possibility of clock glitch attacks. 16.2.13 Power supply attacks The OverUnderPower Detection Unit (described above) eliminates the possibility of power supply 15 attacks. 16.2.14 Overwriting ROM Authentication chips store program code, keys and secret information in Flash memory, and not in ROM. This attack is therefore not possible. 16.2.15 Modifying EEPROM/Flash 20 Authentication chips store program code, keys and secret information in multi-level Flash memory. However the Flash memory is covered by two Tamper Prevention and Detection Lines. If either of these lines is broken (in the process of destroying a gate via a laser-cutter) the attack will be detected on power-up, and the chip will either RESET (continually) or erase the keys from Flash memory. This process is described in Section 16.1.6 on page 760. 25 Even if an attacker is able to somehow access the bits of Flash and destroy or short out the gate holding a particular bit, this will force the bit to have no charge or a full charge. These are both invalid states for the authentication chip's usage of the multi-level Flash memory (only the two middle states are valid). When that data value is transferred from Flash, detection circuitry will cause the Erasure Tamper Detection Line to be triggered - thereby erasing the remainder of Flash 30 memory and RESETing the chip. This is true for program code, and non-secret information. As key data is read from multi-level flash memory, it is not imediately checked for validity (otherwise information about the key is given away). Instead, a specific key validation mechanism is used to protect the secret key information. An attacker could theoretically etch off the upper levels of the chip, and deposit enough electrons to 35 change the state of the multi-level Flash memory by 1/3. If the beam is high enough energy it might be possible to focus the electron beam through the Tamper Prevention and Detection Lines. As a result, the authentication chip must perform a validation of the keys before replying to the Random, WO 2004/050369 PCT/AU2003/001616 768 Test or Random commands. The SHA-1 algorithm must be run on the keys, and the results compared against an internal checksum value. This gives an attacker a 1 in 2160 chance of tricking the chip, which is the same chance as guessing either of the keys. A Modify EEPROM/Flash attack is therefore fruitless. 5 16.2.16 Gate destruction attacks Gate Destruction Attacks rely on the ability of an attacker to modify a single gate to cause the chip to reveal information during operation. However any circuitry that manipulates secret information is covered by one of the two Tamper Prevention and Detection lines. If either of these lines is broken (in the process of destroying a gate) the attack will be detected on power-up, and the chip will either 10 RESET (continually) or erase the keys from Flash memory. To launch this kind of attack, an attacker must first reverse-engineer the chip to determine which gate(s) should be targeted. Once the location of the target gates has been determined, the attacker must break the covering Tamper Detection line, stop the Erasure of Flash memory, and somehow rewire the components that rely on the ChipOK lines. Rewiring the circuitry cannot be done without 15 slicing the chip, and even if it could be done, the act of slicing the chip to this level will most likely destroy the charge patterns in the non-volatile memory that holds the keys, making the process fruitless. 16.2.17 Overwrite attack An overwrite attack relies on being able to set individual bits of the key without knowing the 20 previous value. It relies on probing the chip, as in the conventional probing attack and destroying gates as in the gate destruction attack. Both of these attacks (as explained in their respective sections), will not succeed due to the use of the Tamper Prevention and Detection Circuitry and ChipOK lines. However, even if the attacker is able to somehow access the bits of Flash and destroy or short out 25 the gate holding a particular bit, this will force the bit to have no charge or a full charge. These are both invalid states for the authentication chip's usage of the multi-level Flash memory (only the two middle states are valid). When that data value is transferred from Flash detection circuitry will cause the Erasure Tamper Detection Line to be triggered - thereby erasing the remainder of Flash memory and RESETing the chip. In the same way, a parity check on tampered values read from 30 RAM will cause the Erasure Tamper Detection Line to be triggered. An overwrite attack is therefore fruitless. 16.2.18 Memory remanence attack Any working registers or RAM within the authentication chip may be holding part of the 35 authentication keys when power is removed. The working registers and RAM would continue to hold the information for some time after the removal of power. If the chip were sliced so that the WO 2004/050369 PCT/AU2003/001616 769 gates of the registers/RAM were exposed, without discharging them, then the data could probably be viewed directly using an STM. The first defense can be found above, in the description of defense against power glitch attacks. 5 When power is removed, all registers and RAM are cleared, just as the RESET condition causes a clearing of memory. The chances then, are less for this attack to succeed than for a reading of the Flash memory. RAM charges (by nature) are more easily lost than Flash memory. The slicing of the chip to reveal the 10 RAM will certainly cause the charges to be lost (if they haven't been lost simply due to the memory not being refreshed and the time taken to perform the slicing). This attack is therefore fruitless.
WO 2004/050369 PCT/AU2003/001616 770 16.2.19 Chip theft attack There are distinct phases in the lifetime of an authentication chip. Chips can be stolen when at any of these stages: * After manufacture, but before programming of key 5 * After programming of key, but before programming of state data e After programming of state data, but before insertion into the consumable or system * After insertion into the system or consumable A theft in between the chip manufacturer and programming station would only provide the clone manufacturer with blank chips. This merely compromises the sale of authentication chips, not 10 anything authenticated by the authentication chips. Since the programming station is the only mechanism with consumable and system product keys, a clone manufacturer would not be able to program the chips with the correct key. Clone manufacturers would be able to program the blank chips for their own Systems and Consumables, but it would be difficult to place these items on the market without detection. 15 The second form of theft can only happen in a situation where an authentication chip passes through two or more distinct programming phases. This is possible, but unlikely. In any case, the worst situation is where no state data has been programmed, so all of M is read/write. If this were the case, an attacker could attempt to launch an adaptive chosen text attack on the chip. The HMAC-SHA1 algorithm is resistant to such attacks. For more information see Section 14.7 on 20 page 726. The third form of theft would have to take place in between the programming station and the installation factory. The authentication chips would already be programmed for use in a particular system or for use in a particular consumable. The only use these chips have to a thief is to place them into a clone System or clone Consumable. Clone systems are irrelevant - a cloned System 25 would not even require an authentication chip. For clone Consumables, such a theft would limit the number of cloned products to the number of chips stolen. A single theft should not create a supply constant enough to provide clone manufacturers with a cost-effective business. The final form of theft is where the System or Consumable itself is stolen. When the theft occurs at the manufacturer, physical security protocols must be enhanced. If the theft occurs anywhere else, 30 it is a matter of concern only for the owner of the item and the police or insurance company. The security mechanisms that the authentication chip uses assume that the consumables and systems are in the hands of the public. Consequently, having them stolen makes no difference to the security of the keys. 35 16.2.20 Trojan horse attack A Trojan horse attack involves an attacker inserting a fake authentication chip into the programming station and retrieving the same chip after it has been programmed with the secret key information.
WO 2004/050369 PCT/AU2003/001616 771 The difficulty of these two tasks depends on both logical and physical security, but is an expensive attack - the attacker has to manufacture a false authentication chip, and it will only be useful where the effort is worth the gain. For example, obtaining the secret key for a specific car's authentication chip is most likely not worth an attacker's efforts, while the key for a printer's ink cartridge may be 5 very valuable. The problem arises if the programming station is unable to tell a Trojan horse authentication chip from a real one - which is the problem of authenticating the authentication chip. One solution to the authentication problem is for the manufacturer to have a programming station attached to the end of the production line. Chips passing the manufacture QA tests are 10 programmed with the manufacturer's secret key information. The chip can therefore be verified by the C1 authentication protocol, and give information such as the expected batch number, serial number etc. The information can be verified and recorded, and the valid chip can then be reprogrammed with the System or Consumable key and state data. An attacker would have to substitute an authentication chip with a Trojan horse programmed with the manufacturer's secret 15 key information and copied batch number data from the removed authentication chip. This is only possible if the manufacturer's secret key is compromised (the key is changed regularly and not known by a human) or if the physical security at the manufacturing plant is compromised at the end of the manufacturing chain. Even if the solution described were to be undertaken, the possibility of a Trojan horse attack does 20 not go away - it merely is removed to the manufacturer's physical location. A better solution requires no physical security at the manufacturing location. The preferred solution then, is to use transparent epoxy on the chip's packaging and to image the chip before programming it. Once the chip has been mounted for programming it is in a known fixed orientation. It can therefore be high resolution photo-imaged and X-rayed from multiple directions, 25 and the images compared against "signature" images. Any chip not matching the image signature is treated as a Trojan horse and rejected.
WO 2004/050369 PCT/AU2003/001616 772 1 REFILL OF INK IN PRINTERS - Printer based refill device 1.1 FUNCTIONAL PURPOSE The functional purpose of the printer based refill device is as follows: e To refill ink into printers by physically connecting the refill device to the printer. 5 a To ensure that the correct ink is used for the correct operation of the printer (i.e. will not damage the printhead). * To ensure accurate measure of ink is transferred from the refilling device to the printer during refills. * The refill device is controlled by the printer. Apart from the QA Chip 1 the refill device has no other processing power. 10 1.2 BASIC COMPONENTS OF THE REFILL DEVICE Figure 355 shows the components of the printer based refill device. The printer based refill device will consist of following components: " An ink reservoir - which stores the ink. Each refill device will allow ink reservoirs of various capacities. When the ink reservoir empties out, it is replaced by another reservoir containing more ink 15 of the same type or different type or refilled (for example through a refill station as described in Section 2 and Section 3). " An ink output device- which dispenses ink to the printer being refilled when physically connected to the printer. " A QA Chip and associated circuitry - which stores the amount of ink in the reservoir along with the 20 attributes of the ink in a digital format. " The electrical connections to the QA Chip. * NB - No additional microprocessors are required to be present in the refill device. Hence the refill device uses the processing power of the printer to oversee the refilling process. * An ink transfer mechanism (optional) which controls the flow ink from the refill device to the printer 25 and is controlled by the printer. Therefore the control connections for the ink transfer mechanism will be connected to the printer. " Alternatively, the ink transfer mechanism could be in the printer. Refer to Section 1.3. 1.3 PRINTER DESCRIPTION AND FUNCTIONS Printers which will be refilled by these refilling devices must have the following components: 30 * Microprocessor assembly which will control the refill procedure as described Section 1.4. The microprocessor assembly will access the QA Chip and ink transfer mechanism of the refill device. * A QA Chip storing the ink amount remaining in the printer. 'General Note: Througout this document, if secure refilling is required then a physical QA Chip or any other virtual device performing the QA Chip protocol can be used. Refer to [1].
WO 2004/050369 PCT/AU2003/001616 773 An optional ink transfer mechanism to control the flow of ink from the refill device to the printer. This ink transfer mechanism must be present in the printer if the refill device doesn't have one of its own. 1.4 OPERATIONAL PROCEDURE The operational procedure can be divided into two parts: 5 9 Refilling printers using the refill device. 0 Refilling of the ink reservoir in the refill device . See Section 2 and Section 3. 1.4.1 Refilling of printers Figure 356 shows a printer being refilled by a printer based refill device. The ink transfer mechanism is located in the printer in this case. The ink transfer mechanism could be also located in the refill device as 10 described in Section 1.2. The following is a description for refilling of printers using the printer based refill device: * Ink output device from the refilling device is connected to the printer. * The QA Chip electrical connection is connected to the printer. e The refill option is selected on the user interface of the printer. The microprocessor assembly in the 15 printer will then do the following: a. Read ink attributes (for example ink type, ink characteristics, ink colour, ink manufacturer etc) stored in the QA Chip of the ink reservoir unit. Refer to[1]. b. Compare the ink attributes as required by the printer for correct operation. This may require reading of data from the QA Chip in the printer. , 20 c. Only if Step b is successful, then do the following: i. Determine the amount of ink to be transferred by any or all of the following means, ensuring that the reservoir has enough ink for the transfer: e Fixed amount (e.g. based on a pre-programmed value or printer model). e User-selectable amount. 25 ii. Decrement the amount of ink transferred from the QA Chip in the refill station and increment the QA Chip in the printer (which stores the amount of ink in the printer) with corresponding ink amount. iii. Command the ink transfer mechanism to release the ink to the printer through the output device. 2 Home use refill station 2.1 FUNCTIONAL PURPOSE 30 The functional purpose of the commercial refill station is as follows: e To refill ink into ink cartridges at home or in a small office. * Single ink cartridge is filled at a time. * To ensure that the correct ink present in the refill station is transferred to the correct ink cartridge. * To ensure accurate measure of ink is transferred from the refilling station to the ink cartridge during 35 refills. * The refilling station provides the processing power required to perform refills of ink cartridges. 2.2 BASIC COMPONENTS WO 2004/050369 PCT/AU2003/001616 774 Figure 357 shows the components of a home refill station. A home refill station will consist of one of the following ink refill units: * A single reservoir ink refill unit suitable for black ink (or any other single colour). * A multi reservoir ink refill unit suitable for coloured ink for example CMY (Cyan, Magenta, Yellow). 5 2.2.1 Ink reservoir unit Figure 358 shows the components of a three-ink reservoir unit. The ink reservoir unit will consist of the following: * Multiple ink reservoirs or a single ink reservoir which stores ink. Each refill station will allow ink reservoirs of various capacities. When the ink reservoir empties out, it is replaced by another reservoir 10 containing more ink of the same or different type or refilled (for example through a refill station as described in Section 3). " A QA Chip and associated circuitry in each of the ink reservoirs - which stores the amount of ink in the reservoir along with the attributes of the ink. * The electrical connections to each of the QA Chips. 15 2.2.2 Ink transfer unit The ink reservoir unit will consist of the following: * Ink output device from each ink reservoir. * The output ink transfer mechanism controls the flow ink from the ink refill unit to the ink cartridge and is controlled by the microprocessor assembly. 20 e Final ink output devices to the cartridge interface assembly 2.2.3 Cartridge interface unit This unit will provide the physical interface to the ink cartridges. Each ink cartridge interface unit will hold a single or multiple cartridges of particular physical dimension. The cartridge interface unit can removed from the ink refill unit and replaced with another interface unit to 25 cater for other physically different cartridges. 2.2.4 Microprocessor assembly The controls connections for the ink transfer mechanism and the electrical connections of the QA Chip are connected to the microprocessor assembly. The microprocessor assembly oversees and controls the refill process. 30 The microprocessor assembly will communicate with a user interface to accept commands and provide responses for various refill operations. 2.3 INK CARTRIDGE DESCRIPTION Ink cartridges which will be refilled in a home refill station must have a QA Chip storing the following components: 35 * Ink amount remaining. * Ink attributes (for example - ink type, ink characteristics, ink colour, ink manufacturer). 2.4 OPERATIONAL PROCEDURE WO 2004/050369 PCT/AU2003/001616 775 The operational procedure can be divided into two parts: e Refilling of ink cartridges using the home refill station. * Refilling the ink reservoirs used in the refill station is discussed in Section 3. 2.5 REFILLING OF INK CARTRIDGES USING THE HOME REFILL STATION 5 Figure 359 shows the refill of ink cartridges in a home refill station. The following is a description for refilling of ink cartridges in the home refill station: " Load the ink cartridge into the cartridge interface unit of the ink refill unit. This will connect the QA Chip of the ink cartridge to the microprocessor assembly. It will also connect the ink output device of the ink refill unit to the ink cartridge. 10 e The model number of the ink cartridge is read from the QA Chip by the microprocessor assembly controlling the ink refill units. e The microprocessor assembly will determine whether the ink refill unit is suitable for the ink cartridge model. e The refill option is selected on the microprocessor assembly through the user interface. The 15 microprocessor assembly will then do the following: a. Read ink attributes (for example ink type, ink characteristics, ink colour, ink manufacturer etc) stored in the QA Chip of the ink cartridge. Refer to[1]. b. Compare the read ink attributes to the ink attribute list in the refill station.This may also require reading of the ink attributes stored in the QA Chip of the ink reservoirs in the refill unit. 20 c. Only if Step b is successful, then do the following: i. Determine the amount of ink to be transferred by any or all of the following means, ensuring that the reservoir has enough ink for the transfer: e Fixed amount (e.g. based on a pre-programmed value ,cartridge model or reservoir type). * User-selectable amount. 25 ii. Check the ink reservoir in the ink refill unit has adequate amount of ink to refill the ink cartridge iii. Decrement the amount of ink transferred from the QA Chip in the ink refill unit and increment the QA Chip in the ink cartridge with corresponding ink amount. iv. If incrementing of the QA Chip with ink amount is successful then a command is sent to the ink transfer mechanism to release the ink to the ink cartridge through the output device. 30 3 Commercial refill station 3.1 FUNCTIONAL PURPOSE The functional purpose of the commercial refill station is as follows: e To refill ink into ink cartridges that are taken to the refill station for refilling. * Multiple ink cartridges of different models can be refilled. 35 e To ensure that the correct ink present in the refill station is transferred to the ink cartridge. * To ensure accurate measure of ink is transferred from the refilling station to the ink cartridge during refills.
WO 2004/050369 PCT/AU2003/001616 776 The refilling station provides all processing power required to perform refills of ink cartridges. 3.2 BASIC COMPONENTS OF THE REFILL STATION Figure 360 shows the components of a commercial refill station. A commercial refill station will consist of multiple ink refill units controlled by a single microprocessor 5 assembly. Each ink refill unit can refill a single ink cartridge at a time. Each ink refill unit will consist of the following sub units: * Ink reservoir unit * Switch unit * Ink transfer unit 10 e Multiple cartridge interface unit 3.2.1 Ink reservoir unit Figure 361 shows the components of a ink reservoir unit. The ink reservoir unit will consist of the following: 15 * Multiple ink reservoirs - which stores ink. Each refill device will allow ink reservoirs of various capacities. When the ink reservoir empties out, it is replaced by another reservoir containing more ink of the same or different type or refilled. Refer to Section 3.5. 0 A QA Chip and associated circuitry in each of the ink reservoirs - which stores the amount of ink in the reservoir along with the attributes of the ink in digital format. 20 9 The electrical connections of each of the QA Chips are connected to the microprocessor assembly. 3.2.2 Switch unit This unit will switch the inks selected from different ink reservoirs to the ink transfer unit to be dispensed into ink cartridges. The switch unit will prevent mixing of any residual ink left in dispensing devices after each ink cartridge is 25 refilled. 3.2.3 Ink transfer unit The ink reservoir unit will consist of the following: * Ink output device from each ink reservoir. * An output ink transfer mechanism which controls the flow ink from the ink refill unit to the ink 30 cartridge and is controlled by the microprocessor assembly. * Final ink output devices to the multiple cartridge interface assembly 3.2.4 Multiple cartridge interface unit This unit will provide the physical interface to the ink cartridges. Each ink cartridge interface will hold cartridges of different physical dimensions. 35 Each cartridge interface unit can provide an interface for about 20 physically different cartridges. The cartridge interface unit can removed from the ink refill unit and replaced with another interface unit to cater for other physically different cartridges.
WO 2004/050369 PCT/AU2003/001616 777 3.2.5 Microprocessor assembly with a user interface The controls connections for the ink transfer mechanism and the electrical connections of the QA Chip are connected to the microprocessor assembly. The microprocessor assembly will oversee and control the refill process. 5 The microprocessor assembly will communicate with a user interface to accept commands and provide responses for various refill operations. 3.3 INK CARTRIDGE DESCRIPTION Ink cartridges which will be refilled in a commercial refill station must have a QA Chip storing the following components: 10 * Ink amount remaining. * Ink attributes (for example - ink type, ink characteristics, ink colour, ink manufacturer). 3.4 OPERATIONAL PROCEDURE The operational procedure can be divided into two parts: e Refilling of ink cartridges using the commercial refill station 15 * Refilling the ink reservoirs used in the refill station is covered in Section 3.5. 3.4.1 Refilling ink cartridges using the commercial refill station Figure 362 shows the refill of ink cartridges in a commercial refill station. The following is a description for refilling of ink cartridges in the commercial refill station: e Load the ink cartridge into the multiple cartridge interface unit of the ink refill unit. This will connect 20 the QA Chip of the ink cartridge to the microprocessor assembly. It will also connect the ink output device of the ink refill unit to the ink cartridge. * The model number of the ink cartridge automatically is read from the QA Chip by the microprocessor assembly controlling the ink refill units. " The microprocessor assembly will determine whether the ink refill unit is suitable for the ink cartridge 25 model. " The refill option is selected on the microprocessor assembly through the user interface. The microprocessor assembly will then do the following: a. Read ink attributes (for example ink type, ink characteristics, ink colour, ink manufacturer etc) stored in the QA Chip of the ink cartridge. Refer to[l]. 30 b. Compare the read ink attributes to the ink attribute list in the refill station.This may also require reading of the ink attributes stored in the QA Chip of the ink reservoirs in the refill unit. c. Only if Step b is successful, then do the following: i. Determine the amount of ink to be transferred by any or all of the following means, ensuring that the reservoir has enough ink for the transfer: 35 * Fixed amount (e.g. based on a pre-programmed value, cartridge model or reservoir type). 0 User-selectable amount.
WO 2004/050369 PCT/AU2003/001616 778 ii. The microprocessor assembly will calculate the cost of ink amount and interrogate the user for a payment method -credit card or cash. If credit card option is selected it will request a credit card number to be selected and interface to a payment system to complete the transaction before proceeding further. iii. Decrement the amount of ink transferred from the QA Chip in the ink refill unit and increment the QA 5 Chip in the ink cartridge with corresponding ink amount. iv. If incrementing of the QA Chip with ink amount is successful then a command is sent to the ink transfer mechanism to release the ink to the ink cartridge through the output device. 3.5 REFILLING THE INK RESERVOIRS The ink reservoirs of any ink refill device can be refilled recursively by the procedure described in Section 10 3.4.1, the only exception being the ink cartridge replaced by the ink reservoir. 3.6 COMMERCIAL REFILL STATION FOR A PRODUCTION ENVIRONMENT This refill station resembles a commercial refill station but fills multiple ink cartridges of the same type at the same time. This will serve as a filling station for new cartridges in a production environment.
WO 2004/050369 PCT/AU2003/001616 779 LOGICAL INTERFACE SPECIFICATION FOR PREFERRED FORM OF QA CHIP I Introduction This document defines the QA Chip Logical Interface , which provides authenticated manipulation of specific printer and consumable parameters. The interface is described in terms of data structures 5 and the functions that manipulate them, together with examples of use. While the descriptions and examples are targetted towards the printer application, they are equally applicable in other domains. 2 Scope The document describes the QA Chip Logical Interface as follows: 10 9 data structures and their uses (Section 5 to Section 9). " functions, including inputs, outputs, signature formats, and a logical implementation sequence (Section 10 to Section 30). * typical functional sequences of printers and consumables, using the functions and data structures of the interface (Section 31 to Section 32). 15 The QA Chip Logical Interface is a logical interface, and is therefore implementation independent. Although this document does not cover implementation details on particular platforms, expected implementations include: * Software only * Off-the-shelf cryptographic hardware. 20 9 ASICs, such as SBR4320 [2] and SOPEC [3 for physical insertion into printers and ink cartridges a Smart cards. 3 Nomenclature 25 3.1 SYMBOLS The following symbolic nomenclature is used throughout this document: Table 246. Summary of symbolic nomenclature Symbol Description F[X] Function F, taking a single parameter X F[X, Y] Function F, taking two parameters, X and Y X Y X concatenated with Y XA Y Bitwise X AND Y Xv y Bitwise X OR Y (inclusive-OR) Xe y Bitwise X XOR Y (exclusive-OR) ,X Bitwise NOT X (complement) WO 2004/050369 PCT/AU2003/001616 780 X <-. Y X is assigned the value Y X <- {Y, Z} The domain of assignment inputs to X is Y and Z X=Y X is equal to Y X Y X is not equal to Y 4X Decrement X by 1 (floor 0) ftx Increment X by 1 (modulo register length) Erase X Erase Flash memory register X SetBits[X, Y] Set the bits of the Flash memory register X based on Y Z<- ShiftRight[X, Shift register X right one bit position, taking input bit Y] from Y and placing the output bit in Z a.b Data field or member function 'b' in object a. 3.2 PSEUDOCODE 3.2.1 Asynchronous The following pseudocode: 5 var = expression means the var signal or output is equal to the evaluation of the expression. 3.2.2 Synchronous The following pseudocode: var <- expression 10 means the var register is assigned the result of evaluating the expression during this cycle. 3.2.3 Expression Expressions are defined using the nomenclature in Table 246 above. Therefore: var = (a = b) is interpreted as the var signal is I if a is equal to b, and 0 otherwise. 15 4 TERMS 4.1 QA Device and System An instance of a QA Chip Logical Interface (on any platform) is a QA Device. QA Devices cannot talk directly to each other. A System is a logical entity which has one or more QA Devices connected logically (or physically) to it, and calls the functions on the QA Devices. The 20 system is considered secure and the program running on the system is considered to be trusted. 4.2 Types of QA Devices 4.2.1 Trusted QA Device The Trusted QA Device forms an integral part of the system itself and resides within the trusted environment of the system. It enables the system to extend trust to external QA Device s. The 25 Trusted QA Device is only trusted because the system itself is trusted.
WO 2004/050369 PCT/AU2003/001616 781 4.2.2 External untrusted QA Device The External untrusted QA Device is a QA Device that resides external to the trusted environment of the system and is therefore untrusted. The purpose of the QA Chip Logical Interface is to allow the external untrusted QA Devices to become effectively trusted. This is accomplished when a 5 Trusted QA Device shares a secret key with the external untrusted QA Device, or with a Translation QA Device (see below). In a printing application external untrusted QA Devices would typically be instances of SBR4320 implementations located in a consumable or the printer. 4.2.3 Translation QA Device 10 A Translation QA Device is used to translate signatures between QA Devices and extend effective trust when secret keys are not directly shared between QA Devices. The Translation QA Device must share a secret key with the Trusted QA Device that allows the Translation QA Device to effectively become trusted by the Trusted QA Device and hence trusted by the system. The Translation QA Device shares a different secret key with another external 15 untrusted QA Device (which may in fact be a Translation QA Device etc). Although the Trusted QA Device doesn't share (know) the key of the external untrusted QA Device, signatures generated by that untrusted device can be translated by the Translation QA Device into signatures based on the key that the Trusted QA Device does know, and thus extend trust to the otherwise untrusted external QA Device. 20 In a SoPEC-based printing application, the Printer QA Device acts as a Translation QA Device since it shares a secret key with the SoPEC, and a different secret key with the ink carridges. 4.2.4 Consumable QA Device 25 A Consumable QA Device is an external untrusted QA Device located in a consumable. It typically contains details about the consumable, including how much of the consumable remains. In a printing application the consumable QA Device is typically found in an ink cartridge and is referred to as an Ink QA Device, or simply Ink QA since ink is the most common consumable for printing applications. However, other consumables in printing applications include media and 30 impression counts, so consumable QA Device is more generic. 4.2.5 Printer QA Device A Printer QA Device is an external untrusted device located in the printer. It contains details about the operating parameters for the printer, and is often referred to as a Printer QA. 35 WO 2004/050369 PCT/AU2003/001616 782 4.2.6 Value Upgrader QA Device A Value Upgrader QA Device contains the necessary functions to allow a system to write an initial value (e.g. an ink amount) into another QA Device, typically a consumable QA Device. It also allows a system to refill/replenish a value in a consumable QA Device after use. 5 Whenever a value upgrader QA Device increases the amount of value in another QA Device , the value in the value upgrader QA Device is correspondingly decreased. This means the value upgrader QA Device cannot create value - it can only pass on whatever value it itself has been issued with. Thus a value upgrader QA Device can itself be replenished or topped up by another value upgrader QA Device. 10 An example of a value upgrader is an Ink Refill QA Device, which is used to fill/refill ink amount in an Ink QA Device. 4.2.7 Parameter Upgrader QA Device 15 A Parameter Upgrader QA Device contains the necessary functions to allow a system to write an initial parameter value (e.g. a print speed) into another QA Device, typically a printer QA Device. It also allows a system to change that parameter value at some later date. A parameter upgrader QA Device is able to perform a fixed number of upgrades, and this number is 20 effectively a consumable value. Thus the number of available upgrades decreases by 1 with each upgrade, and can be replenished by a value upgrader QA Device. 4.2.8 Key programmer QA Device Secret batch keys are inserted into QA Devices during instantiation (e.g. manufacture). These keys 25 must be replaced by the final secret keys when the purpose of the QA Device is known. The Key Programmer QA Device implements all necessary functions for replacing keys in other QA Devices. 4.3 Signature Digital signatures are used throughout the authentication protocols of the QA Chip Logical Interface. 30 A signature is produced by passing data plus a secret key through a keyed hash function. The signature proves that the data was signed by someone who knew the secret key. The signature function used throughout the QA Chip Logical Interface is HMAC-SHA1 [1]. 4.3.4 Authenticated Read 35 This is a read of data from a non-trusted QA Device that also includes a check of the signature (see Section 4.3.3). When the System determines that the signature is correct for the returned data (e.g. by asking a trusted QA Device to test the signature) then the System is able to trust that the data WO 2004/050369 PCT/AU2003/001616 783 has not been tampered en route from the read, and was actually stored on the non-trusted QA Device. 4.3.5 Authenticated Write 5 An authenticated write is a write to the data storage area in a QA Device where the write request includes both the new data and a signature. The signature is based on a key that has write access permissions to the region of data in the QA Device, and proves to the receiving QA Device that the writer has the authority to perform the write. For example, a Value Upgrader Refilling Device is able to authorize a system to perform an authenticated write to upgrade a Consumable QA Device (e.g. 10 to increase the amount of ink in an Ink QA Device). The QA Device that receives the write request checks that the signature matches the data (so that it hasn't been tampered with en route) and also that the signature is based on the correct authorization key. An authenticated write can be followed by an authenticated read to ensure (from the system's point 15 of view) that the write was successful. 4.3.6 Non-authenticated Write A non-authenticated write is a write to the data storage area in a QA Device where the write request includes only the new data (and no signature). This kind of write is used when the system wants to update areas of the QA Device that have no access-protection. 20 The QA Device verifies that the destination of the write request has access permissions that permit anyone to write to it. If access is permitted, the QA Device simply performs the write as requested. A non-authenticated write can be followed by an authenticated read to ensure (from the system's point of view) that the write was successful. 4.3.7 Authorized Modification of Data 25 Authorized modification of data refers to modification of data via authenticated writes (see Section 4.3.5).
WO 2004/050369 PCT/AU2003/001616 784 DATA STRUCTURES 5 Summary () .0 0 0o c 0 0 0 U) > E a)) '- 0 Q 0 S2 0i (Dc o 0 .2 > n <~ . 9i to~~~ .. S-0o . -~c (no !, cc Mn o a ~ <30~8I cu .2- )0 13 E 0 00 0) wl 0 C 0 c ci o 0.0 I_ wo0 2 a) CL w o 0 > >0 CL c)~ .0 u > U Q) t a) 2) a) 'at c 0) t~ :P- . a- a7 ) 16 r- t en. 0 (D co 0 o 27 0 n'o 1 =1 J a, Z) -o El >' L 03 z 06 CI) 0 00 Z0)c .82 Co 2 W V d. 0 a) 4-! E 25 t 1:1 c0 ) : )0 l 21) 0 0 C4- 0t 0 1) Q a) 0 0 ) (n WO 2004/050369 785 PCT/AU2003/001616 WO 2004/050369 PCT/AU2003/001616 786 6 Instance/device identifier Each QA Device requires an identifier that allows unique identification of that QA Device by external systems, ensures that messages are received by the correct QA Device, and ensures that the same device can be used across multiple transactions. 5 Strictly speaking, the identifier only needs to be unique within the context of a key, since QA Devices only accept messages that are appropriately signed. However it is more convenient to have the instance identifier completely unique, as is the case with this design. 10 The identifier functionality is provided by Chipid. 6.1 CHIPID Chipid is the unique 64-bit QA Device identifier. The Chipid is set when the QA Device is instantiated, and cannot be changed during the lifetime of the QA Device. 15 A 64-bit Chipid gives a maximum of 1844674 trillion unique QA Devices. 7 Key and key related data 7.1 NUMKEYS, K, KEYID, AND KEYLOCK Each QA Device contains a number of secret keys that are used for signature generation and 20 verification. These keys serve two basic functions: * For reading, where they are used to verify that the read data came from the particular QA Device and was not altered en route. * For writing, where they are used to ensure only authorised modification of data. Both of these functions are achieved by signature generation; a key is used to generate a signature 25 for subsequent transmission from the device, and to generate a signature to compare against a received signature. The number of secret keys in a QA Device is given by NumKeys. For this version of the QA Chip Logical Interface, NumKeys has a maximum value of 8. Each key is referred to as K, and the subscripted form Kn refers to the nth key where n has the 30 range 0 to NumKeys-1 (i.e. 0 to 7). For convenience we also refer to the nth key as being the key in the nth keyslot. The length of each key is 160-bits. 160-bits was chosen because the output signature length from the signature generation function (HMAC-SHAI) is 160 bits, and a key longer than 160-bits does not add to the security of the function. 35 The security of the digital signatures relies upon keys being kept secret. To safeguard the security of each key, keys should be generated in a way that is not deterministic. Ideally each key should be WO 2004/050369 PCT/AU2003/001616 787 programmed with a physically generated random number, gathered from a physically random phenomenon. Each key is initially programmed during QA Device instantiation. Since all keys must be kept secret and must never leave the QA Device, each key has a corresponding 31-bit Keyld which can be read to determine the identity or label of the key without 5 revealing the value of the key itself. Since the relationship between keys and Keylds is 1:1, a system can read all the Keylds from a QA Device and know which keys are stored in each of the keyslots. Finally, each keyslot has a corresponding 1-bit KeyLock status indicating whether the key in that slot/position is allowed to be replaced (securely replaced, and only if the old key is known). Once a 10 key has been locked into a slot, it cannot be unlocked i.e. it is the final key for that slot. A key can only be used to perform authenticated writes of data when it has been locked into its keyslot (i.e. its KeyLock status = 1). Refer to Section 8.1.1.5 for further details. Thus each of the NumKeys keyslots contains a 160-bit key, a 31-bit Keyld, and a 1-bit KeyLock. 7.2 COMMON AND VARIANT SIGNATURE GENERATION 15 To create a digital signature, we pass the data to be signed together with a secret key through a key dependent one-way hash function. The key dependent one-way hash function used throughout the QA Chip Logical Interface is HMAC-SHAI [1]. Signatures are only of use if they can be validated i.e. QA Device A produces a signature for data and QA Device B can check if the signature was valid for that particular data. This implies that A 20 and B must share some secret information so that they can generate equivalent signatures. Common key signature generation is when QA Device A and QA Device B share the exact same key i.e. key KA = key KB. Thus the signature for a message produced by A using KA can be equivalently produced by B using KB. In other words SIGKA(message) = SIGKB(message) because key KA = key KB. 25 Variant key signature generation is when QA Device B holds a base key, and QA Device A holds a variant of that key such that KA = owf(KB,UA) where owf is a one-way function based upon the base key (KB) and a unique number in A (UA). Thus A can produce SIGKA(message), but for B to produce an equivalent signature it must produce KA by reading UA from A and using its base key KB. KA is referred to as a variant key and KB is referred to as the base/common key. Therefore, B can 30 produce equivalent signatures from many QA Devices, each of which has its own unique variant of KB. Since Chipld is unique to a given QA Device, we use that as UA. A one-way function is required to create KA from KB or it would be possible to derive KB if KA were exposed. Common key signature generation is used when A and B are equally available' to an attacker. For example, Printer QA Devices and Ink QA Devices are equally available to attackers (both are 'The term "equally available" is relative. It typically means that the ease of availability of both are the effectively the same, regardless of price (e.g. both A and B are commercially available and effectively equally easy to come by).
WO 2004/050369 PCT/AU2003/001616 788 commonly available to an attacker), so shared keys between these two devices should be common keys. Variant key signature generation is used when B is not readily available to an attacker, and A is readily available to an attacker. If an attacker is able to determine KA, they will not know KA for any 5 other QA Device of class A, and they will not be able to determine KB. The QA Device producing or testing a signature needs to know if it must use the common or variant means of signature generation. Likewise, when a key is stored in a QA Device, the status of the key (whether it is a base or variant key) must be stored along with it for future reference. Both of these requirements are met using the Keyld as follows: 10 The 31-bit Keyld is broken into two parts: * A 30-bit unique identifier for the key. Bits 30-1 represents the Id. * A 1-bit Variant Flag, which represents whether the key is a base key or a variant key. Bit 0 represents the Variant Flag. Table 247 describes the relationship of the Variant Flag with the key. 15 Table 247. Variant Flag representation value Key represented 0 Base key I Variant key 7.2.1 Equivalent signature generation between QA Devices Equivalent signature generation between 4 QA Devices A, B, C and D is shown in Figure 363. Each 20 device has a single key. Keyld./d of all four keys are the same i.e KeyldA./d = KeyIdB./d = Keyldc./d = Keyld 0 ./d. If KeyldA. VariantFlag = 0 and KeyldB.VariantFlag = 0, then a signature produced by A, can be equivalently produced by B because KA - KB. If KeyLdB.VariantFlag = 0 and Keyldc .VariantFlag = 1, then a signature produced by C, is 25 equivalently produced by B because Kc = f (KB, Chipldc). If Keyldc.VariantFlag = I and KeyldD.VariantFlag = 1, then a signature produced by C, cannot be equivalently produced by D because there is no common base key between the two devices. If KeyIdD.VariantFlag = 1 and KeyldA.VariantFlag = 0, then a signature produced by D, can be equivalently produced by A because KD = f (KA, ChipIdD). 30 WO 2004/050369 PCT/AU2003/001616 789 8 Operating and state data The primary purpose of a QA Device is to securely hold application-specific data. For example if the QA Device is an Ink QA Device it may store ink characteristics and the amount of ink-remaining. If 5 the QA Device is a Printer QA Device it may store the maximum speed and width of printing. For secure manipulation of data: * Data must be clearly identified (includes typing of data). * Data must have clearly defined access criteria and permissions. The QA Chip Logical Interface contains structures to permit these activities. 10 The QA Device contains a number of kinds of data with differing access requirements: * Data that can be decremented by anyone, but only increased in an authorised fashion e.g. the amount of ink-remaining in an ink cartridge. * Data that can only be decremented in an authorised fashion e.g. the number of times a Parameter Upgrader QA Device has upgraded another QA Device. 15 * Data that is normally read-only, but can be written to (changed) in an authorised fashion e.g. the operating parameters of a printer. * Data that is always read-only and doesn't ever need to be changed e.g. ink attributes or the serial number of an ink cartridge or printer, * Data that is written by QACo/Silverbrook, and must not be changed by the OEM or end user 20 e.g. a licence number containing the OEM's identification that must match the software in the printer. * Data that is written by the OEM and must not be changed by the end-user e.g. the machine number that filled the ink cartridge with ink (for problem tracking). 8.1 M 25 Mis the general term for all of the memory (or data) in a QA Device. M is further subscripted to refer to those different parts of M that have different access requirements as follows: * Mo contains all of the data that is protected by access permissions for key-based (authenticated) and non-key-based (non-authenticated) writes. * M 1 contains the type information and access permissions for the M 0 data, and has write-once 30 permissions (each sub-part of M 1 can only be written to once) to avoid the possibility of changing the type or access permissions of something after it has been defined. * M 2 , M 3 etc., referred to as M 2 +, contains all the data that can be updated by anyone until the permissions for those sub-parts of M 2 + have changed from read/write to read-only. While all QA Devices must have at least M 0 and M 1 , the exact number of memory vectors (Mos) 35 available in a particular QA Device is given by NumVectors. In this version of the QA Chip Logical Interface there are exactly 4 memory vectors, so NumVectors = 4.
WO 2004/050369 PCT/AU2003/001616 790 Each M, is 512 bits in length, and is further broken into 16 x 32 bit words. The ith word of M, is referred to as Mn[]. Mj[0] is the least significant word of Ma, and M[15] is the most significant word of M. 8.1.1 Mo and M 1 5 In the general case of data storage, it is up to the external accessor to interpret the bits in any way it wants. Data structures can be arbitrarily arranged as long as the various pieces of software and hardware that interpret those bits do so consistently. However if those bits have value, as in the case of a consumable, it is vital that the value cannot be increased without appropriate authorisation, or one type of value cannot be added to another incompatible kind e.g. dollars should 10 never be added to yen. Therefore Mo is divided into a number of fields, where each field has a size, a position, a type and a set of permissions. Mo contains all of the data that requires authenticated write access (one data element per field), and M 1 contains the field information i.e. the size, type and access permissions for the data stored in Mo. 15 Each 32-bit word of M 1 defines a field. Therefore there is a maximum of 16 defined fields. M1[0] defines field 0, M 1 [1] defines field 1 and so on. Each field is defined in terms of: * size and position, to permit external accessors determine where a data item is * type, to permit external accessors determine what the data represents * permissions, to ensure approriate access to the field by external accessors. 20 The 32-bit value M 1 [n] defines the conceptual field attributes for field n as follows: With regards to consistency of interpretation, the type, size and position information stored in the various words of M 1 allows a system to determine the contents of the corresponding fields (in MO) held in the QA Device. For example, a 3-color ink cartridge may have an Ink QA Device that holds the amount of cyan ink in field 0, the amount of magenta ink in field 1, and the amount of yellow ink 25 in field 2, while another single-color Ink QA Device may hold the amount of yellow ink in field 0, where the size of the fields in the two Ink QA Devices are different. Afield must be defined (in M 1 ) before it can be written to (in Mo). At QA Device instantiation, the whole of Mo is 0 and no fields are defined (all of M 1 is 0). The first field (field 0) can only be created by writing an appropriate value to M 1 [0]. Once field 0 has been defined, the words of Mo 30 corresponding to field 0 can be written to (via the appropriate permissions within the field definition
M
1 [0]). Once a field has been defined (i.e. M 1 [n] has been written to), the size, type and permissions for that field cannot be changed i.e. M 1 is write-once. Otherwise, for example, a field could be defined to be lira and given an initial value, then the type changed to dollars. 35 The size of a field is measured in terms of the number of consecutive 32-bit words it occupies. Since there are only 16 x 32-bit words in Mo, there can only be 16 fields when all 16 fields are WO 2004/050369 PCT/AU2003/001616 791 defined to be 1 word sized each. Likewise, the maximum size of a field is 512 bits when only a single field is defined, and it is possible to define two fields of 256-bits each. Once field 0 has been created, field 1 can be created, and so on. When enough fields have been created to allocate all of MG, the remaining words in M 1 are available for write-once general data 5 storage purposes. It must be emphasised that when a field is created the permissions for that field are final and cannot be changed. This also means that any keys referred to by the field permissions must be already locked into their keyslots. Otherwise someone could set up a field's permissions that the key in a particular keyslot has write access to that field without any guarantee that the desired key will be 10 ever stored in that slot (thus allowing potential mis-use of the field's value). 8.1.1.1 Field Size and Position A field's size and position are defined by means of 4 bits (referred to as EndPos) that point to the least significant word of the field, with an implied position of the field's most significant word. The implied position of field O's most significant word is Mo[1 5]. The positions and sizes of all fields can 15 therefore be calculated by starting from field 0 and working upwards until all the words of Mo have been accounted for. The default value of M 1 [0] is 0, which means fieldO.endPos = 0. Since field0.startPos = 15, field 0 is the only field and is 16 words long. 8.1.1.1.1 Example 20 Suppose for example, we want to allocate 4 fields as follows: * field 0 :128 bits (4 x 32-bit words) * field 1: 32 bits (1 x 32-bit word) * field 2: 160 bits (5 x 32-bit words) * field 3: 192 bits (6 x 32-bit words) 25 Field O's position and size is defined by M 1 [0], and has an assumed start position of 15, which means the most significant word of field 0 must be in Mo[15]. Field 0 therefore occupies M 0 [12] through to M[15], and has an endPos value of 12. Field 1's position and size is defined by M 1 [1], and has an assumed start position of 11 (i.e.
M
1 [0].endPos - 1). Since it has a length of 1 word, field 1 therefore occupies only M 0 [1 1] and its end 30 position is the same as its start position i.e. its endPos value is 11. Likewise field 2's position and size is defined by M 1 [2], and has an assumed start position of 10 (i.e.
M
1 [1].endPos - 1). Since it has a length of 5 words, field 2 therefore occupies Mo[6] through to Mo[10] and and has an endPos value of 6. Finally, field 3's position and size is defined by M1[3], and has an assumed start position of 5 (i.e. 35 M 1 [2].endPos - 1). Since it has a length of 6 words, field 3 therefore occupies Mo[5] through to MO[0] and and has an endPos value of 0.
WO 2004/050369 PCT/AU2003/001616 792 Since all 16 words of MO are now accounted for in the 4 fields, the remaining words of M 1 (i.e. M 1 [4] though to M 1 [15]) are ignored, and can be used for any write-once (and thence read-only) data. Figure 365 shows the same example in diagramatic format. 8.1.1.1.2 Determining the number of fields 5 The following pseudocode illustrates a means of determining the number of fields: fieldNum FindNumFields (Ml) startPos +- 15 fieldNum +- 0 While (fieldNum < 16) 10 endPos <- M1[fieldNum].endPos If (endPos > startPos) # error in this field... so must be an attack attackDetected() # most likely clears all keys and data EndIf 15 fieldNum++ If (endPos = 0) return fieldNum # is already incremented Else startPos <- endPos - 1 # endpos must be > 0 20 EndIf EndWhile # error if get here since 16 fields are consumed in 16 words at most attackDetected() # most likely clears all keys and data 25 8.1.1.1.3 Determining the sizes of all fields The following pseudocode illustrates a means of determing the sizes of all valid fields: FindFieldsizes(M1, fieldSize[]) numFields +- FindNumFields (M1) # assumes that FindNumFields does all checking 30 ntartPos +- 15 fieldNum +- 0 While (fieldNum < numFields) EndPos +- Ml[fieldNum] .endPos fieldSize[fieldNum] = startPos - endPos + 1 35 startPos +- endPos - 1 # endpos must be > 0 fieldNum++ WO 2004/050369 PCT/AU2003/001616 793 EndWhile While (fieldNum < 16) fieldSize[fieldNumj - 0 fieldNum++ 5 EndWhile 8.1.1.2 Field Type The system must be able to identify the type of data stored in a field so that it can perform operations using the correct data. For example, a printer system must be able identify which of a consumable's fields are ink fields (and which field is which ink) so that the ink usage can be 10 correctly applied during printing. A field's type is defined by 15 bits. Table 332 in Appendix A lists the field types that are specifically required by the QA Chip Logical Interface and therefore apply across all applications. The default value of M 1 [0] is 0, which means fieldO.type = 0 (i.e. non-initialised). Strictly speaking, the type need only be interpreted by all who can securely read and write to that 15 field i.e. within the context of one or more keys. However it is convenient if possible to keep all types unique for simplistic identification of data across all applications. In the general case, an external system communicating with a QA Device can identify the data stored in MO in the following way: * Read the Keyld of the key that has permission to write to the field. This will a give broad 20 identification of the data type, which may be sufficient for certain applications. * Read the type attribute for the field to narrow down the identity within the broader context of the Keyld. For example, the printer system can read the Keyld to deduce that the data stored in a field can be written to via the HPNetworkinkRefill key, which means that any data is of the general ink 25 category known to HP Network printers. By further reading the type attribute for the field the system can determine that the ink is Black ink. 8.1.1.3 Field Permissions All fields can be ready by everyone. However writes to fields are governed by 13-bits of permissions that are present in each field's attribute definition. The permissions describe who can do what to a 30 specific field. Writes to fields can either be authenticated (i.e. the data to be written is signed by a key and this signature must be checked by the receiving device before write access is given) or non authenticated (i.e. the data is not signed by a key). Therefore we define a single bit (AuthRW) that specifies whether authenticated writes are permitted, and a single bit (NonAuthRW) specifying 35 whether non-authenticated writes are permitted. Since it is pointless to permit both authenticated and non-authenticated writes to write any value (the authentciated writes are pointless), we further define the case when both bits are set to be interpreted as authenticated writes are permitted, but WO 2004/050369 PCT/AU2003/001616 794 non-authenticated writes only succeed when the new value is less than the previous value i.e. the permission is decrement-only. The interpretation of these two bits is shown in Table 249. Table 249. Interpretation of AuthRW and NonAuthRW NonAuthRW AuthRW Interpretation 0 0 Read-only access (no-one can write to this field). This is the initial state for each field. At instantiation all of M 1 is 0 which means AuthRW and NonAuthRW are 0 for each field, and hence none of MO can be written to until a field is defined. 0 1 Authenticated write access is permitted Non-authenticated write acecss is not permitted 1 0 Authenticated write access is not permitted Non-authenticated write access is permitted (i.e. anyone can write to this field) 11 Authenticated write access is permitted Non-authenticated write access is decrement-only. 5 If authenticated write access is permitted, there are 11 additional bits (bringing the total number of permission bits to 13) to more fully describe the kind of write access for each key. We only permit a single key to have the ability to write any value to the field, and the remaining keys are defined as being either not permitted to write, or as having decrement-only write access. A 3-bit KeyNum 10 represents the slot number of the key that has the ability to write any value to the field (as long as the key is locked into its key slot), and an 8-bit KeyPerms defines the write permissions for the (maximum of) 8 keys as follows: * KeyPerms[n] = 0: The key in slot n (i.e. Kn) has no write access to this field (except when n = KeyNum). Setting KeyPerms to 0 prohibits a key from transferring value (when an amount is 15 deducted from field in one QA Device and transferred to another field in a different QA Device) " KeyPerms[n] = 1: The key in slot n (i.e. K,) is permitted to perform decrement-only writes to this field (as long as K, is locked in its key slot). Setting KeyPerms to I allows a key to transfer value (when an amount is deducted from field in one QA Device and transferred to 20 another field in a different QA Device). The 13-bits of permissions (within bits 4-16 of M1[n]) are allocated as follows: 8.1.1.3.1 Example 1 Figure 367 shows an example of permission bits for a field. In this example we can see: WO 2004/050369 PCT/AU2003/001616 795 " NonAuthRW= 0 and AuthRW = 1, which means that only authenticated writes are allowed i.e. writes to the field without an appropriate signature are not permitted. " KeyNum = 3, so the only key permitted to write any value to the field is key 3 5 (i.e. K 3 ). " KeyPerms[3] = 0, which means that although key 3 is permitted to write to this field, key 3 can't be used to transfer value from this field to other QA Devices. * KeyPerms[0,4,5,6,7] = 0, which means that these respective keys cannot write to this field. 10 e KeyPerms[1,2] = 1, which means that keys 1 and 2 have decrement-only access to this field i.e. they are permitted to write a new value to the field only when the new value is less than the current value. 8.1.1.3.2 Example 2 Figure 368 shows a second example of permission bits for a field. 15 In this example we can see: " NonAuthRW and AuthRW = 1, which means that authenticated writes are allowed and writes to the field without a signature are only permitted when the new value is less than the current value (i.e. non-authenticated writes have decrement-only permission). 20 9 KeyNum = 3, so the only key permitted to write any value to the field is key 3 (i.e. K 3 ). " KeyPerms[3] = 1, which means that key 3 is permitted to write to this field, and can be used to transfer value from this field to other QA Devices. " KeyPerms[0,4,5,6,7 = 0, which means that these respective keys cannot write 25 to this field. " KeyPerms[1,2] = 1, which means that keys 1 and 2 have decrement-only access to this field i.e. they are permitted to write a new value to the field only when the new value is less than the current value. 8.1.1.4 Summary of Field attributes 30 Figure 369 shows the breakdown of bits within the 32-bit field attribute value M 1 [n]. Table 250 summarises each attribute. Table 250. Attributes for a field Attribute Sub-attribute name Size Interpretation in bits Type Type 15 Gives additional identification of the data WO 2004/050369 PCT/AU2003/001616 796 stored in the field within the context of the accessors of that field. Permissions KeyNum 3 The slot number of the key that has authenticated write access to the field. NonAuthRW 1 0 = non-authenticated writes are not permitted to this field. 1 = non-authenticated writes are permitted to this field (see Table 249). AuthRW 1 0 = authenticated writes are not permitted to this field. 1 = authenticated writes are permitted to this field. KeyPerms 8 Bitmap representing the write permissions for each of the keys when AuthRW = 1. For each bit: 0 = no write access for this key (except for key KeyNum) I = decrement-only access is permitted for this key. Size and EndPos The word number in MO that holds the lsw Position of the field. The msw is held in M1 [fieldNum-1], where msw of field 0 is 15. 8.1.1.5 Permissions of M 1
M
1 holds the field attributes for data stored in MO, and each word of M 1 can be written to once only. It is important that a system can determine which words are available for writing. While this can be 5 determined by reading M 1 and determining which of the words is non-zero, a 16-bit permissions value P1 is available, with each bit indicating whether or not a given word in M 1 has been written to. Bit n of P 1 represents the permissions for M 1 [n] as follows: Table 251. Interpretation of P 1 [n] i.e. bit n of M 1 's permission Description 0 writes to M1[n] are not permitted i.e. this word is now read-only 1 writes to M 1 [n] are permitted 10 WO 2004/050369 PCT/AU2003/001616 797 Since M 1 is write-once, whenever a word is written to in M1, the corresponding bit of P 1 is also cleared, i.e. writing to Mj[n] clears P 1 [n]. Writes to M 1 [n] only succeed when all of M 1 [0...n-1] have already written to (i.e. previous fields are defined) i.e. 5 9 M1[0..n-1] must have already been written to (i.e. P 1 [O..n-1] are 0) * P1[n] = 1 (i.e. it has not yet been written to) In addition, if M 1 [n-1].endPos #0, the new M 1 [n] word will define the attributes of field n, so must be further checked as follows: * The new M1[n].endPos must be valid (i.e. must be less than M 1 [n-1].endPos) 10 if the new M 1 [n].authRW is set, KkeyNum must be locked, and all keys referred to by the new M1[n].keyPerms must also be locked. However if M 1 [n-1].endPos = 0, then all of Mo has been defined in terms of fields. Since enough fields have been created to allocate all of M 0 , any remaining words in M 1 are available for write-once general data storage purposes, and are not checked any further. 15 8.1.2 M2+
M
2 , M 3 etc., referred to as M 2 +, contains all the data that can be updated by anyone (i.e. no authenticated write is required) until the permissions for those sub-parts of M 2 + have changed from read/write to read-only. The same permissions representation as used for M 1 is also used for M 2 +. Consequently P, is a 16 20 bit value that contains the permissions for Mn (where n > 0). The permissions for word w of Mn is given by a single bit P[w]. However, unlike writes to M 1 , writes to M 2 + do not automatically clear bits in P. Only when the bits in P 2 + are explictly cleared (by anyone) do those corresponding words become read-only and final. 9 Session data 25 Data that is valid only for the duration of a particular communication session is referred to as session data. Session data ensures that every signature contains different data (sometimes referred to as a nonce) and this prevents replay attacks. 9.1 R R is a 160-bit random number seed that is set up (when the QA Device is instantiated) and from 30 that point on it is internally managed and updated by the QA Device. R is used to ensure that each signed item contains time varying information (not chosen by an attacker), and each QA Device's R is unrelated from one QA Device to the next. This R is used in the generation and testing of signatures. An attacker must not be able to deduce the values of R in present and future devices. Therefore, R 35 should be programmed with a cryptographically strong random number, gathered from a physically random phenomenon (must not be deterministic).
WO 2004/050369 PCT/AU2003/001616 798 9.2 ADVANCING R The session component of the message must only last for a single session (challenge and response). The rules for updating R are as follows: 5 9 Reads of R do not advance R. . Everytime a signature is produced with R, R is advanced to a new random number. * Everytime a signature including R is tested and is found to be correct, R is advanced to a new random number. 9.3 RL AND RE 10 Each signature contains 2 pieces of session data i.e. 2 Rs: * One R comes from the QA Device issuing the challenge i.e. the challenger. This is so the challenger can ensure that the challenged QA Device isn't simply replaying an old signature i.e. the challenger is protecting itself against the challenged. " One R comes from the device responding to the challenge i.e. the challenged. This is so the 15 challenged never signs anything that is given to it without inserting some time varying change i.e. protects the challenged from the challenger in case the challenger is actually an attacker performing a chosen text attack Since there are two Rs, we need to distinguish between them. We do so by defining each R as external (RE) or local (RL) depending on its use in a given function. For example, the challenger 20 sends out its local R, referred to as RL. The device being challenged receives the challenger's R as an external R, i.e RE. It then generates a signature using its RL and the challenger's RE. The resultant signature and RL are sent to the challenger as the response. The challenger receives the signature and RE (signature and RL produced by the device being challenged), produces its own signature using RL (sent to the device being challenged earlier) and RE received, and compares that 25 signature to the signature received as response. SIGNATURE FUNCTIONS 10 Objects 10.1 KEYREF 10.1.1 Object description 30 Instead of passing keys directly into a function, a KeyRef (i.e. key reference) object is passed instead. A KeyRef object encapsulates the process by which a key is formed for common and variant forms of signature generation (based on the setting of the variables within the object). A KeyRef defines which key to use, whether it is a common or variant form of that key, and, if it is a variant form, the Chipid to use to create the variant. For more information about common and 35 variant forms of keys, see Section 7.2. Users pass KeyRef objects in as input parameters to public functions of the QA Chip Logical Interface , and these KeyRefs are subsequently passed to the signature function (called within the WO 2004/050369 PCT/AU2003/001616 799 interface function). Note, however, that the method functions for KeyRef objects are not available outside the QA Chip Logical Interface. 10.1.2 Object variables Table 252 describes each of the variables within a KeyRef object. 5 Table 252. Description of object variables for KeyRef object Parameter Description keyNum Slot number of the key to use as the basis for key formation useChipid 0 = the key to be formed is a common key (i.e. is the same as KkeyNum) 1 = the key to be formed is a variant key based on KkeyNum Chipid When useChipid = 1, this is the Chipid to be used to form the variant key (this will be the Chipld of the QA Device which stores the variant of KkeyNum) When useChipid = 0, chipld is not used 10.1.3 Object Methods 10.1.3.1 getKey 10 public key getKey(void) 10.1.3.1.1 Method description This method is a public method (public in object oriented terms, not public to users of the QA Chip Logical Interface) and is called by the GenerateSignature function to return the key for use in signature generation. 15 If useChipid is true, the formKeyVariant method is called to form the key using chipid and then return the variant key. If useChipid is false, the key stored in slot keyNum is returned. 10.1.3.1.2 Method sequence The getKey method is illustrated by the following pseudocode: If (useChipld = 0) 20 key +- Kkeym Else key +- formKeyariant () Endlf Return key 25 10.1.3.2 formKeyVariant private key formKeyVariant (void) 10.1.3.2.1 Method description This method produces the variant form of a key, based on the KkeyNum and chip/d. As described in Section 7.2, the variant form of key KkeyNum is generated by owf (KkeyNum, chipld) where owf is a one 30 way function.
WO 2004/050369 PCT/AU2003/001616 800 In addition, the time taken by owf must not depend on the value of the key i.e. the timing should be effectively constant. This prevents timing attacks on the key. At present, owf is SHA1, although this still needs to be verified. Thus the variant key is defined to be SHA1(KkeyNum I chipid). 5 10.1.3.2.2 Method sequence The formKeyVariant method is illustrated by the following pseudocode: key - SHA1 ( KkeyNuml chipId) # Calculation must take constant time Return key 11 Functions 10 Digital signatures form the basis of all authentication protocols within the QA Chip Logical Interface . The signature functions are not directly available to users of the QA Chip Logical Interface, since a golden rule of digital signatures is never to sign anything exactly as it has been given to you. Instead, these signature functions are internally available to the functions that comprise the public interface, and are used by those functions for the formation of keys and the generation of 15 signatures. 11.1 GENERATESIGNATURE Input: KeyRef, Data, Random1, Random2 Output: SIG Changes: None 20 Availability: Alf devices 11.1.1 Function description This function uses KeyRef to obtain the actual key required for signature generation, appends Random and Random2 to Data, and performs HMACSHA1[key, Data] to output a signature. HMACSHA1 is described in [1]. In addition, this operation must take constant time irrespective of 25 the value of the key (see Section 10.1.3.2 for more details). 11.1.2 Input parameter description Table 253 describes each of the input parameters: Table 253. Description of input parameters for GenerateSignature Parameter Description KeyRef This is an instance of the KeyRef object for use by the GenerateSignature function. For common key signature generation: KeyRef.keyNum = Slot number of the key to be used to produce the signature. KeyRef.useChipld = 0 For variant key signature generation: KeyRef.keyNum = Slot number of the key to be used for generating the variant key, where the var iant key is to be used to produce the signature KeyRef.useChipid = 1 KeyRef.chipld = Chipld of the QA Device which stores the variant of KKeyRef.keyNum, and uses the variant key for WO 2004/050369 PCT/AU2003/001616 801 signature generation. Date Preformatted data to be signed. Random and Random2 are appended to Data before the signature is generated to ensure that the signature is session based (applicable only to a single session). Random This is the session component from the QA Device that is responding to the challenge. Random2 This is the session component from the QA Device that issued the challenge. 11.1.3 Output parameter description Table 254 describes each of the output parameters. Table 254. Description of output parameters for GenerateSignature 5 Parameter Description SIG SIG = SlGkay(Data I Random1 I Random2) where key = KeyRef.getKey() 11.1.4 Function sequence The GenerateSignature function is illustrated by the following pseudocode: key <- KeyRef.getKey() dataToBeSigned +- Data Random1jRandom2 10 SIG <- HMACSHA1(key, dataToBeSigned) # Calculation must take constant time Output SIG Return 15 BASic FUNCTIONS 12 Definitions This section defines return codes and constants referred to by functions and pseudocode. 12.1 RESULTFLAG The ResultFlag is a byte that indicates the return status from a function. Callers can use the value 20 of ResultFlag to determine whether a call to a function succeeded or failed, and if the call failed, the specific error condition. Table 255 describes the ResultFlag values and the mnemonics used in the pseudocode.
WO 2004/050369 PCT/AU2003/001616 802 Table 255. ResultFlag value description Mnemonic Description Possible causes Pass Function completed Function successfully completed requested task. sucessfully Fail General Failure An error occurred during function processing. BadSig Signature mismatch Input signature didn't match the generated signature. InvalidKey KeyRef incorrect input KeyRef.keyNum > 3. InvalidVector VectNum incorrect Input MVectNum> 3. InvalidPermissio Permission not adqeuate to Trying to perform a Write or WriteAuth with incorrect n per form operation. permissions. KeyAlreadyLocke Key already locked. Key cannot be changed because it has already been d locked. 12.2 CONSTANTS 5 Table 256 describes the constants referred to by functions and pseudocode. Table 256. Constants Definition value MaxKey NumKeys -1 (typically 7) MaxM NumVectors -1 (typically 3) MaxWordin 16 -1 = 15 M 13 GetInfo Input: None 10 Output: ResuitFlag, SoftwareReleaseldMajor, SoftwareReleaseldMinor, NumVec tors, NumKeysChipld DepthOfRollBackCache (for an upgrade device only) Changes : None Availability: All devices 15 13.1 FUNCTION DESCRIPTION Users of QA Devices must call the Getinfo function on each QA Device before calling any other functions on that device.
WO 2004/050369 PCT/AU2003/001616 803 The Get/nfo function tells the caller what kind of QA Device this is, what functions are available and what properties this QA Device has. The caller can use this information to correctly call functions with appropriately formatted parameters. The first value returned, SoftwareReleaseldMajor, effectively identifies what kind of QA Device this 5 is, and therefore what functions are available to callers. SoftwareReleaseldMinor tells the caller which version of the specific type of QA Device this is. The mapping between the SoftwareReleaseldMajor and type of device and their different functions is described in Table 258 Every QA Device also returns NumVectors, NumKeys and Chipid which are required to set input parameter values for commands to the device. 10 Additional information may be returned depending on the type of QA Device. The VarDataLen and VarData fields of the output hold this additional information. 13.2 OUTPUT PARAMETERS Table 257 describes each of the output parameters. Table 257. Description of output parameters for Getinfo function 15 Parameter #bytes Description ResultF/ag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. SoftwareReleaseldMa I This defines the function set that is available on this QA ior Device. SoftwareReleaseldMi 1 This defines minor software releases within a major release, nor and are incremental changes to the software mainly to deal with bug fixes. NumVectors I Total number of memory vectors in this QA Device. NumKeys I Total number of keys in this QA Device. Chipld 6 This QA Device's Chipld VarDataLen 1 Length of bytes to follow. VarData (VarDataLen This is additional application specific data, and will be of bytes) length VarDataLen (i.e. may be 0). Table 258 shows the mapping between the SoftwareReleaseldMajor, the type of QA Device and the available device functions. Table 258. Mapping between SoftwareReleaseldMajor and available device 20 functions WO 2004/050369 PCT/AU2003/001616 804 SoftwareReleasel Device description Functions available d Major 1 Ink or Printer QA Device Getlnfo Random Read Test Translate WriteMl+ WriteFields WriteFieldsAuth SetPerm ReplaceKey 2 Value Upgrader QA Device (e.g. Ink All functions in the Ink or Printer Refill QA Device) Device, plus: StartXfer XferAmount StartRollBack RoliBackAmount 3 Parameter Upgrader QA Device All functions in the Ink or Printer device, plus: StartXfer XferField StartRollBack RollBackField 4 Key Replacement device All functions in the Ink or Printer Device, plus: GetProgramKey ReplaceKey - is different from the Ink or Printer device 5 Trusted device All functions in the Ink or Printer Device, plus: SignM Table 259 shows the VarData components for Value Upgrader and Parameter Upgrader QA Devices.
WO 2004/050369 PCT/AU2003/001616 805 Table 259. VarData for Value and Parameter Upgrader QA Devices VarData Length in Description Components bytes DepthOfRollBackCac 1 The number of datasets that can be he accommodated in the Xfer Entry cache of the device. 5 13.3 FUNCTION SEQUENCE The Get/nfo command is illustrated by the following pseudocode: Output SoftwareReleaseldMajor Output SoftwareReleaseIdMinor Output NumVectors 10 Output NumKeys Output ChipId VarDataLen +- 1 # In case of an upgrade device Output DepthOfRollBackCache Return 15 14 Random Input: None Output: RL Changes: None Availability: All devices 20 The Random command is used by the caller to obtain a session component (challenge) for use in subsequent signature generation. If a caller calls the Random function multiple times, the same output will be returned each time. RL (i.e. this QA Device's R) will only advance to the next random number in the sequence after a successful test of a signature or after producing a new signature. The same RL can never be used 25 to produce two signatures from the same QA Device. The Random command is illustrated by the following pseudocode: Output RL Return 15 Read 30 Input: KeyRef, SigOnly, MSelect, KeyldSelect, WordSelect, RE Output: ResultFlag, SelectedWordsOfSelectedMs, SelectedKeylds, RL, SIG 0
,
WO 2004/050369 PCT/AU2003/001616 806 Changes: RL Availability: All devices 15.1 FUNCTION DESCRIPTION The Read command is used to read data and keylds from a QA Device. The caller can specify 5 which words from M and which Keylds are read. The Read command can return both data and signature, or just the signature of the requested data. Since the return of data is based on the caller's input request, it prevents unnecessary information from being sent back to the caller. Callers typically request only the signature in order to confirm that locally cached values match the values on the QA Device. 10 The data read from an untrusted QA Device (A) using a Read command is validated by a trusted QA Device (B) using the Test command. The RL and S/Go, produced as output from the Read command are input (along with correctly formatted data) to the Test command on a trusted QA Device for validation of the signature and hence the data. S/Goa can also optionally be passed through the Translate command on a number of QA Devices between Read and Test if the QA 15 Devices A and B do not share keys. 15.2 INPUT PARAMETERS Table 260 describes each of the input parameters: 20 Table 260. Description of input parameters for Read Parameter Description KeyRef For common key signature generation: KeyRef.keyNum = Slot number of the key to be used for producing the output signature. KeyRef.useChipld = 0 No variant key signature generation required SigOnly Flag indicating return of signature and data. 0- indicates both the signature and data are to be returned. 1- indicates only the signature is to be returned. Select Selection of memory vectors to be read - each bit corresponding to a given memory vec tor (a maximum of NumVector bits) 0 indicates the memory vector must not be read. 1- indicates memory vector must be read. Key/dSelect Selection of Keylds to be read - each bit corresponds to a given Keyld (a maximum of NumKey bits). 0- indicates Keyld must not be read. 1- indicates Keyld must be read.
WO 2004/050369 PCT/AU2003/001616 807 WordSelect Selection of words read from a desired M as requested in MSelect. Each WordSelect is 16 bits corresponding to each bit in MSelect. Each bit in the WordSelect indicates whether or not to read the corresponding word for the particular M. 0- indicates word must not be read. 1- indicates word must be read. RE External random value required for output signature generation (i.e the challenge). RE is obtained by calling the Random function on the device which will receive the SIGont from the Read function. 15.3 OUTPUT PARAMETERS Table 261 describes each of the output parameters. 5 Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. SelectedWordsOfSelecte Selected words from selected memory vectors as requested by dMs MSelect and WordSelect. SelectedKeylds Selected Keylds as requested by KeyldSelect. RL Local random value added to the output signature(i.e SIGot).Refer to Figure 370. SIGout SIGout = SIGKeyRef(data I RL I RE) as shown in Figure 8. Refer to Section 10.1.3.1 for details. 15.3.1 SIGout Figure 370 shows the formatting of data for output signature generation. Table 262 gives the parameters included in SIGot 10 Parameter Length in bits Value set internally Value set from Input RIWSense 3 read constant = 000 Refer to Section 15.3.1.1 MSelect 4 KeyldSelect 8 WO 2004/050369 PCT/AU2003/001616 808 Chip/d 48 This QA Device's Chipid WordSelect 16 per M SelectedWordsOfSelecte 32 per word The appropriate words from the 0 dMs various Ms as selected by the caller RL 160 This QA Device's current R RE 160 15.3.1.1 RWSense An RIWSense value is present in the signed data to distinguish whether a signature was produced from a Read or produced for a WriteAuth. 5 The RWSense is set to a read constant (000) for producing a signature from a read function. The RWSense is set to a write constant (001) for producing a signature for a write function. The RWSense prevents signatures produced by Read to be subsequently sent into a WriteAuth function. Only signatures produced with RWSense set to write (001), are accepted by a write function. 10 15.4 FUNCTION SEQUENCE The Read command is illustrated by the following pseudocode: Accept input parameters-.KeyRef , SigOnly, MSelect, KeyIdSelect # Accept input parameter WordSelect based on MSelect 15 For i +- 0 to MaxM If(MSelect[i] = 1) Accept next WordSelect WordSelectTemp [i] +-WordSelect EndIf 20 EndFor Accept RE Check range of KeyRef.keyNum If invalid 25 ResultFlag +- InvalidKey Output ResultFlag Return EndIf 30 #Build SelectedwordsofSelectedus WO 2004/050369 PCT/AU2003/001616 809 k +-0 # k stores the word count for SelectedWordsOfSelectedMs SelectedWordsOfSelectedMs [k] +- 0 For i<- 0 to 3 If(MSelect[i] = 1) 5 For j +- 0 to MaxWordlrIM If (WordSelectTemp [i] [j] = 1) SelectedWordsofSelectedMs [k] <- (Mi [j ]) k++ Endlf 10 EndFor EndIf EndFor #Build SelectedKeylds 15 1 <-0# 1 stores the word count for SelectedKeyids SelectedKeyids [1] +- 0 For i <- O to MaxKey If(KeyIdSelect[i] = 1) SelectedKeylds [l] +- KeyId [i] 20 i++ EndIf EndFor 25 #Generate message for passing into the GenerateSignature function data +- (RWSense i MSelect I KeyIdSelect ChipId j WordSelect ISelectedWordsOfSelectedMs|SelectedKeyIds) # Refer to Figure 370. #Generate Signature function 30 SIG, +- GenerateSignature (KeyRef, data, R, RE) # See Section 11.1 Update RL to RL2 ResultFlag +-Pass Output ResultFlag If(SigOnly = 0) 35 Output SelectedWordsOfSelectedMs, SelectedKeyIds EndIf WO 2004/050369 PCT/AU2003/001616 810 Output RL, SIGL Return 16 Test Input: KeyRef, DataLength, Data, RE,SIGE 5 Output: ResultFlag Changes: RL Availability: All devices except ink device 16.1 FUNCTION DESCRIPTION The Test command is used to validate data that has been read from an untrusted QA Device 10 according to a digital signature SIGE. The data will typically be memory vector and Keyld data. S/GE (and its related RE) is the most recent signature -this will be the signature produced by Read if Translate was not used, or will be the output from the most recent Translate if Translate was used. The Test function produces a local signature (SIGL= SlGkey(Data|RERL) and compares it to the input signature (S/GE). If the two signatures match the function returns 'Pass', and the caller knows that 15 the data read can be trusted. The key used to produce SIG depends on whether S/GEwas produced by a QA Device sharing a common key or a variant key. The KeyRef object passed into the interface must be set appropriately to reflect this. The Test function accepts preformatted data (as DataLength number of words), and appends the 20 external RE and local RL to the preformatted data to generate the signature as shown in Figure 371. 16.2 INPUT PARAMETERS Table 263 describes each of the input parameters. Table 263. Description of input parameters for Test Parameter Description KeyRef For testing common key signature: KeyRef.keyNum = Slot number of the key to be used for testing the signature. SGE produced using KKeyRef.keyNum by the external device. KeyRef.useChipld = 0 For testing variant key signature: KeyRef.keyNum = Slot number of the key to be used for generating the variant key. S/GE produced using a variant of KKeyRef.keyNum by the external device. KeyRef.useChipid =,1 KeyRef.chipld = Chipid of the device which generated S/GE using a variant of KKeyRf.keyNum. DataLength Length of preformatted data in words. Must be non zero. Data Preformatted data to be used for producing the signature. RE External random value required for verifying the input signature. This will be the R from the input signature generator (i.e the device generating S/GE). SIGE External signature required for authenticating input data as shown in Figure 371.
WO 2004/050369 PCT/AU2003/001616 811 The external signature is generated either by a Read function or a Translate function. A correct S/GE = SIGKeYRe(Data I RE I RL). 16.2.1 Input signature verification data format Figure 371 shows the formatting of data for input signature verification. The data in Figure 371 (i.e. not RE or RL) is typically output from a Read function (formatted as per 5 Figure 370). The data may also be generated in the same format by the system from its cache as will be the case when it performs a Read using SigOnly = 1. 16.3 OUTPUT PARAMETERS Table 264 describes each of the output parameters. Table 264. Description of output parameters for Test 10 Parameter Description ResultFag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. 16.4 FUNCTION SEQUENCE The Test command is illustrated by the following pseudocode: Accept input parameters-.KeyRef, DataLength 15 # Accept input parameter- Data based on DataLength For i +-O to (DataLength - 1) Accept next word of Data 20 EndFor Accept input parameters - RE, SIGE Check range of KeyRef.keyNum 25 If invalid ResultFlag <- InvalidKey Output ResultFlag Return Endif 30 WO 2004/050369 PCT/AU2003/001616 812 #Generate signature SIGL +-GenerateSignature(KeyRef,Data,,RE,RL) # Refer to Figure 371. #Check signature 5 If(SIGL = SIGE) Update RL to RL2 ResultFlag +-Pass Else ResultFlag <- BadSig 10 Endlf Output ResultFlag Return 17 Translate Input: InputKeyRef, DataLength, Data, RE, SIGE, OutputKeyRef, RE2 15 Output: ResultFlag, RL2, SIGoa& Changes: RL Availability: Printer device, and possibly on other devices 17.1 FUNCTION DESCRIPTION It is possible for a system to call the Read function on QA Device A to obtain data and signature, 20 and then call the Test function on QA Device B to validate the data and signature. In the same way it is possible for a system to call the SignM function on a trusted QA Device B and then call the WriteAuth function on QA Device B to actually store data on B. Both of these actions are only possible when QA Devices A and B share secret key information. If however, A and B do not share secret keys, we can create a validation chain (and hence 25 extension of trust) by means of translation of signatures. A given QA Device can only translate signatures if it knows the key of the previous stage in the chain as well as the key of the next stage in the chain. The Translate function provides this functionality. The Translate function translates a signature from one based on one key to one based another key. The Translate function first performs a test of the input signature using the /nputKeyRef, and if the 30 test succeeds produces an output signature using the OutputKeyRef. The Translate function can therefore in some ways be considered to be a combination of the Test and Read function, except that the data is input into the QA Device instead of being read from it. The InputKeyRef object passed into Translate must be set appropriately to reflect whether SIGE was produced by a QA Device sharing a common key or a variant key. 35 The key used to produce output signature S/Gor depends on whether the translating device shares a common key or a variant key with the QA Device receiving the signature. The OutputKeyRef object passed into Translate must be set appropriately to reflect this.
WO 2004/050369 PCT/AU2003/001616 813 Since the Translate function does not interpret or generate the data in any way, only preformatted data can be passed in. The Translate function does however append the external RE and local RL to the preformatted data for verifying the input signature, then advances RL to RL2, and appends RL 2 and RE2 to the preformatted data to produce the output signature. This is done to protect the keys 5 and prevent replay attacks. The Translate functions translates: a signatures for subsequent use in Test, typically originating from Read a signatures for subsequent use in WriteAuth, typically originating from SignM In both cases, preformatted data is passed into the Translate function by the system. For translation 10 of data destined for Test, the data should be preformatted as per Figure 370 (all words except the Rs). For translation of signatures for use in WriteAuth, the data should be preformatted as per Figure 373 (all words except the Rs). 17.2 INPUT PARAMETERS Table 265 describes each of the input parameters. 15 Table 265. Description of input parameters for Translate Parameter Description InputKeyRef For translating common key input signature: lnputKeyRef.keyNum = Slot number of the key to be used for testing the signature. SIGE produced using KnputKeyRef.keyNum by the external device. /nputKeyRef. useChip/d = 0 For translating variant key input signatures: inputKeyRef.keyNum = Slot number of the key to be used for generating the variant key. SIGE produced using a variant of KjnputKeyRef keyNum by the external device. lnputKeyRef.useChipld 1 InputKeyRef.chipld = Chipld of the device which generated SIGE using a variant of KinputKeyReikeyNum DataLength: Length of data in words. Data Data used for testing the input signature and for producing the output signature. RE External random value required for verifying input signature. This will be the R from the input signature generator (i.e device generating SlGE). SIGE External signature required for authenticating input data.The external signature is either generated by a Read function, a Xfer/Rollback function or a Translate function. A correct SIGE = SIGKeyRO(Data I RE I RL). OutputKeyRe For generating common key output signature: OutputKeyRef.keyNum = Slot f number of the key for producing the output signature. SlGout produced using KOutputKeyRef.keyNum because the device receiving SlGout shares KoutputKeyRef.keyNum with the translating device. OutputKeyRef.useChipid = 0 WO 2004/050369 PCT/AU2003/001616 814 For generating variant key output signature: OutputKeyRefkeyNum = Slot number of the key to be used for generating the variant key. SiGout produced using a variant of KOutputeyRef keyNum because the device receiving SlGout shares a variant of KOutputKeyRef.keyNum with the translating device. OutputKeyRef.useChipld I OutputKeyRefchipld = Chipld of the device which receives SiGou produced by a variant of KoutputKeyRef.keyNum RE2 External random value required for output signature generation. This will be the R from the destination of S/Gout. RE2 is obtained by calling the Random function on the device which will receive the SIGoafrom the Translate function. 17.2.1 Input signature verification data format This is the same format as used in the Test function. Refer to Section 16.2.1. 17.3 OUTPUT PARAMETERS 5 Table 266 describes each of the output parameters. Table 266. Description of output parameters for Translate Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. RL2 Local random value used in output signature (i.e SIGout). S/Gout Output signature produced using OutputKeyRef.keyNum using the data format described in Figure 372. SlGou = SiGOutKeyRef(Data I RL2 1 RE 2 ).Refer to Section 10.1.3.1for details. 17.3.1 SIGut 10 Figure 372 shows the data format for output signature generation from the Translate function. 17.4 FUNCTION SEQUENCE The Translate command is illustrated by the following pseudocode: Accept input parameters-InputKeyRef, DataLength 15 # Accept input parameter- Data based on DataLength For i <-0 to (DataLength - 1) Accept next Data EndFor WO 2004/050369 PCT/AU2003/001616 815 Accept input parameters - RE, SIGE,OutputKeyRef, RE2 Check range of InputKeyRef.keyNum and OutputKeyRef.keyNum 5 If invalid ResultFlag <- Invalidkey Output ResultFlag Return EndIf 10 #Generate Signature SIGL +- GenerateSignature (InputKeyRef , Data, Rr, Rs) # Refer to Figure 371. #Validate input signature 15 If (SIG, = SIG,) Update RL to RL 2 Else ResultFlag <- BadSig Output ResultFlag 20 Return Endif #Generate output signature SIGout +- GenerateSignature (OutputKeyRef, Data, RE, R) Refer to 25 Figure 372. Update RL 2 to RL3 ResultFlag <-Pass Output ResultFlag, RL2, SIGut Return 30 18 WriteMl+ Input: VectNum, WordSelect, MVal Output: ResultFlag Changes: MVectNum Availability: All devices 35 WO 2004/050369 PCT/AU2003/001616 816 18.1 FUNCTION DESCRIPTION The WriteM1+ function is used to update selected words of M1+, subject to the permissions corresponding to those words stored in PvectNum Note: Unlike WriteAuth, a signature is not required as an input to this function. 5 18.2 INPUT PARAMETERS Table 267 describes each of the input parameters. Table 267. Description of input parameters for WriteM 1 + Parameter Description VectNum Number of the memory vector to be written. Must be in range 1 to (NumVectors -1) WordSelect Selection of words to be written. 0- indicates corresponding word is not written. 1- indicates corresponding word is to be written as per input. If WordSelect[N bit] is set, then write to MVectNum word N. MVaI Multiple of words corresponding to the number of words selected for write. Starts with LSW of MVeciNum. 10 Note: Since this function has no accompanying signatures, additional input parameter error checking is required. 18.3 OUTPUT PARAMETERS Table 268 describes each of the output parameters. Table 268. Description of output parameters for WriteM1 + 15 Parameter Description ResuitFiag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. 18.4 FUNCTION SEQUENCE The WriteM1+ command is illustrated by the following pseudocode: Accept input parameters VectNum, WordSelect 20 #Accept MVal as per WordSelect MValTemp[16] <-0 # Temporary buffer to hold MVal after being read For i <-O to MaxWordInM # word 0 to word 15 WO 2004/050369 PCT/AU2003/001616 817 If(WordSelect[i] = 1) Accept next MVal MValTemp[i] <-MVal # Store MVal in temporary buffer Endlf 5 EndFor Check range of VectNum If invalid ResultFlag <- InvalidVector 10 Output ResultFlag Return Endlf #Checking non authenticated write permission for M1+ 15 PermOK <- CheckMl+Perm (VectNum, WordSelect) #Writing M with MVal 20 If(PermOK =1) WriteM(VectNum,MValTemp []) ResultFlag <-Pass Else ResultFlag <- InvalidPermission 25 Endlf Output ResultFlag Return 18.4.1 PermOK CheckMl+Perm ( VectNum, WordSelect) This function checks WordSelect against permission PVectNum for the selected word. 30 For i <-0 to MaxWordInM # word 0 to word 15 If(WordSelect[i] = 1) A (PVectNum[i] = 0) # Trying to write a ReadOnly word Return PermOK<- 0 EndIf 35 EndFor Return PermOK+- 1 18.4.2 WriteM(VectNum, MValTemp[]) WO 2004/050369 PCT/AU2003/001616 818 This function copies MVaITemp to MVectNum For i <-O to MaxWordInM # Copying word from temp buff to M If (VectNum = 1) # If M1 PvectumT[i]& 0 # Set permission to ReadOnly before writing 5 EndIf Mvectium [i] < MValTemp [i] # copy word buffer to M word EndIf EndFor 10 19 WriteFields Input: FieldSelect, FieldVal Output: ResultFlag Changes: MVectNum Availability: All devices 15 19.1 FUNCTION DESCRIPTION The WriteFields function is used to write new data to selected fields (stored in MO). The write is carried out subject to the non-authenticated write access permissions of the fields as stored in the appropriate words of M1 (see Section 8.1.1.3). The WriteFields function is used whenever authorization for a write (i.e. a valid signature) is not 20 required. The WriteFieldsAuth function is used to perform authenticated writes to fields. For example, decrementing the amount of ink in an ink cartridge field is permitted by anyone via the WriteFields, but incrementing it during a refill operation is only permitted using WriteFieldsAuth. Therefore WriteFields does not require a signature as one of its inputs. 19.2 INPUT PARAMETERS 25 Table 269 describes each of the input parameters. Table 269. Description of input parameters for WriteFields Parameter Description FieldSelect Selection of fields to be written. 0- indicates corresponding field is not written. 1- indicates corresponding field is to be written as per input. If FieldSelect [N bit] is set, then write to Field N of MO. FieldVal Multiple of words corresponding to the words for all selected fields. Since FieldO starts at MO[1 5], FieldVal words starts with MSW of lower field.
WO 2004/050369 PCT/AU2003/001616 819 Note: Since this function has no accompanying signatures, additional input parameter error checking is required especially if the QA Device communication channel has potential for error. 19.3 OUTPUT PARAMETERS Table 270 describes each of the output parameters. 5 Table 270. Description of output parameters for WriteFields Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. 19.4 FUNCTION SEQUENCE The WriteFields command is illustrated by the following pseudocode: 10 Accept input parameters FieldSelect #Accept FieldVal as per FieldSelect into a temporary buffer MVa1 Temp 15 #Find the size of each FieldNum to accept FieldData FieldSize[16] +- O # Array to hold FieldSize assuming there are 16 fields NumFields+- FindNumberOf Fields1nMO (M1,FieldSi ze) 20 MValTemp [16] <- 0 # Temporary buffer to hold FieldVal after being read For i <-O to NumFields If FieldSelect[i] = 1 If i = 0 # Check if field number is 0 25 PreviousFieldEndPos <-MaxWordInM Else PreviousFieldEndPos +-M1[i-1] .EndPos # position of the last word for the # previous 30 field EndIf For j <- (PreviousFieldEndPos -1) to M1[FieldNum] .EndPos() WO 2004/050369 PCT/AU2003/001616 820 MValTemp[j] = Next FieldVal word #Store FieldVal in MVal Temp. EndFor EndIf 5 EndFor #Check non-authenticated write permissions for all fields in FieldSelect 10 PermOK +- CheckMONonAuthPerm(FieldSelect,MValTemp,MO,M1) #Writing MO with MValTemp if permissions allow writing If(PermOK =1) 15 WriteM (0, MValTemp) ResultFlag +-Pass Else ResultFlag +- InvalidPermission EndIf 20 Output ResultFlag Return 19.4.1 NumFields FindNumOfFieldsnMO(M 1,FieldSize[]) This function returns the number of fields in MO and an array FieldSize which stores the size of each field. 25 CurrPos <-0 NumFields <-C FieldSize[161 <- 0 # Array storing field sizes For FieldNum +- 0 to MaxWordInM 30 If(CurrPos = 0) # check if last field has reached Return FieldNum #FieldNum indicates number of fields in MO EndIf FieldSize [FieldNum] <- CurrPos - M1 [FieldNum] . EndPos If(FieldSize[FieldNum < 0) 35 Error # Integrity problem with field attributes WO 2004/050369 PCT/AU2003/001616 821 Return FieldNum # Lower MO fields are still valid but higher MO fields are # ignored Else 5 CurrPos<- Ml [FieldNum] .EndPos EndIf EndFor 19.4.2 WordBitMapForField GetWordMapForField(FiedNum,M1) This function returns the word bitmap corresponding to a field i.e the field consists of which 10 consecutive words. WordBitMapForField<- 0 WordMapTemp +-0 PreviousFieldEndPos 4-MI[FieldNum -1] .EndPos # position of the last word for the 15 # previous field For j +- (PreviousFieldEndPos +1) to M1[FieldNum] .EndPos() # Set bit corresponding to the word position WordMapTemp +- SHIFTLEFT (1, j) 20 WordBitMapForField +-WordMapTemp v WordsitMapForField EndFor Return WordBitMapForField 19.4.3 PermOK CheckMONonAuthPerm(FieldSelect,MValTemp[,MO,M1) This functions checks non-authenticated write permissions for all fields in FieldSelect. 25 PermOK CheckMONonAuthPerm() FieldSize[16] +-0 NumFields +- FindNumOfFieldsInMO (FieldSize) # Loop through all fields in FieldSelect and check their 4 non-authenticated permission 30 For i +-0 to NumFields If FieldSelect[i] 1 # check selected WordBitMapForField<- GetWordMapForField (i,M1) #get word bitmap for field PermOK 35 +- CheckFieldNonAuthPerm (i, WordBitMapForField, MValTemp, MO,) WO 2004/050369 PCT/AU2003/001616 822 # Check permission for field i in FieldSelect If(PermOK = 0) #Writing is not allowed, return if permissions for field 5 # doesn't allow writing Return PermOK EndIf Endif EndFor 10 Return PermOK 19.4.4 PermOK CheckFieldNonAuthPerm(FieldNum,WordBitMapForField, MValTemp{],MO) This function checks non authenticated write permissions for the field. DecrementOnly +<-0 15 AuthRW <- M1 [FieldNum] .AuthRW NonAuthRW +-M [FieldNum] .AuthRW If(NonAuthRW = 0) # No NonAuth write allowed Return PermOK<- 0 EndIf 20 If((AuthRW = 0) A (NonAuthRW = 1))# NonAuthRW allowed Return PermOK+-l ElseIf(AuthRW = 1) A (NonAuthRW = 1)# NonAuth DecrementOnly allowed PermOK 25 <- CheckInputDataForDecrementOnly (MO,MValTemp, WordBitMapForField) Return PermOK EndIf 19.4.5 PermOK CheckinputDataForDecrementOnly(MO,MValTemp[,WordBitMapForField) This function checks the data to be written to the field is less than the current value. 30 DecEncountered +- 0 LessThanFlag +-0 EqualToFlag +-0 For i = MaxWordInM to 0 If(WordBitMapForField[i] = 1) # starting word of the field 35 starting at MSW # comparing the word of temp buffer with MO current value WO 2004/050369 PCT/AU2003/001616 823 LessThanFlag <-MO[i] < MValTemp[i] EqualToFlag<- MO [i] = MValTemp [i # current value is less or previous value has been decremented If(LessThanFlag =1) V (DecEncountered = 1) 5 DecEncountered +-1 PermOK+- 1 Return PermOK ElseIf(EqualToFlag#1) 4 Only if the value is greater than current and decrement not encountered in previous words 10 PermOK+- 0 Return PermOK EndIf EndIf EndFor 15 19.4.6 WriteM(VectNum, MValTemp[]) Refer to Section 18.4.2 for details. 20 WriteFieldsAuth 20 Input: KeyRef, FieldSelect, FieldVal, RE, SIGE Output: ResultFlag Changes: Mo and RL Availability: All devices 20.1 FUNCTION DESCRIPTION 25 The WriteFieldsAuth command is used to securely update a number of fields (in Mo). The write is carried out subject to the authenticated write access permissions of the fields as stored in the appropriate words of M1 (see Section 8.1.1.3). WriteFieldsAuth will either update all of the requested fields or none of them; the write only succeeds when all of the requested fields can be written to. 30 The WriteFieldsAuth function requires the data to be accompanied by an appropriate signature based on a key that has appropriate write permissions to the field, and the signature must also include the local R (i.e. noncelchallenge) as previously read from this QA Device via the Random function. The appropriate signature can only be produced by knowing KKeyRef. This can be achieved by a call 35 to an appropriate command on a QA Device that holds a key matching KKeyRef. Appropriate commands include SignM, XferAmount, XferField, StartXfer, and StartRollBack. 20.2 INPUT PARAMETERS WO 2004/050369 PCT/AU2003/001616 824 Table 271 describes each of the input parameters for WriteAuth. Parameter Description KeyRef For common key signature generation: KeyRef.keyNum = Slot number of the key to be used for testing the input signature. KeyRef useChipld = 0 No variant key signature generation required FieldSelect Selection of fields to be written. 0- indicates corresponding field is not written. 1- indicates corresponding field is to be written as per input. If FieldSelect [N bit] is set, then write to Field N of MO. FieldVal Multiple of words corresponding to the total number of words for all selected fields. Since FieldO starts at M0[1 5], FieldVal words starts with MSW of lower field. RE External random value used to verify input signature. This will be the R from the input signature generator (i.e device generating S/GE). S/GE External signature required for authenticating input data. The external signature is either generated by a Translate or one of the Xfer functions. A correct SIGE = SIGKeyRef(data I RE I RL). 5 20.2.1 Input signature verification data format Figure 373 shows the input signature verification data format for the WriteAuth function. Table 272 gives the parameters included in S/GE for Write Auth Parameter Length in bits Value set internally Value set from Input RWSense 3 write constant = 001 Refer to Section 15.3.1.1 FieldNum 4 0 Chip/D 48 This QA Device's Chipid FieldData 32 per word 0 RE 160 RL 160 random value from device WO 2004/050369 PCT/AU2003/001616 825 20.3 OUTPUT PARAMETERS Table 273 describes each of the output parameters. Table 273. Description of output parameters for WriteAuth 5 Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. 20.4 FUNCTION SEQUENCE The WriteAuth command is illustrated by the following pseudocode: Accept input parameters-KeyRef, FieldSelect, 10 #Accept FieldVal as per FieldSelect into a temporary buffer MVa l Temp #Find the size of each FieldNum to accept FieldData 15 FieldSize(16] +- O # Array to hold FieldSize assuming there are 16 fields NumFields<- FindNumberOf FieldsInMD (M1,FieldSize) MValTemp[16] +-O # Temporary buffer to hold FieldVal after being 20 read For i <-O to NumFields If i = 0 # Check if field number is 0 PreviousFieldEndPos <- MaxWordInM Else 25 PreviousFieldEndPos +-Ml[i-li .EndPos # position of the last word for the previous field Endlf For j +- (PreviousFieldEndPos -1) to M1[FieldNum] .EndPos() MValTemp[j] = Next FieldVal word #Store FieldVal in MValTemp. 30 EndFor EndIf EndFor WO 2004/050369 PCT/AU2003/001616 826 Accept RE, SIGE Check range of KeyRef.keyNum If invalid range 5 ResultFlag <-InvalidKey Output ResultFlag Return Endif 10 #Generate message for passing to GenerateSignature function data +- (RWSense FieldSelectIChipId I FieldVal #Generate Signature SIGL <- GenerateSignature (KeyRef, data, RE, Rt) # Refer to Figure 373. 15 #Check signature If (SIGL = SIGE) Update RL to RL2 Else 20 ResultFlag <-BadSig Output ResultFlag Return Endif 25 #Check authenticated write permission for all fields in FieldSelect using KeyRef PermOK+- CheckMOAuthPerm(FieldSelect,MValTemp,MO,M1,KeyRef) If(PermOK = 1) 30 WriteM(D,MValTemp[])# Copy temp buffer to MO ResultFlag <-Pass Else ResultFlag <- InvalidPermission EndIf 35 Output ResultFlag Return 20.4.1 PermOK CheckMOAuthPerm(FieldSelect,MValTemp[,MO, M1, KeyRef) WO 2004/050369 PCT/AU2003/001616 827 This functions checks non-authenticated write permissions for all fields in FieldSelect using KeyRef. PermOK CheckMONonAuthPerm() FieldSize [16] +- 0 NumPields +- FindNumOfFieldsInMO (FieldSize) 5 # Loop through fields For i +-O to NumFields If FieldSelect[i] = 1 # check selected WordBitMapForField- GetWordMapForField (i,M1) #get word bitmap for field 10 PermOK <- CheckAuthFieldPerm(i,WordBitMapForField,MValTemp,MO, KeyRef) # Check permission for field i in FieldSelect If(PermOK = 0) #Writing is not allowed, return if #permissions for field doesn't allow writing 15 Return PermOK EndIf EndIf EndFor Return PermOK 20 20.4.2 PermOK CheckAuthFieldPerm( FieldNum, WordMapForField,MValTemp[, MO,KeyRef) This function checks authenticated permissions for an MO field using KeyRef (whether KeyRef has write permissions to the field). 25 AuthRW <- MI [FieldNum] .AuthRW KeyNumAtt - M1 [FieldNum] . KeyNum If (AuthRW = 0) # Check whether any key has write permissions Return PermOK<-O # No authenticated write permissions EndIf 30 # Check KeyRef has ReadWrite Permission to the field and it is locked If (KeyLockeyNu = locked) A (KeyNumAtt = KeyRef . keyNum) Return PermOK<- 1 35 Else # KeyNum is not a ReadWrite Key WO 2004/050369 PCT/AU2003/001616 828 Keyperms <-M [FieldNum] .DCForKeys # Isolate KeyPerms for FieldNum # Check Decrement Only Permission for Key 5 If(KeyPerms[KeyRef.keyNumj = 1) 4 Key is allowed to Decrement field PermOK <- CheckInputDataForDecrementOnly (MO,MValTemp, WordMapForField) Else 4 Key is a ReadOnly key 10 PermOK+-O EndIf EndIf Return PermOK 20.4.3 WordBitMapField GetWordMapForField(FieldNum,MI) 15 Refer to Section 19.4.2 for details. 20.4.4 PermOK ChecklnputDataForDecrementOnly(MO,MValTemp[],WordMapForField) Refer to Section 19.4.5 for details. 20.4.5 WriteM(VectNum, MValTemp[) Refer to Section 18.4.2 for details. 20 21 SetPerm Input VectNum, PermVal Output: ResultFlag, NewPerm Changes: Pn Availability: All devices 25 21.1 FUNCTION DESCRIPTION The SetPerm command is used to update the contents of PVectNum (which stores the permission for MVectNum). The new value for PVectNum is a combination of the old and new permission in such a way that the more restrictive permission for each part of PVectNum is kept. 30 MO's permissions are set by M1 therefore they can't be changed. Ml's permissions cannot be changed by SetPerm. M1 is a write-once memory vector and its permissions are set by writing to it. See Section 8.1.1.3 and Section 8.1.1.5 for more information about permissions.
WO 2004/050369 PCT/AU2003/001616 829 21.2 INPUT PARAMETERS Table 274 describes each of the input parameters for SetPerm. Parameter Description VectNum Number of the memory vector whose permission is being changed. PermVa Bitmap of permission for the corresponding Memory Vector. 5 Note: Since this function has no accompanying signatures, additional input parameter error checking is required. 21.3 OUTPUT PARAMETERS Table 275 describes each of the output parameters for SetPerm. 10 Parameter Description ResuitFag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. Perm If VectNum = 0, then no Perm is returned. If VectNum = 1, then old Perm is returned. If VectNum > 1, then new Perm is returned after PVectNum has been changed based on PermVal. 21.4 FUNCTION SEQUENCE The SetPerm command is illustrated by the following pseudocode: 15 Accept input parameters- VectNum, PermVal Check range of VectNum If invalid ResultFlag <- InvalidVector 20 Output ResultFlag Return Endif If(VectNum = 0) # No permssions for MO 25 ResultFlag <-Pass WO 2004/050369 PCT/AU2003/001616 830 Output ResultFlag Return ElseIf(VectNum = 1) ResultFlag <-Pass 5 Output ResultFlag Output P 1 Return ElseIf(VectNum >1) # Check that only 'RW' parts are being changed 10 # RW(l)-> RO(o), RO(O) ->RO(o), RW(l) ->RW(l) - valid change # RO(0) -+Rw(l) - Invalid change # checking for change from Readonly to ReadWrite temp+- ~PvectNu A PermVal If (temp =1 )# If invalid change is 1 15 ResultFlag <- InvalidPermission Output ResultFlag Else PVectNum <- PerVal ResultFlag <- Pass 20 Output ResultFlag Output PVectNum EndIf Return Endif 25 22 ReplaceKey Input: KeyRef, Keyld, KeyLock, EncryptedKey,RE, SIGE Output: ResuitFlag Changes: KKeyRef.keyNum and RL 30 Availability: All devices 22.1 FUNCTION DESCRIPTION The ReplaceKey command is used to replace the contents of a non-locked keyslot, which means replacing the key, its associated keyld, and the lock status bit for the keyslot. A key can only be replaced if the slot has not been locked i.e. the KeyLock for the slot is 0. The procedure for 35 replacing a key also requires knowledge of the value of the current key in the keyslot i.e. you can only replace a key if you know the current key.
WO 2004/050369 PCT/AU2003/001616 831 Whenever the ReplaceKey function is called, the caller has the ability to make this new key the final key for the slot. This is accomplished by passing in a new value for the KeyLock flag. A new KeyLock flag of 0 keeps the slot unlocked, and permits further replacements. A new KeyLock flag of I means the slot is now locked, with the new key as the final key for the slot i.e. no further key 5 replacement is permitted for that slot. 22.2 INPUT PARAMETERS Table 276 describes each of the input parameters for Replacekey. Parameter Description KeyRef For common key signature generation: KeyRef.keyNum = Slot number of the key to be used for testing the input signature, and will be replaced by the new key. KeyRef.useChipld = 0 No variant key signature generation required Key/d Keyld of the new key. The LSB represents whether the new key is a variant or a common key. KeyLock Flag indicating whether the new key should be the final key for the slot or not. (1 = final key, 0 = not final key) EncryptedKe SIGKold(REIRL) e Knewhere Kold = KeyRef.getkey(. Refer to Section 10.1.3.1 RE External random value required for verifying input signature. This will be the R from the input signature generator (device generating SIG). In this case the input signature is a generated by calling the GetProgramKey function on a Key Programming device. SIGE External signature required for authenticating input data and determining the new key from the EncryptedKey. 10 WO 2004/050369 PCT/AU2003/001616 832 22.2.1 Input signature generation data format Figure 374 shows the input signature generation data format for the ReplaceKey function. Table 277 gives the parameters included in S/GEfor ReplaceKey. Parameter Length in bits Value set internally Value set from Input Chip/d 48 This QA Device's Chipid Key/d 32 RE 160 0 EncryptedKey 160 0 5 22.3 OUTPUT PARAMETERS Table 278 describes each of the output parameters for ReplaceKey. Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. 10 22.4 FUNCTION SEQUENCE The ReplaceKey command is illustrated by the following pseudocode: Accept input parameters - KeyRef, KeyId, KeyLock, EncryptedKey,RE, SIGE 15 Check KeyRef.keyNum range If invalid ResultFlag - InvalidKey Output ResultFlag 20 Return EndIf #Generate message for passing to GenerateSignature function data +- (ChipIdI KeyId IKeyLockI RE I EncryptedKey) 25 #Generate Signature WO 2004/050369 PCT/AU2003/001616 833 SIGL <-GenerateSignature(KeyRef,data,Null,Null) # Refer to Figure 374. 5 # Check if the key slot is unlocked If (KeyLock # unlock) ResultFlag +- KeyAlreadyLocked Output ResultFlag 10 Return EndIf #Test SIG If (SIG, # SIG,) 15 ResultFlag <- BadSig Output ResultFlag Return EndIf SIGL <- GenerateSignature (Key, null, RE, RL) 20 Advance R, # Must be atomic - must not be possible to remove power and have Keyld and KeyNum mismatched. Also preferable for KeyLock, although not strictly required. Kxeymm +- SIG G EncryptedKey 25 KeyIdeNum <- Keyld KeyLockKeyNum +- KeyLock ResultFlag +- Pass Output ResultFlag Return 30 23 SignM Input: KeyRef, FieldSelect, FieldValLength, FieldVal, Chipid, RE Output: ResuitFlag, RL, SIGout Changes: RL Availability: Trusted device only 35 WO 2004/050369 PCT/AU2003/001616 834 23.1 FUNCTION DESCRIPTION The SignMfunction is used to generate the appropriate digital signature required for the authenticated write function WriteFieldsAuth. The SignM function is used whenever the caller wants to write a new value to a field that requires key-based write access. 5 The caller typically passes the new field value as input to the SignMfunction, together with the nonce (RE) from the QA Device who will receive the generated signature. The SignM function then produces the appropriate signature SIGoat. Note that S/G,, may need to be translated via the Translate function on its way to the final WriteFieldsAuth QA Device. The SignMfunction is typically used by the system to update preauthorisation fields ( Section 10 31.4.3). The key used to produce output signature SIGotdepends on whether the trusted device shares a common key or a variant key with the QA Device directly receiving the signature. The KeyRef object passed into the interface must be set appropriately to reflect this. 23.2 INPUT PARAMETERS 15 Table 279 describes each of the input parameters for SignM. Parameter Description KeyRef For generating common key output signature: Ref keyNum = Slot number of the key for producing the output signature.
SIG
0 ,t produced using KKeyRef.keyNum because the device receiving SIG,,. shares KKeyRef.keyNum with the trusted device. KeyRef.useChipid = 0 For generating variant key output signature: KeyRef.keyNum = Slot number of the key to be used for generating the Variant key. SGout produced using a variant of KKeyRef.keyNum because the device receiving SIGUt shares a variant of KKeyWe.keyNum with the trusted device. KeyRef.useChipid = 1 KeyRef.chip/d = ChipId of the device which receives S/Got. FieldNum Field number of the field that will be written to. Fie/dDataLengt The length of the FieldData in words. h FieldData The value that will be written to the field selected by FieldNum. RE External random value used in the output signature generation. RE is obtained by calling the Random function on the device, which will receive the SIGot from the SignM function, which in this case is the WriteAuth function or WO 2004/050369 PCT/AU2003/001616 835 the Translate function. Chipid Chip identifier of the device whose WriteAuth function will be called subsequently to perform an authenticated write to its Fie/dNum of MO. 23.3 OUTPUT PARAMETERS Table 280 describes each of the output parameters. Table 280. Description of output parameters for SignM 5 Parameter Description ResultFag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1. RL Internal random value used in the output signature. S/Gout SIGout = SIGKeyRef(data I RL I RE) as shown in Figure 373. As per Figure 373, RE is actually RL and RL is RE with respect to device producing SIGoa to be applied to WriteAuth function. 23.3.1 SIGot Refer to Section 20.2.1. 23.4 FUNCTION SEQUENCE 10 The SignMcommand is illustrated by the following pseudocode: Accept input parameters - KeyRef, FieldNum, FieldDataLength # Accept FieldData words For i = 0 to FieldValLength 15 Accept next FieldData EndFor Accept Chipld, RE 20 Check KeyRef.keyNum range If invalid ResultFlag <- InvalidKey Output ResultFlag Return 25 EndIf #Generate message for passing into the GenerateSignature function WO 2004/050369 PCT/AU2003/001616 836 data <- (RWSense I FieldSelectI Chipld FieldVal) #Generate Signature SIGout <-GenerateSignature(KeyRef,data,RL,RE) i- Refer to Section 5 20.2.1. Advance RLto RL2 ResultFlag <-Pass Output parameters ResultFlag, RLSIGout Return 10 FUNCTIONS ON A KEY PROGRAMMING QA DEVICE 24 Concepts The key programming device is used to replace keys in other devices. The key programming device stores both the old key which will be replaced in the device being 15 programmed, and the new key which will replace the old key in the device being programmed. The keys reside in normal key slots of the key programming device. Any key stored in the key programming device can be used as an old key or a new key for the device being programmed, provided it is permitted by the key replacement map stored within the key programming device. 20 Figure 375 is representation of a key replacement map. The Is indicates that the new key is permitted to replace the old key. The Os indicates that key replacement is not permitted for those positions. The positions in Figure 13 which are blank indicate a 0. According to the key replacement map in Figure 13, K 5 can replace K 1 , Kr can replace K 3 , K 4 , K 5
,K
7 ,
K
3 can replace K 2 , K 0 can replace K 2 , and K 2 can replace K 6 . No key can replace itself. 25 Figure 375._ Key replacement map The key replacement map must be readable from an external system and must be updateable by an authenticated write. Therefore, the key replacement map must be stored in an MO field. This requires one of the keys residing in the key programming device to be have ReadWrite access to the key replacement map. This key is referred to as the key replacement map key and is used to 30 update the key replacement map. There will one key replacement map field in a key programming device. No key replacement mappings are allowed to the key replacement map key because it should not be used in another device being programmed. To prevent the key replacement map key from being used in key replacement, in case the mapping has been accidentally changed, the key replacement 35 map key is allocated a fixed key slot of 0 in all key programming devices. If a GetProgram function is invoked on the key programming device with the key replacement map key slot number 0 it immediately returns an error, even before the key replacement map is checked.
WO 2004/050369 PCT/AU2003/001616 837 The keys Ko to K 7 in the key programming device are initially set during the instantiation of the key programming device. Thereafter, any key can be replaced on the key programming device by another key programming device If a key in a key slot of the key programming device is being replaced, the key replacement map for the old key must be invalidated automatically. This is done 5 by setting the row and column for the corresponding key slot to 0 For example, if K, is replaced, then column 1 and row 1 are set to 0, as indicated in Figure 376. The new mapping information for K 1 is then entered by performing an authenticated write of the key replacement map field using the key replacement map key. 24.1 KEY REPLACEMENT MAP DATA STRUCTURE 10 As mentioned in Section 24, the key replacement map must be readable by external systems and must be updateable using an authenticated write by the key replacement map key. Therefore, the key replacement map is stored in an Mo field of the key programming device. The map is 8 x 8 bits in size and therefore can be stored in a two word field. The LSW of key replacement map stores the mappings for Ko - K 3 .The MSW of key replacement map stores the mappings for K 4 - K 7 . Referring 15 to Figure 375, key replacement map LSW is 0x40092000 and MSW is 0x40224040. Referring to Figure 376, after K 1 is replaced in the key programming device, the value of the key replacement map LSW is 0x40090000 and MSW is 0x40224040. The key replacement map field has an M1 word representing its attributes. The attribute setting for this field is specified in Table 281. 20 Table 281. Key replacement map attribute setting Attribute Value Explanation name Type TYPEKEYMAP Indicates that the field value Refer to Appendix A. represents a key replacement map. Only one such field per key programming QA Device. KeyNum 0 Slot number of the key replacement map key. NonAuthRW 0 No non authenticated writes is permitted. AuthRW 1 Authenticated write is permitted. KeyPerms 0 No Decrement Only permission for any key. EndPos alue such that field size is 2 ords WO 2004/050369 PCT/AU2003/001616 838 24.2 BASIC SCHEME The Key Replacement sequence is shown Figure 377. Following is a sequential description of the transfer and rollback process: 1. The System gets a Random number from the QA Device whose keys are going to be 5 replaced. 2. The System makes a GetProgramKey Request to the Key Programming QA Device. The Key Programming QA Device must contain both keys for QA Device whose keys are being replaced Old Keys which are the keys that exist currently (before key replacement), and the New Keys which are the keys which the QA Device will have after a successful processing of the ReaplceKey 10 Request. The GetProgramKey Request is called with the Key number of the Old Key (in the Key Programming QA Device) and the Key Number of the New Key ( in the Key Programming QA Device), and the Random number from (1). The Key Programming QA Device validates the GetProgramKey Request based on the KeyReplacement map, and then produces the necessary GetProgramKey Output. The GetProgramKey Output consists of the encrypted New Key 15 (encryption done using the Old Key), along with a signature using the Old Key. 3. The System then applies GetProgramKey Output to the QA Device whose key is being replaced, by calling the ReplaceKey function on it, passing in the GetProgramKey Output. The ReplaceKey function will decrypt the encrypted New Key using the Old Key, and then replace its Old Key with the decrypted New Key. 20 25 Functions 25.1 GETPROGAMKEY Input: OldKeyRef, Chipid, RE, KeyLock, NewKeyRef Output: ResultFlag, R,,EncryptedKey, KeyldOfNewKey, SIG 1 " Changes: RL 25 Availability: Key programming device 25.1.1 Function description The GetProgramKey works in conjunction with the ReplaceKey command, and is used to replace the specified key and its Key/d. This function is available on a key programming device and produces the necessary inputs for the ReplaceKey function. The ReplaceKey command is then run 30 on the device whose key is being replaced. The key programming device must have both the old key and the new key programmed as its keys, and the key replacement map stored in one of its MO field, before GetProgramKey can be called on the device. Depending on the OldKeyRef object and the NewKeyRef object passed in, the GetProgramKey will 35 produce a signature to replace a common key by a common key, a variant key by a common key, a common key by a variant key or a variant key by a variant key.
WO 2004/050369 PCT/AU2003/001616 839 25.1.2 Input parameters Table 282 describes each of the input parameters for GetProgramKey. Parameter Description OldKeyRef Old key is a common key: OldKeyRef.keyNum = Slot number of the old key in the Key Programming QA Device. The device whose key is being replaced, shares a common key KOldKeyRef.keyNumwith the key programming device. OldKeyRef.useChipld = 0 Old key is a variant key KeyRef.keyNum = Slot number of the old keyin the Key Programming QA Device. that Will be used to generate the variant key. The device whose key is being replaced, shares a variant of KOdKeyRef.keyNum with the key programming device. OldKeyRef.useChipid = 1 OldKeyRef.chipld = Chipld of the device whose variant of KOldKeyRef.keyNum key is being replaced. Chip/d Chip identifier of the device whose key is being replaced. RE External random value which will be used in output signature generation. RE is obtained by calling the Random function on the device being programmed. This will also receive the SiGout from the GetProgramKey function. SIGout is passed in to RepilaceKey function. KeyLock Flag indicating whether the new key should be unlocked/locked into its slot. NewKeyRef New key is a common key: NewKeyRef.keyNum = Slot number of the new keyin the Key Programming QA Device. The device whose key is being replaced, will receive a common key K NewKeyRef.keyNum from the key pro gramming device. NewKeyRef.useChipld = 0 NewKey is a variant key: NewKeyRef.keyNum = Slot number of the new key in the Key Programming QA Device. that will be used to generate the new variant key. The device whose key is being replaced, will receive a new key which is a variant of KNewKeyRef.keyNum from the key programming device. NewKeyRef.useChipld = 1 NewKeyRef.chipld = Chipld of the device receiving a new key, the new key is a variant of the KNewKeyRefkeYNum. 5 WO 2004/050369 PCT/AU2003/001616 840 25.1.3 Output parameters Table 283 describes each of the output parameters for GetProgramKey. Parameter Description Resu/tFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1 and Table 284 RL Internal random value used in the output signature. EncryptedKey SIGKgOd(RLIRE) 0 Kn., KeyldOfNewKe Keyld of the new key.The LSB represents whether the new key is a variant y or a common key. SIGot S[Gou = SIGKol(data I RL I RE) 5 Table 284. ResultFlag definitions for GetProgramKey Result Flag Description InvalidKeyReplacementMap Key replacement map field invalid or doesn't exist. KeyReplacementNotAllowed Key replacement not allowed as per key replacement map. 25.1.3. 1 SIGout 10 Figure 378 shows the output signature generation data format for the GetProgramKey function. 25.1.4 Function sequence The GetProgramKey command is illustrated by the following pseudocode: Accept input parameters - OldKeyRef, ChipId, RE, KeyLock, 15 NewKeyRef # key replacement map key stored in KO, must not be used for key replacement 20 If(OldKeyRef.keyNum = 0) v (NewKeyRef.keyNum = 0) ResultFlag +-Fail Output ResultFlag Return EndIf 25 ----------------------------------- ----------- WO 2004/050369 PCT/AU2003/001616 841 CheckRange (OldKeyRef .keyNum) If invalid ResultFlag <- InvalidKey Output ResultFlag 5 Return Endif CheckRange (NewKeyRef .keyNum) If invalid 10 ResultFlag <- InvalidKey Output ResultFlag Return Endif 15 # Find MO words that represent the key replacement map WordSelectForKeyMapField <-GetWordSelectForKeyMapField (Ml) If (WordSelectForKeyMapField =0) ResultFlag <- InvalidKeyReplacementMap Output ResultFlag 20 Return EndIf #CheckMapPermits key replacement ReplaceOK 25 <-CheckMapPermits (WordSelectForKeyMapField,OldKeyNum,NewKeyNum) If(ReplaceOK = 0) ResultFlag <- KeyReplacementNotAllowed Output ResultFlag Return 30 EndIf #All checks are OK, now generate Signature with OldKey SIGL <- GenerateSignature (OldKeyRef, null, RL,RE ) #Get new key 35 KNewcey< NewKeyRef.getKey() #Generate Encrypted Key WO 2004/050369 PCT/AU2003/001616 842 EncryptedKey <- SIG,, ( KNeWKey #Set base key or variant key - bit 0 of KeyId If (NewKeyRef.useChipld = 1) 5 KeyId<-0x0001 A Ox0001 Else KeyId <- OX0001A OxO00 EndIf 10 #Set the new key Keyld to the Keyld - bits 1-30 of KeyId KeyIdOfNewKey<-SHIFTLEFT (KeyIdOfNewKey, 1) Keyld<- KeyId v KeyIdOfNewKey #Set the KeyLock as per input - bit 31 of Keyld 15 KeyLock<- SHIFTLEFT(KeyLock,31) #KeyId4- KeyId V KeyLock #Generate message for passing in to the GenerateSignature function data <- ChipId I Keyld I R, I EncryptedKey 20 #Generate output signature SIGout <- GenerateSignature (OldKeyRef, data, null,null) # Refer to Figure 378 Advance RLto RL2 25 ResultFlag <-Pass Output ResultFlag, RrSIGout,KeyId, EncryptedKey Return 25.1.4.1 WordSelectForField GetWordSelectForKeyMapField(M1) This function gets the words corresponding to the key replacement map in MO. 30 FieldSize[16] <-0 # Array to hold FieldSize assuming there are 16 fields NumFields <- FindNumberOf Fields InMO (Ml, FieldSi ze) #Find the key replacement map field 35 For i <-0 to NumFields If(TYPEKEYMAP = M1[il .Type) # Field is key map field WO 2004/050369 PCT/AU2003/001616 843 MapFieldNum <-i Return Endif EndFor 5 #Get the words corresponding to the key replacement map WordMapForField<- GetWordMapForField (MapFieldNum, M1) Return WordSelectForField 25.1.4.2 NumFields FindNumOfFieldsInMO(M1,FieldSize) 10 Refer to Figure 19.4.1 for details 25.1.4.3 WordMapForField GetWordMapForField(FieldNum,M1) Refer to Section 19.4.2 for details. 25.1.4.4 ReplaceOK CheckMapPermits(WordSelectForKeyMapField, OldKeyNum, NewKeyNum,MO) 15 This function checks whether key replacement map permits key replacement. #Isolate KeyReplacementMap based on WordSelectForKeyMaprield and Mo KeyReplacementMap [64 bit] 20 #Isolate permission bit corresponding for NewKeyNum in the map for OldKeyNm ReplaceOK +- KeyReplacementMap [ (OldKeyNum x 8 + NewKeyNum) bit] Return ReplaceOK 25.2 REPLACEKEY 25 Input: KeyRef, Keyld, KeyLock, EncryptedKey,RE, SIGE Output: ResultFlag Changes: KKeyNum and RL Availability: Key programming device 25.2.1 Function description 30 This function is used for replacing a key in a key programming device and is similar to the generic Rep/aceKey function(Refer to Section 24), with an additional step of setting the KeyRef.keyNum column and KeyRef.keyNum row key replacement map to 0. 25.2.2 input parameters Refer to Section 22. 35 25.2.3 Output parameters Refer to Section 22.
WO 2004/050369 PCT/AU2003/001616 844 25.2.4 Function sequence The ReplaceKey command is illustrated by the following pseudocode: Accept input parameters - KeyRef, Keyld, EncryptedKey,RE, SIGE 5 #Generate message for passing into GenerateSignature function data <- (ChipId!KeyId)REjEncryptedKey)# Refer to Figure 374. 10 # Validate KeyRef, and then verify signature ResultFlag = ValidateKeyRefAndSignature (KeyRef, data, RE, RL) If (ResultFlag # Pass) Output ResultFlag 15 Return EndIf # Check if the key slot is unlocked 20 Isolate KeyLock for KeyRef If (KeyLock = lock) ResultFlag <- KeyAlreadyLocked Output ResultFlag Return 25 Endif SIGL <- GenerateSignature (Key, Null, RE, RL) Advance RL # Find MO words that represent the key replacement map 30 WordSelectForKeyMapField <-GetWordSelectForKeyMapField (M1) # Set the bits corresponding to the KeyRef.keyNum row and column to 0 # i.e invalidate the key replacement map for KeyRef.keyNum. 35 #Must be done before the key is replaced and must be atomic with key replacement.
WO 2004/050369 PCT/AU2003/001616 845 SetFlag - SetKeyMapForKeyNum (WordSelectForKeyMapField, KeyRef .keyNum, MO) If (SetFlag = 1) # Must be atomic - must not be possible to remove power and have 5 KeyId and KeyNum mismatched KKeyN - SGL EncryptedKey KeyIdeyum - Keyld KeyLockKeyN. +- KeyLock 10 ResultFlag <-Pass Else ResultFlag +-Fail EndIf Output ResultFlag 15 Return 25.2.4.1 WordSelectForFeld GetWordSelectForKeyMapField(M1) Refer to Figure 25.1.4.1 for details. 25.2.4.2 SetFlag SetKeyMapForKeyNum(WordSelectForKeyMapFieldKeyNum, MO) This function invalidates the key replacement map for KeyNum. 20 #Isolate KeyReplacementMap based on WordSelectForKeyMapField and MO KeyReplacementMap [64 bit] # Set KeyNum row (all bits) to 0 in the KeyReplacementMap 25 For i = 0 to 7 KeyReplacementMap [ (KeyNum x 8 + i) bit] <- 0 EndFor # Set KeyNum column to 0 in the KeyReplacementMap 30 For i = 0 to 7 KeyReplacementMap [ (ix8 + KeyNum) bit] <- 0 EndFor SetFlag +- 1 Return SetFlag 35 WO 2004/050369 PCT/AU2003/001616 846 FUNCTIONS UPGRADE DEVICE (INK RE/FILL) 26 Concepts 5 26.1 PURPOSE In a printing application, an ink cartridge contains an Ink QA Device storing the ink-remaining values for that ink cartridge. The ink-remaining values decrement as the ink cartridge is used to print. When an ink cartridge is physically refilled, the Ink QA Device needs to be logically re/filled as well. Therefore, the main purpose of an upgrade is to refill the ink-remaining values of an Ink QA Device 10 in an authorised manner. The authorisation for a re/fill is achieved by using a Value Upgrader QA Device which contains all the necessary functions to re/write to the Ink QA Device. In this case, the value upgrader is called an Ink Refill QA Device, which is used to fill/refill ink amount in an Ink QA Device. When an Ink Refill QA Device increases (additive) the amount of ink-remaining in an Ink QA Device, 15 the amount of ink-remaining in the Ink Refill QA Device is correspondingly decreased. This means that the Ink Refill QA Device can only pass on whatever ink-remaining value it itself has been issued with. Thus an Ink Refill QA Device can itself be replenished or topped up by another Ink Refill QA Device. The Ink Refill QA Device can also be referred to as the Upgrading QA Device, and the Ink QA 20 Device can also be referred to as the QA Device being upgraded. The refill of ink can also be referred to as a transfer of ink, or transfer of amount/valu, or an upgrade. Typically, the logical transfer of ink is done only after a physical transfer of ink is successful. 26.2 REQUIREMENTS 25 The transfer process has two basic requirements: " The transfer can only be performed if the transfer request is valid. The validity of the transfer request must be completely checked by the Ink Refill QA Device, before it produces the required output for the transfer. It must not be possible to apply the transfer output to the Ink QA Device, if the Ink Refill QA Device has been already been rolled back for that particular 30 transfer. * A process of rollback is available if the transfer was not received by the Ink QA Device. A rollback is performed only if the rollback request is valid. The validity of the rollback request must be completely checked by the Ink Refill QA Device, before it adjusts its value to a previous value before the transfer request was issued. It must not be possible to rollback an 35 Ink Refill QA Device for a transfer which has already been applied to the Ink QA Device i.e the Ink Refill QA Device must only be rolled back for transfers that have actually failed. 26.3 BAsIc SCHEME WO 2004/050369 PCT/AU2003/001616 847 The transfer and rollback process is shown in Figure 379. Following is a sequential description of the transfer and rollback process: 1. The System Reads the memory vectors MO and M1 of the Ink QA Device. The output from the read which includes the MO and M1 words of the Ink QA Device, and a signature, is passed as 5 an input to the Transfer Request. It is essential that MO and Ml are read together. This ensures that the field information for MO fields are correct, and have not been modified, or substituted from another device. Entire MO and M1 must be read to verify the correctness of the subsequent Transfer Request by the Ink Refill QA Device. 2. The System makes a Transfer Request to the Ink Refill QA Device with the amount that must 10 be transferred, the field in the Ink Refill QA Device the amount must be transferred from, and the field in Ink QA Device the amount must be transferred to. The Transfer Request also includes the output from Read of the Ink QA Device. The Ink Refill QA Device validates the Transfer Request based on the Read output, checks that it has enough value for a successful transfer, and then produces the necessary Transfer Output. The Transfer Output typically consists of new field data for 15 the field being refilled or upgraded, additional field data required to ensure the correctness of the transfer/rollback, along with a signature. 3. The System then applies the Transfer Output to the Ink QA Device, by calling an authenticated Write function on it, passing in the Transfer Output. The Write is either successful or not. If the Write is not successful, then the System will repeat calling the Write function using the 20 same transfer output, which may be successful or not. If unsuccesful the System will initiate a rollback of the transfer. The rollback must be performed on the Ink Refill QA Device, so that it can adjust its value to a previous value before the current Transfer Request was initiated. It is not necessary to perform a rollback immediately after a failed Transfer. The Ink QA Device can still be used to print, if there is any ink remaining in it. 25 4. The System starts a rollback by Reading the memory vectors MO and M1 of the Ink QA Device. 5. The System makes a StartRollBack Request to the Ink Refill QA Device with same input parameters as the Transfer Request, and the output from Read in (4). The Ink Refill QA Device validates the StartRollBack Request based on the Read output, and then produces the necessary 30 Pre-rollback output. The Pre-rol/back output consists only of additional field data along with a signa ture. 6. The System then applies the Pre-rollback Output to the Ink QA Device, by calling an authenticated Write function on it, passing in the Pre-rollback output. The Write is either successful or not. If the Write is not successful, then either (6), or (5) and (6) must be repeated. 35 7. The System then Reads the memory vectors MO and M1 of the Ink QA Device. 8. The System makes a Rol/Back Request to the Ink Refill QA Device with same input parameters as the Transfer Request, and the output from Read (7). The Ink Refill QA Device WO 2004/050369 PCT/AU2003/001616 848 validates the RollBack Request based on the Read output, and then rolls back its field corresponding to the transfer. 26.3.1 Transfer As we mentioned, the Ink QA Device stores ink-remaining values in its MO fields, and its 5 corresponding M 1 words contains field information for its ink-remaining fields. The field information consists of the size of the field, the type of data stored in field and the access permission to the field. See Section 8.1.1 for details. The Ink Refill QA Device also stores its ink-remaining values in its MO fields, and its coressponding
M
1 words contains field information for its ink-remaining fields. 10 26.3.1.1 Authorisation The basic authorisation for a transfer comes from a key, which has authenticated ReadWrite permission (stored in field information as KeyNum) to the ink-remaining field (to which ink will be transferrred) in the Ink QA Device. We will refer to this key as the refill key. The refill key must also have authenticated decrement-only permission for the ink-remaining field (from which ink will be 15 transferred) in the Ink Refill QA Device. After validating the input transfer request, the Ink Refill QA Device will decrement the amount to be transferred from its ink-remaining field, and produce a transfer amount (previous ink-remaining amount in the Ink QA Device + transfer amount), additional field data, and a signature using the refill key. Note that the Ink Refill QA Device can decrement its ink-remaining field only if the refill key 20 has the permission to decrement it. The signature produced by the Ink Refill QA Device is subsequently applied to the Ink QA Device. The Ink QA Device will accept the transfer amount only if the signature is valid. Note that the signature will only be valid if it was produced using the refill key which has write permission to the ink-remaining field being written. 25 26.3.1.2 Data Type matching The Ink Refill QA Device validates the transfer request by matching the Type of the data in ink remaining information field of Ink QA Device to the Type of data in ink-remaining information field of the Ink Refill QA Device. This ensures that equivalent data Types are transferred i.e NetworkOEM1_infrared ink is not transferred to NetworkOEM1_cyan ink. 30 26.3.1.3 Addition validation Additional validation of the transfer request must also be performed before a transfer output is generated by the Ink Refill QA Device. These are as follows: * For the Ink Refill QA Device: 1. Whether the field being upgraded is actually present. 35 2. Whether the field being upgraded can hold the upgraded amount. * For the Ink QA Device: 1. Whether the field from which the amount is transferred is actually present.
WO 2004/050369 PCT/AU2003/001616 849 2. Whether the field has sufficient amount required for the transfer. 26.3.1.4 Rollback facilitation To facilitate a rollback, the Ink Refill QA Device will store a list of transfer requests processed by it. This list is referred to as the Xfer Entry cache. Each record in the list consists of the transfer 5 parameters corresponding to the transfer request. 26.3.2 Rollback A rollback request is validated by looking through the Xfer Entry of the Ink Refill QA Device and finding the request that should be rolled back. After the right transfer request is found the Ink Refill QA Device checks that the output from the transfer request was not applied to the Ink QA Device by 10 comparing the current Read of the Ink QA Device to the values in the Xfer Entry cache, and finally rolls back its ink-remaining field (from which the ink was transferred) to a previous value before the transfer request was issued. The Ink Refill QA Device must be absolutely sure that the Ink QA Device didn't receive the transfer. This factor determines the additional fields that must be written along with transfer amount, and also 15 the parameters of the transfer request that must be stored in the Xfer Entry cache to facilitate a rollback, to prove that the Printer QA Device didn't actually receive the transfer. 26.3.2.1 Sequence fields The rollback process must ensure that the transfer output (which was previously produced) for which the rollback is being performed, cannot be applied after the rollback has been performed. 20 How do we achieve this? There are two separate decrement-only sequence fields (SEQI and SEQ_2) in the Ink QA Device which can only be decremented by the Ink Refill QA Device using the refill key. The nature of data to be written to the sequence fields is such that either the transfer output or the pre-roilback output can be applied to the Ink QA Device, but not both i.e they must be mutually exclusive.Refer to Table 285 for details. 25 Table 285. Sequence field data for Transfer and Pre-rollback Function Sequence Field data Explanation written to Ink QA Device SEQ1 SEQ 2 Initialised OxFFFFFFFF OxFFFFFFFF Written using the sequence key which is different from the refill key Write using (Previous Value - 2) (Previous Value - 1) Written using the refill key using Transfer If Previous Value =intialised If Previous Value = the refill key which has Output value then OxFFFFFFFD intialised value decrement-only then OxFFFFFFFE permission on the fields. Value cannot be written if pre- WO 2004/050369 PCT/AU2003/001616 850 rollback output is already written. Write usiing (Previous Value - 1) (Previous Value - 2) Written using the refill key using Pre-rollback If Previous Value =intialised If Previous Value = the refill key which has value intialised value decrement-only then OxFFFFFFFE then OxFFFFFFFD permissionon the fields. Value can be written only if Transfer Output has not been written. The two sequence fields are initialised to OxFFFFFFFF using sequence key. The sequence key is different to the refill key, and has authenticated ReadWrite permission to both the sequence fields. The transfer output consists of the new data for the field being upgraded, field data of the two 5 sequence fields, and a signature using the refill key. The field data for SEQ_1 is decremented by 2 from the original value that was passed in with the transfer request. The field data for SEQ_2 is decremented by 1 from the original value that was passed in with the transfer request. The pre-rollback output consists only of the field data of the two sequence fields, and a signature using the refill key. The field data for SEQ_1 is decremented by 1 from the original value that was 10 passed in with the transfer request. The field data for SEQ_2 is decremented by 2 from the original value that was passed in with the transfer request. Since the two sequence fields are decrement-only fields, the writing of the transfer output to QA Device being upgraded will prevent the writing of the pre-rollback output to QA Device being upgraded. If the writing of the transfer output fails, then pre-rollback can be written. However, the 15 transfer output cannot be written after the pre-rollback has been written. Before a rollback is performed, the Ink Refill QA Device must confirm that the sequence fields was successfully written to the pre-rollback values in the Ink QA Device. Because the sequence fields are Decrement-Only fields, the Ink QA Device will allow pre-rollback output to be written only if the upgrade output has not been written. It also means that the transfer output cannot be written after 20 the pre-rollback values have been written. 26.3.2.1.1 Field information of the sequence data field For a device to be upgradeable the device must have two sequence fields SEQ 1 and SEQ_2 which are written with sequence data during the transfer sequence. Thus all upgrading QA devices, ink QA Devices and printer QA Devices must have two sequence fields. The upgrading QA Devices 25 must also have these fields because they can be upgraded as well. The sequence field information is defined in Table 286. Table 286. Sequence field information WO 2004/050369 PCT/AU2003/001616 851 Attribute Name Value Explanation Type TYPESEQ_1 or TYPESEQ_2. See Appendix A for exact value. KeyNum Slot number of the sequence key. Only the sequence key has authenticated ReadWrite access to this field. Non Auth RW 0 Non authenticated ReadWrite Perm is not allowed to the field. Auth RW Perm 1 Authenticated (key based) ReadWrite access is allowed to the field. KeyPerm KeyPerms[KeyNum] = 0 KeyNum is the slot number of the sequence key, which has ReadWrite permission to the field. KeyPerms[Slot number of the refill Refill key can decrement the sequence key] = 1 field. KeyPerms[others= 0 .. 7(except refill All other keys have ReadOnly access. key)] = 0 End Pos Set as required. Size is typically 1 word. 26.3.3 Upgrade states There are three states in an transfer sequence, the first state is initiated for every transfer, while the next two states are initiated only when the transfer fails. The states are - Xfer, StartRollback, and 5 Rollback. 26.3.3.1 Upgrade Flow Figure 380 shows a typical upgrade flow. 26.3.3.2 Xfer This state indicates the start of the transfer process, and is the only state required if the transfer is 10 successful. During this state, the Ink Refill QA Device adds a new record to its Xfer Entry cache, decrements its amount, produces new amount, new sequence data (as described in Section 26.3.2.1) and a signature based on the refill key. The Ink QA Device will subsequently write the new amount and new sequence data, after verifying the signature. If the new amount can be successfully written to the Ink QA Device, then this will 15 finish a successful transfer. If the writing of the new amount is unsuccessful (result returned is BAD SIG ), the System will re transmit the transfer output to the Ink QA Device, by calling the authenticated Write function on it again, using the same transfer output.
WO 2004/050369 PCT/AU2003/001616 852 If retrying to write the same transfer output fails repeatedly, the System will start the rollback process on Ink Refill QA Device, by calling the Read function on the Ink QA Device, and subsequently calling the StartRollBack function on the Ink Refill QA Device. After a successful rollback is performed, the System will invoke the transfer sequence again. 5 26.3.3.3 StartRollBack This state indicates the start of the rollback process. During this state, the Ink Refill QA Device produces the next sequence data and a signature based on the refill key. This is also called a pre rollback, as described in Section 26.3.2. The pre-rollback output can only be written to the Ink QA Device, if the previous transfer output has 10 not been written. The writing of the pre-rollback sequence data also ensures, that if the previous transfer output was captured and not applied, then it cannot be applied to the Ink QA Device in the future. If the writing of the pre-rollback output is unsuccessful (result returned is BAD SIG ), the System will re-transmit the pre-rollback output to the Ink QA Device, by calling the authenticated Write function 15 on it again, using the same pre-rollback output. If retrying to write the same pre-rollback output fails repeatedly, the System will call the StartRollback on the Ink Refill QA Device again, and subsequently calling the authenticated Write function on the Ink QA Device using this output. 26.3.3.4 Rollback 20 This state indicates a successful deletion (completion) of a transfer sequence. During this state, the Ink Refill QA Device verifies the sequence data produced from StartRollBack has been correctly written to Ink Refill QA Device, then rolls its ink-remaining field to a previous value before the transfer request was issued. 26.3.4 Xfer Entry cache 25 The Xfer Entry data structure must allow for the following: * Stores the transfer state and sequence data for a given transfer sequence. * Store all data corresponding to a given transfer, to facilitate a rollback to the previous value before the transfer output was generated. The Xfer Entry cache depth will depend on the QA Chip Logical Interface implementation. For some 30 implementations a single Xfer Entry value will be saved. If the Ink Refill QA Device has no powersafe storage of Xfer Entry cache, a power down will cause the erasure of the Xfer Entry cache and the Ink Refill QA Device will not be able to rollback to a pre-power-down value. A dataset in the Xfer Entry cache will consist of the following: * Information about the QA Device being upgraded: 35 a. Chipid of the device. b. FleldNum of the MO field (i.e what was being upgraded). e Information about the upgrading QA Device: WO 2004/050369 PCT/AU2003/001616 853 a. FieldNum of the MO field used to transfer the amount from. e XferVal - the transfer amount. * Xfer State- indicating at which state the transfer sequence is. This will consist of: a. State definition which could be one of the following: - Xfer, 5 StartRollBack and complete/deleted. b. The value of sequence data fields SEQ_1 and SEQ_2. 26.3.4.1 Adding new dataset A new dataset is added to Xfer Entry cache by the Xfer function. There are three methods which can be used to add new dataset to the Xfer Entry cache. The 10 methods have been listed below in the order of their priority: 1. Replacing existing dataset in Xfer Entry cache with new dataset based on Chipid and FieldNum of the Ink QA Device in the new dataset. A matching Chipid and FieldNum could be found because a previous transfer output corresponding to the dataset stored in the Xfer Entry cache has been correctly received and processed by the Ink Refill QA Device, and a 15 new transfer request for the same Ink QA Device, same field, has come through to the Ink Refill QA Device. 2. Replace existing dataset cache with new dataset based on the Xfer State. If the Xfer State for a dataset indicates deleted (complete), then such a dataset will not be used for any further functions, and can be overwritten by a new dataset. 20 3. Add new dataset to the end of the cache. This will automatically delete the oldest dataset from the cache regardless of the Xfer State. 26.4 DIFFERENT TYPES OF TRANSFER There can be three types of transfer: * Peer to Peer Transfer - This transfer could be one of the 2 types described below: 25 a. From an Ink Refill QA Device to a Ink QA Device. This is performed when the Ink QA Device is refilled by the Ink Refill QA Device. b. From one Ink Refill QA Device to another Ink Refill QA Device, where both QA Devices belong to the same OEM. This is typically performed when OEM divides ink from one Ink Refill QA Device to another Ink Refill QA Device, where both devices belong to the same 30 OEM e Heirachical Transfer- This is a transfer from one Ink Refill QA Device to another Ink Refill QA Device, where the QA Devices belong to different organisation, say ComCo and OEM. This is typically performed when ComCo divides ink from its refill device to several refill devices belonging to several OEMs. 35 Figure 381 is a representation of various authorised ink refill paths in the printing system. 26.4.1 Hierarchical transfer WO 2004/050369 PCT/AU2003/001616 854 Referring to Figure 381, this transfer is typically performed when ink is transferred from ComCo's Ink Refill QA Device to OEM's Ink Refill QA Device, or from QACo's Ink Refill QA Device to ComCo's Ink Refill QA Device. 26.4.1.1 Keys and access permission 5 We will explain this using a transfer from ComCo to OEM. There is an ink-remaining field associated with the ComCo's Ink Refill QA Device. This ink remaining field has two keys associated with: * The first key transfers ink to the device from another refill device (which is higher in the heirachy), fills/refills (upgrades) the device itself. This key has authenticated ReadWrite 10 permission to the field. " The second key transfers ink from it to other devices (which are lower in the heirachy), fills/refills (upgrades) other devices from it. This key has authenticated decrement-only permission to the field. There is an ink-remaining field associated with the OEM's Ink refill device. This ink-remaining field 15 has a single key associated with: 0 This key transfers ink to the device from another refill device (which is higher or at the same level in the hierarchy), fills/refills (upgrades) the device itself, and additionally transfers ink from it to other devices (which are lower in the heirachy), fills/refills (upgrades) other devices from it. Therefore, this key has both authenticated ReadWrite and decrement-only permission to the field. 20 For a successful transfer ink from ComCo's refill device to an OEM's refill device, the ComCo's refill device and the OEM's refill device must share a common key or a variant key. This key is fill/refill key with respect to the OEM's refill device and it is the transfer key with respect to the ComCo's refill device. For a ComCo to successfully fill/refill its refill device from another refill device (which is higher in the 25 heirachy possibly belonging to the QACo), the ComCo's refill device and the QACo's refill device must share a common key or a variant key. This key is fi//refill key with respect to the ComCo's refill device and it is the transfer key with respect to the QACo's refill device. 26.4.1.1.1 Ink - remaining field information Table 287 shows the field information for an Mo field storing logical ink-remaining amounts in the 30 refill device and which has the ability to transfer down the heirachy. Attribute Name Value Explanation Type For e.g - Type describing the logical ink stored in TYPEHIGHQUALITYBLACKINKa the ink-remaining field in the refill device. KeyNum Slot number of the refill key. Only the refill key has authenticated ReadWrite access to this field.
WO 2004/050369 PCT/AU2003/001616 855 Non Auth RW 0 Non authenticated ReadWrite Permb is not allowed to the field. Auth RW Perm" 1 Authenticated (key based) ReadWrite access is allowed to the field. KeyPerm KeyPerms[KeyNum] 0 KeyNum is the slot number of the refill key, which has ReadWrite permission to the field. KeyPerms[Slot Num of transfer key] = 1 Transfer key can decrement the field. KeyPerms[others= O..7(except transfer All other keys have ReadOnly access. key)] = 0 End Pos Set as required. Depends on the amount of logical ink the device can store and storage resolution i.e in picolitres or in microlitres. a. This is a sample type only and is not included in the Type Map in Appendix A. b. Non authenticated Read Write permission. c. Authenticated Read Write permission. 5 26.4.2 Peer to Peer transfer Referring to Figure 381, this transfer is typically performed when ink is transferred from OEM's Ink Refill Device to another Ink Refill Device belonging to the same OEM, or OEM's Ink Refill Device to Ink Device belonging to the same OEM. 26.4.2.1 Keys and access permission 10 There is an ink-remaining field associated with the refill device which transfers ink amounts to other refill devices (peer devices), or to other ink devices. This ink-remaining field has a single key associated with: e This key transfers ink to the device from another refill device (which is higher or at the same level in the heirachy), fills/refills (upgrades) the device itself, and additionally transfers ink 15 from it to other devices (which are lower in the heirachy), fills/refills (upgrades) other devices from it. This key is referred to as the fill/refil key and is used for both fill/refill and transfer. Hence, this key has both ReadWrite and Decrement-Only permission to the ink-remaining field in the refill device. 26.4.2.1.1 Ink-remaining field information 20 Table 288 shows the field information for an Mo field storing logical ink-remaining amounts in the refill device with the ability to transfer between peers.
WO 2004/050369 PCT/AU2003/001616 856 Attribute Name Value Explanation Type For e.g - Type describing the logical ink stored in the ink TYPE_H IGHQUALITYBL remaining field ACK INKa in the refill device. KeyNum Slot number of the refill Only the refill key has authenticated key. ReadWrite access to this field. Non Auth RW 0 Non authenticated ReadWrite Permb is not allowed to the field. Auth RW Perm 1 Authenticated (key based) ReadWrite access is allowed to the field. KeyPerm KeyPerms[KeyNum] = 1 KeyNum is the slot number of the refill key, which has ReadWrite and Decrement permission to the field. KeyPerms[others= 0 All other keys have ReadOnly access. ..7(except KeyNum)] 0 End Pos Set as required. Depends on the amount of logical ink the device can store and storage resolution - i.e in picolitres or in microlitres. a. This is a sample type only and is not included in the Type Map in Appendix A. b. Non authenticated Read Write permission. 5 c. Authenticated Read Write permission. 27 Functions 27.1 XFERAMOUNT Input: KeyRef, MoOfExternal, MlOfExternal, Chipld, FieldNumL, FieldNumE, XferValLength, XferVal, InputParameterCheck 10 (optional), RE, SIGE, RE2 Output: ResultFlag, FieldSelect, FieldVal, RL2, SIG I Changes: Mo and RL Availability Ink refill QA Device 27.1.1 Function description 15 The XferAmount function produces data and signature for updating a given No field. This data and signature when applied to the appropriate device through the WriteFieldsAuth function, will update the Mo field of the device.
WO 2004/050369 PCT/AU2003/001616 857 The system calls the XferAmount function on the upgrade device with a certain XferVal, this XferVal is validated by the XferAmount function for various rules as described in Section 27.1.4, the function then produces the data and signature for the passing into the WriteFieldsAuth function for the device being upgraded. 5 The transfer amount output consists of the new data for the field being upgraded, field data of the two sequence fields, and a signature using the refill key. When a transfer output is produced, the sequence field data in SEQ_1 is decremented by 2 from the previous value(as passed in with the input), and the sequence field data in SEQ_2 is decremented by 1 from the previous value (as passed in with the input). 10 Additional /nputParameterCheck value must be provided for the parameters not included in the SIGE, if the transmission between the System and Ink Refill QA Device is error prone, and these errors are not corrected by the transimission protocol itself. InputParameterCheck is SHA I[FieldNumL I FieldNumE I XferValLength I XferVal], and is required to ensure the integrity of these parameters, when these inputs are received by the Ink Refill QA Device. This will prevent an 15 incorrect transfer amount being deducted. The XferAmount function must first calculate the SHA-1[FieldNumL I FieldNumE I XferValLength | XferVa], compare the calculated value to the value received (InputParameterCheck) and only if the values match act upon the inputs. 27.1.2 Input parameters 20 Table 289 describes each of the input parameters for XferAmount function. Parameter Description KeyRef For comsmon key input and output signature: KeyRef.keyNum = Slot number of he key to be used for testing input signature and producing the output signature. SIGE produced using KKeyRef.keyNum by the QA Device being upgraded. SIGout produced using KKeyRef.keyNum for delivery to the QA Device being upgraded. KeyRef.useChipld = 0 For variant key input and output signatures: KeyRef.keyNum = Slot number of the key to be used for generating the variant key. SIGE produced using a variant of KKeyRef.keyNum by the QA Device being upgraded. SiGout produced using a variant of KKeyRef.keyNum for delivery to the QA Device being upgraded. KeyRefiuseChipld = 1 KeyRef.chipld = Chipid of the device which generated SIGE and will receive SiGout. Mo 0 fExternal All 16 words of Mo of the QA Device being upgraded. mlOfExternal All 16 words of mi of the QA Device being upgraded. Chip/d Chipld of the QA Device being upgraded.
WO 2004/050369 PCT/AU2003/001616 858 FieldNumL Mo field number of the local (refill) device from which the value will be transferred. FieldNumE M field number of the QA Device being upgraded to which the value will be transferred. XferValLength XferVal length in words.Non zero length required. XferVal The logical amount that will be transferred from the local device to the external device. RE External random value used to verify input signature. This will be the R from the input signature generator (i.e device generating SIG-). The input signal generator in this case, is the device being upgraded or a translation device. RE2 External random value used to produce output signature. This will be R obtained by calling the Random function on the device which will receive the SIGu from the XferAmount function. The device receiving the SIGut in this case, is the device being upgraded or a translation device. S/GE External signature required for authenticating input data. The input data in this case, is the output from the Read function performed on the device being upgraded. A correct SIGE = SIGKeyRe(Data R I RL) 27.1.2.1 Input signature verification data format The input signature passed in to the XferAmount function is the output signature from the Read function of the Ink QA Device. 5 Figure 382 shows the input signature verification data format for the XferAmount function. Table 290 gives the parameters included in S/GE for XferAmount. Parameter Length in bits Value set internally Value set from Input RWSense 3 000 Refer to Section 15.3.1.1 MSelect 4 0011 Key/dSelect 8 00000000 Chipld 48 Chipld of the QA Device being upgraded WordSelect for MO 16 All bits set to 1 WordSelect for M 1 16 All bits set to 1 WO 2004/050369 PCT/AU2003/001616 859 Mo 512 Nil 512 R- 160 RL 160 Based on the internal R The XferAmount function is not passed all the parameters required to generate SIGE. For producing SIGL which is used to test S/GE, the function uses the expected values of some the parameters. 27.1.3 Output parameters 5 Table 291 describes each of the output parameters for XferAmount. Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Table 47. FieldSelect Selection of fields to be written In this case the bit corresponding to SEQ_1, SEQ_2 and to FieldNumE are set to 1. All other bits are set to 0. FieldVal Updated data words for Sequence data field and FieldNumE for QA Device being upgraded. Starts with LSW of lower field. This must be passed as input to the WriteFieldsAuth function of the QA Device being upgraded. RL2 Internal random value required to generate output signature. This must be passed as input to the WriteFieldsAuth function or Translate function of the QA Device being upgraded. SlGD, Output signature which must be passed as an input to the WriteFieldsAuth function of the QA Device being upgraded. SIG,,it = SIGKveyse(data I RL2 I RE2) as per Figure 373. 10 WO 2004/050369 PCT/AU2003/001616 860 Table 292. Result Flag definitions for XferAmount ResultFlag Definition Description FieldNumElnvalid FieldNum to which the amount is being transferred, or which is being upgraded in the QA Device being upgraded is invalid. SeqFieldlnvalid The sequence field for the QA Device being upgraded is invalid. FieldNumEWritePermInvalid FieldNum to which the amount is being transferred, or which is being upgraded in the QA Device being upgraded has no authenticated write permission. FieldNumLlnvalid FieldNum from which the amount is being transferred, or from which the value is being copied in the Upgrading QA Device is invalid. FieldNumLWritePerm Invalid FieldNum from which the amount is being transferred in the Upgrading QA Device has no authenticated permission, or no authenticated permission with the KeyRef. TypeMismatch Type of the data from which the amount is being transferred in the Upgrading QA Device, doesn't match the Type of data to which the amount in being transferred in the Device being upgraded. UpgradeFieldElnvalid Only applicable for transferring count-remaining values. The upgrade field associated with the count-remaining field in the QA Device being upgraded is invalid. UpgradeFieldLinvalid Only applicable for transferring count-remaining values. The upgrade field associated with the count-remaining field in the Upgrading QA Device is invalid. UpgradeFieldMismatch Only applicable for transferring count-remaining values. Type of the data in the upgrade field in the Upgrading QA Device, doesn't match the Type of data in the upgrade field in the Device being upgraded. FieldNumESizelnsufficient FieldNum to which the amount is being transferred, or which is being upgraded in the QA Device is not big enough to store the transferred data. FieldNumLAmountlnsufficientFieldNum in the Upgrading QA Device from which the amount is being transferred doesn't have the amount required for the transfer. 27.1.3.1 SIGot 5 Refer to Section 20.2.1 for details. 27.1.4 Function sequence The XferAmount command is illustrated by the following pseudocode: WO 2004/050369 PCT/AU2003/001616 861 Accept input parameters-KeyRef, MOtExternal, M1OfExternal, ChipId, FieldNumL, FieldNumE, XferValLength # Accept XferVal words 5 For i <- O to XferValLength Accept next XferVal EndFor Accept RE, SIGE, RE2 10 #Generate message for passing into ValidateKeyRefAndSignature function data <- (RWSenselMSelectlKeyIdSelectIChipIdIWordSelectIMOlMl) # Refer to Figure 382. 15 --------- ---------- --- ----------- --- ------- # Validate KeyRef, and then verify signature ResultFlag = ValidateKeyRefAndSignature (KeyRef, data, RE, RL) If (ResultFlag 1 Pass) 20 Output ResultFlag Return EndIf 25 #Validate FieldNumE # FieldNumE is present in the device being upgraded PresentFlagFieldNumE <- GetFieldPresent (M1fExternal, FieldNumE) # Check FieldNumE present flag 30 If (PresentFlagFieldNumE # 1) ResultFlag +- FieldNumEinvalid Output ResultFlag Return EndIf 35 WO 2004/050369 PCT/AU2003/001616 862 # Check Seq Fields Exist and get their Field Num # Get Seqdata field SEQ_1 num for the device being upgraded XferSEQ_1FieldNum+(-GetFieldNum(M1OfExternal, SEQ_1) 5 # Check if the Seqdata field SEQ_1 is valid If(XferSEQ_1FieldNum invalid) ResultFlag (- SeqFieldinvalid 10 Output ResultFlag Return Endlf # Get Seqdata field SEQ_2 num for the device being upgraded XferSEQ_2FieldNum+-GetFieldNum(MlOfExternal, SEQ_2) 15 # Check if the Seqdata field SEQ_2 is valid If (XferSEQ_2FieldNum invalid) ResultFlag +- SeqFieldinvalid Output ResultFlag 20 Return EndIf #Check write permission for FieldNumE 25 PermOKFieldNumE <-CheckFieldNumEPerm(M10fExternal,FieldNumE) If (PermOKFieldNumE # 1) ResultFlag +- FieldNumEWritePermInvalid Output ResultFlag Return 30 EndIf #Check that both SeqData fields have Decrement-Only permission with the same key #that has write permission on FieldNumE 35 PermOKXferSeqData - CheckSeqDataFieldPerms (M1fExternal, XferSEQ 1FieldNum, XferSEQ 2FieldNum, FieldNumE) WO 2004/050369 PCT/AU2003/001616 863 If (PermOKferSeqData # 1) ResultFlag <- SeqWritePerm Invalid Output ResultFlag Return 5 Endif # Get SeqData SEQI data from device being upgraded GetFieldDataWords (XferSEQ 1FieldNum, 10 XferSEQlDataFromDevice, MOOfExternal, M10fExternal) # Get SeqData SEQ_2 data from device being upgraded GetFieldDataWords (XferSEQ_2FieldNum, XferSEQ 2DataFromDevice, 15 MOOfExternal,M1OfExternal) # FieldNumL is a present in the refill device PresentFlagFieldNumL - GetFieldPresent (Ml, FieldNumL) 20 If(PresentFlagFieldNumL # 1) ResultFlag <- FieldNumLinvalid Output ResultFlag Return Endlf 25 #Check permission for FieldNumL PermOKFieldNumL <- CheckFieldNumLPerm (Ml, FieldNumL,KeyRef) If(PermOKFieldNumL # 1) ResultFlag <- FieldNumLWritePerm Invalid 30 Output ResultFlag Return Endlf 35 #Find the type attribute for FieldNumE TypeFieldNumE +- FindFieldNumType(M 10fExternal,FieldNumE) WO 2004/050369 PCT/AU2003/001616 864 #Find the type attribute for FieldNumL TypeFieldNumL +- FindFieldNumType (Ml, FieldNumL) # Check type attribute for both fields match 5 If(TypeFieldNumE #TypeFieldNumL) ResultFlag <- TypeMismatch Output ResultFlag Return EndIf 10 Do this if the Refill Device is tranferring Count-remaining for Printer upgrades 15 # If the Type is count remaining, check that upgrade values associated with # the count remaining are valid. Refer to Section 28. for further details on # count remaining and upgrade value. 20 If (TypeFieldNumL = TYPECOUNTREMAINING)A (TypeFieldNumE =TYPE COUNT REMAINING) #Upgrade value field is lower adjoining field UpgradevalueFieldNumE = FieldNumE -1 If(UpgradeValueFieldNumE < 0) # upgrade field doesn't exist for 25 QA Device being upgraded ResultFlag +- UpgradeFieldEnvalid Output ResultFlag Return EndIf 30 UpgradeValueFieldNumL = FieldNumL - 1 If(UpgradeValueFieldNumL < 0) # upgrade field doesn't exist for local device ResultFlag +- UpgradeFieldLinvalid Output ResultFlag 35 Return Endlf WO 2004/050369 PCT/AU2003/001616 865 UpgradeValueCheckOK < UpgradeValCheck (UpgradeValueFieldNumL, ,M1, UpgradeValueFieldNumL,MOOfExternal,M1OfExternal,KeyRef) 5 If (UpgradeValueCheckOK = 0) ResultFlag <- UpgradeFieldMismatch Output ResultFlag Return EndIf 10 EndIf # Do this if Field Type is Count Remaining ........ end 15 #Check whether the device being upgraded can hold the transfer amount # (Xf erVal + AmountLeft OverFlow <- CanHold (FieldNumE, MOOfExternal, XferVal) If OverFlow error 20 ResultFlag <- FieldNumESizeinsufficient Output ResultFlag Return EndIf 25 #Check the refill device has the desired amount (XferVal < = AmountLeft) UnderFlow <-HasAmount (FieldNumL,MO,XferVal) If UnderFlow error 30 ResultFlag <- FieldNumLAmountinsufficient Output ResultFlag Return EndIf 35 # All checks complete ..... # Generate Seqdata for SEQ_1 and SEQ 2 fields WO 2004/050369 PCT/AU2003/001616 866 XferSEQ lDataToDevice = XferSEQ lDataFromDevice - 2 XferSEQ_2DataToDevice = XferSEQ_2DataFromDevice - 1 # Add DataSet to Xfer Entry Cache 5 AddDataSetToXferEntryCache (ChipId, FieldNumE, FieldNumL, XferLength, XferVal, XferSEQlDataFromDevice, XferSEQ2DataFromDevice) # Get current FieldDataE field data words to write to Xfer Entry 10 cache GetFieldDataWords (FieldNumE, FieldDataE, MOOfExternal, M1OfExternal) #Deduct XferVal from FieldNumL and Write new value 15 DeductAndWriteValToFieldNumL (XferVal, FieldNumL,MO) #Generate new field data words for FieldNumE. The current FieldDataE is added to 20 # XferVal to generate new FieldDataE GenerateNewFieldData (FieldNumE, XferVal, FieldDataE) # Generate FieldSelect and FieldVal for SeqData field SEQ_1, SEQ_2 and 25 # FieldDataE... CurrentFieldSelect+- 0 FieldVal <- 0 GenerateFieldSelectAndFieldVal (FieldNumE, FieldDataE, XferSEQ_ lFieldNum, XferSEQlDataToDevice,XferSEQ_2FieldNum, 30 XferSEQ_2DataToDevice, FieldSelect, FieldVal) #Generate message for passing into GenerateSignature function 35 data <- (RWSenselFieldSelectlChipIdIFieldVal)# Refer to Figure 373. #Create output signature for FieldNumE SIGout<- GenerateSignature (KeyRef , data, RL2, RE2) WO 2004/050369 PCT/AU2003/001616 867 Update RL2 to RL3 ResultFlag < Pass Output ResultFlag, FieldData, RL 2 ,SIGOUt Return 5 Endif 27.1.4.1 ResultFlag ValidateKeyRefAndSignature(KeyRef,data, RE,RG This function checks KeyRef is valid, and if KeyRef is valid, then input signature is verified using KeyRef. CheckRange (KeyRef .keyNum) 10 If invalid ResultFlag <- InValidKey Output ResultFlag Return EndIf 15 #Generate message for passing into GenerateSignature function data - (RWSensejMSelect|KeyIdSelect IChipldIWordSelect|MO|Ml) # Refer to Figure 382. 20 #Generate Signature SIGL <- GenerateSignature (KeyRef, data, Rr, RL) # Check input signature SIGE If (SIGL = SIGE) 25 Update RL to RL2 Else ResultFlag <-Bad Signature Output ResultFlag Return 30 Endlf 27.1.4.2 GenerateFieldSelectAndFeldVal (FieldNumE, FieldDataE, XferSEQ_1FeldNum, XferSEQ_1DataToDevice, XferSEQ_2FieldNum, XferSEQ_2DataToDevice, FieldSelect, FieldVal) This functions generates the FieldSelect and FieldVal for output from FieldNumE and its final data, 35 and data to be written to Seq fields SEQ_1 and SEQ_2. 27.1.4.3 PresentFlag GetFieldPresent(M1,FieldNum) This function checks whether FieldNum is a valid.
WO 2004/050369 PCT/AU2003/001616 868 FieldSize[16] - 0 # Array to hold FieldSize assuming there are 16 fields NumFields<- FindNumberOfFieldsInMO (M1,FieldSize) #Refer to Section 5 19.4.1 If (FieldNum< NumFields) PresentFlag*- 1 Else PresentFlag+- 0 10 EndIf Return PresentFlag 27.1.4.4 NumFields FindNumOfFieldsInMO (M1,FieldSize) Refer to Figure 19.4.1 for details. 27.1.4.5 FieldNum GetFieldNum(M1, Type) 15 This function returns the field number based on the Type. FieldSize[16] +-0 # Array to hold FieldSize assuming there are 16 fields NumFields*- FindNumberOfFieldsInMO (M1,FieldSize) #Refer to Section 19.4.1 20 For i = 0 to NumFields If(M1[i].Type = Type) Return i # This is field Num for matching field EndFor i = 255 # If Xfersession field was not found then return an 25 invalid value Return i 27.1.4.6 PermOK CheckFieldNumEPerm(MI,FieldNumE) This function checks authenticated write permission for FieldNum which holds the upgraded value. AuthRW +- M1 [FieldNum] .AuthRW 30 NonAuthRW <- M1 [FieldNum] .NonAuthRW If(AuthRW = 1) A(NonAuthRW = 0) PermOK <- 1 Else PermOK <- 0 35 EndIf Return PermOK WO 2004/050369 PCT/AU2003/001616 869 27.1.4.7 PermOK CheckSeqDataFieldPerms(M1, XferSEQlFiedNum, XferSEQ_2FieldNum, FieldNumE) This function checks that both SeqData fields have Decrement-Only permission with the same key that has write permission on FieldNumE. 5 KeyNumForFieldNumE +-M1 [FieldNumE] .KeyNum # Isolate KeyNum for the field that will # be upgraded # Isolate KeyNum for both SeqData fields and check that they can be written using the same key 10 KeyNumForSEQ_1 +- MI [XferSEQlFieldNum] .KeyNum KeyNumForSEQ_2 +- M1 [XferSEQ_2FieldNum] .KeyNum If (KeyNumForSEQ 1 # KeyNumForSEQ2) PermOK +- 0 Return PermOK 15 EndIf # Check that the write key for FieldNumE and SeqData field is not the same If (KeyNumForSEQ_1 = KeyNumForFieldNumE) PermOK +- 0 20 Return PermOK EndIf #Isolate Decrement-only permissions with the write key of FieldNumE KeyPermsSEQ_1 +- Ml [XferSEQlFieldNum] . KeyPerms [KeyNumForFieldNumE] 25 KeyPermsSEQ_2 +-Ml[XferSEQ_2FieldNum].KeyPerms[KeyNumForFieldNumE] # Check that both sequence fields have Decrement-Only permission for this key If (KeyPermsSEQ_1 = 0) v (KeyPermsSEQ_2 = 0) PermOK +- 0 30 Return PermOK EndIf PermOK +- 1 Return PermOK 27.1.4.8 AddDataSetToXferEntryCache (Chipid, FieldNumE, FieldNumL, 35 XferVal, SEQ_1Data, SEQ 2Data) WO 2004/050369 PCT/AU2003/001616 870 This function adds a new dataset to the Xfer Entry cache. Dataset is a single record in the Xfer Entrycache. Refer to Section 27 for details. # Search for matching ChipId FieldNumE is Cache 5 DataSet <-SearchDataSetInCache (ChipId, FieldNumE) # If found If(DataSet is valid) DeleteDataSetInCache(DataSet) # This creates a vacant dataset AddRecordToCache (ChipId, FieldNumE, FieldDataL, XferVal,SEQ 1Data, 10 SEQ_2Data) EndIf # Searches the cache for XferState complete/deleted Found+- SearchRecordsInCache (complete/deleted) If (Found =1) 15 AddRecordToCache (ChipId, FieldNumE, FieldDataL,XferVal,SEQ 1Data, SEQ_2Data) Else # This will overwrite the oldest DataSet in cache AddRecordToCache(Chipld, FieldNumE,FieldDataL,XferVal,SEQ 1Data, 20 SEQ_2Data) Return Endif Set XferState in record to Xfer Return 25 27.1.4.9 FieldType FindFieldNumType(MI,FieIdNum) This function gets the Type attribute for a given field. FieldType < M1 tFieldNum] .Type Return FieldType 27.1.4.10 PermOK CheckFieldNumLPerm(M,FieldNumL,KeyRef) 30 This function checks authenticated write permissions using KeyRef for FieldNumL in the refill device. AuthRW <- M1 [FieldNumL] . AuthRW KeyNumAtt <- M1 [FieldNumL] .KeyNum DOForKeys <-M1 [FieldNumL] .DOForKeys [KeyNum] 35 # Authenticated write allowed # ReadWrite key for field is the same as Input KeyRef.keyNum # Key has both ReadWrite and Decrementonly Permission WO 2004/050369 PCT/AU2003/001616 871 If (AuthRW = 1) A (KeyRef.keyNum = KeyNumAtt) A (DOForKeys = 1 PermOK<- 1 Else PermOK<- 0 5 EndIf Return. PermOK 27.1.4.11 CheckOK Upgrade ValCheck(FieldNum 1, MOOfFieldNum 1, M1 OfFieldNum 1, FieldNum2, MOOfFieldNum2, M1OfFieldNum2,KeyRef) This function checks the upgrade value corresponding to the count remaining. The upgrade value 10 corresponding to the count remaining field is stored in the lower adjoining field. To upgrade the count remaining field, the upgrade value in refill device and the device being upgraded must match. #Check authenticated write permissions is allowed to the field #Check that only one key has ReadWrite access, #and all other keys are ReadOnly access 15 PermCheckOKFieldNuml <-CheckUpgradeKeyForField (FieldNum1, M1OfFieldNuml, KeyRef) If(PermCheckOKFieldNuml # 1) CheckOK - 0 Return CheckOK 20 EndIf PermCheckOKFieldNum2 +-CheckUpgradeKeyForField (FieldNum2, MlOfFieldNum2, KeyRef) 25 If(PermCheckOKFieldNum2 # 1) CheckOK - 0 Return CheckOK EndIf 30 #Get the upgrade value associated with field GetFieldDataWords (FieldNum1, UpgradeValueFieldNuml, MOOfFieldNuml,M1 OfFieldNum1) #Get the upgrade value associated with field 35 GetFieldDataWords (FieldNum2, UpgradeValueFieldNum2, MOOfFieldNum2, M1 OfFieldNum2) WO 2004/050369 PCT/AU2003/001616 872 If (UpgradeValueFieldNum1 # UpgradeValueFieldNum2) CheckOK +- 0 Return CheckOK EndIf 5 # Get the type attribute for the field UpgradeTypeFieldNuml+- GetUpgradeType (FieldNuml, M1OfFieldNum1) UpgradeTypeFieldNum2- GetUpgradeType (FieldNum2, MlOfFieldNum2) If (UpgradeTypeFieldNuml # UpgradeTypeFieldNum2) CheckOK <- 0 10 Return CheckOK Endif CheckOK <-1 Return CheckOK 27.1.4.12 CheckOK CheckUpgradeKeyForField(FieldNum,M1,KeyRef) 15 This function checks that authenticated write permissions is allowed to the field. It also checks that only one key has ReadWrite access and all other keys have ReadOnly access. KeyRef which updates count remaining must not have write access to the upgarde value field. KeyNum 4-Ml[FieldNum] .KeyNum AuthRW <-M1 [FieldNum] .AuthRW 20 NonAuthRW +-M1 [FieldNum] .NonAuthRW DOForKeys<-M1 [FieldNum] .DOForKeys #Check that KeyRef doesn't have write permissions to the field If (KeyRef .keyNum = KeyNum) CheckOK +-0 25 Return CheckOK EndIf #AuthRW access allowed or NonAuthRW not allowed If (AuthRW = 0) V (NonAuthRW =1) CheckOK <-0 30 Return CheckOK EndIf For i +- O to 7 # Keys other than KeyNum are allowed ReadOnly access, # DecrementOnly access not allowed for other keys (not KeyNum) 35 If (i #KeyNum) A(DOForKeys[i] = 1) CheckOK <-0 WO 2004/050369 PCT/AU2003/001616 873 Return CheckOK Endlf #ReadWrite access allowed for KeyNum, #ReadWrite and DecrementOnly access not allowed for KeyNum. 5 If (i = KeyNum) A(DOForKeys[i] = 1) CheckOK +-O Return CheckOK EndIf EndFor 10 CheckOK <-1 Return CheckOK 27.1.4.13 Upgrade Type GetUpgrade Type(FieldNum, M1) This function gets the type attribute for the upgrade field. UpgradeType GetUpgradeType (FieldNum) 15 UpgradeType<-M1 [FieldNum .Type Return UpgradeType 27.1.4.14GetFieldDataWords(FieldNum,FieldData i, MO,M1) This function gets the words corresponding to a given field. CurrPos <- MaxWordInM 20 If FieldNum = 0 CurrPos +- MaxWordInM Else CurrPos +- (M1[FieldNum -1] .EndPos) -1 # Next lower word after last word of the 25 # previous field EndIf EndPos +- (Ml[FieldNun] .EndPos) For i +- EndPos to CurrPos j +- 0 30 FieldData[j] <-MO[i] #Copy MO word to FieldData array EndFor 27.2 STARTROLLBACK Input: KeyRef, moOfExternal, MlOfExternal, Chipid, FieldNumL, FieldNumE, InputParameterCheck (optional), RE, SIGE, RE2 35 Output: ResultFlag, FieldSelect, FieldVal, RL2, SIGut Changes: mo and RL WO 2004/050369 PCT/AU2003/001616 874 Availability Ink refill QA Device and Parameter Upgrader QA Device 27.2.1 Function description StartRollBack function is used to start a rollback sequence if the QA Device being upgraded didn't receive the transfer message correctly and hence didn't receive the transfer. 5 The system calls the function on the upgrading QA Device, passing in FleidNumE and Chipid of the QA Device being upgraded, and FieIdNumL of the upgrading QA Device. The upgrading QA Device checks that the QA Device being upgraded didn't actually receive the message correctly, by comparing the values read from the device with the values stored in the Xfer Entry cache. The values compared is the value of the sequence fields. After all checks are fulfilled, the upgrading QA 10 Device produces the new data for the sequence fields and a signature. This is subsequently applied to the QA Device being upgraded (using the WriteFieldAuth function), which updates the sequence fields SEQI and SEQ_2 to the pre-rollback values. However, the new data for the sequence fields and signature can only be applied if the previous data for the sequence fields produced by Xfer function has not been written. 15 The output from the StartRollBack function consists only of the field data of the two sequence fields, and a signature using the refill key. When a pre-rollback output is produced, then sequence field data in SEQ_ I (as stored in the Xfer Entry cache, which is what is passed in to the XferAmount function) is decremented by 1 and the sequence field data in SEQ_2 (as stored in the Xfer Entry cache, which is what is passed in to the XferAmount function) is decremented by 2. 20 Additional inputParameterCheck value must be provided for the parameters not included in the SIGE, if the transmission between the System and Ink Refill QA Device is error prone, and these errors are not corrected by the transimission protocol itself. InputParameterCheck is SHA 1[FieldNumL I FleidNumE], and is required to ensure the integrity of these parameters, when these inputs are received by the Ink Refill QA Device. 25 The StartRol/Back function must first calculate the SHA-1[FieldNumL I FieldNumE], compare the calculated value to the value received (InputParameterCheck) and only if the values match act upon the inputs. 27.2.2 Input parameters 30 Table 293 describes each of the input parameters for StartRollback function. Parameter Description KeyRef For common key input signature: KeyRef.keyNum = Slot number of the key to be used for testing input signature. SIGE produced using KKeyRef.keyNum by the QA Device being upgraded. KeyRef useChipld = 0 For variant key input signature: KeyRef.keyNum = Slot number of the key to be WO 2004/050369 PCT/AU2003/001616 875 used for generating the variant key for testing input signature. S/GE produced using a variant of KKeyRef.keyNum by the QA Device being upgraded. KeyRef.useChip/d I KeyRef.chipld = Chipid of the device which generated S/GE. MOfExternal All 16 words of Mo of the QA Device being upgraded which failed to upgrade. MIOfExternal All 16 words of m,1 of the QA Device being upgraded which failed to upgrade. Chip/d Chipld of the QA Device being upgraded which failed to upgrade. Fie/dNumL MO field number of the local (refill) device from which the value was supposed to transferred. FieldftumE Mo field number of the QA Device being upgraded to which the value couldn't be transferred. RE External random value used to verify input signature. This will be the R from the input signature generator (i.e device generating SIGE). The input signal generator in this case, is the device which failed to upgrade or a translation device. S/GE External signature required for authenticating input data. The input data in this case, is the output from the Read function performed on the device which failed to upgrade. A correct SIGE = SIGKeyRef(Data I RE I RL). 27.2.2.1 Input signature verification data format Refer to Section 27.1.2.1. 27.2.3 Output parameters 5 Table 294 describes each of the output parameters for StartRollback function. Parameter Description Resu/tFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1,Table 292 and Table 295. FieldSelect Selection of fields to be written In this case the bits corresponding to SEQ_1 and SEQ_2 are set to 1. All other bits are set to 0. FieldVal Updated data for sequence datat field for QA Device being upgraded. This must be passed as input to the WriteFieldsAuth function of the QA Device being upgraded. RL2 Internal random value required to generate output signature. This must be passed as input to the WriteFieldsAuth function or Translate WO 2004/050369 PCT/AU2003/001616 876 function of the QA Device being upgraded. SIGot Output signature which must be passed as an input to the WriteFieldsAuth function of the QA Device being upgraded. SIGo, = SIGKeyRef(dataI RL2 I RE2) as per Figure 373. Table 295. Result definition for StartRollBack ResultFlag Definition Description RollBackinvalid RollBack cannot be performed on the request because parameters for rollback is incorrect. 5 27.2.3.1 SIGo Refer to Section 20.2.1 for details. 27.2.4 Function sequence The StartRollBack command is illustrated by the following pseudocode: 10 Accept input parameters-KeyRef, MOOfExternal, M1OfExternal, Chipid, FieldNumL, FieldNumE, RE, SIGE, RE2 Accept RE, SIGE, RE2 #Generate message for passing into ValidateKeyRefAndSignature 15 function data <- (RWSensejMselect ]KeyIdSelect I ChipId]WordSelect ]MO ]M1) # Refer to Figure 382. 20 # validate KeyRef, and then verify signature ResultFlag = ValidateKeyRefAndSignature (KeyRe f ,data, RE, RL) If (ResultFlag # Pass) output ResultFlag Return 25 EndIf --------------------------------------------------------- -----# Check Seq Fields Exist and get their Field Num # Get Seqdata field SEQ_1 num for the device being upgraded XferSEQlFieldNum+-GetFieldNum(M1OfExternal, SEQ_1) 30 WO 2004/050369 PCT/AU2003/001616 877 # Check if the Seqdata field SEQ 1 is valid If(XferSEQlFieldNum invalid) ResultFlag <- SeqFieldlnvalid 5 Output ResultFlag Return EndIf # Get Seqdata field SEQ_2 num for the device being upgraded XferSEQ_2FieldNum+-GetFieldNum(MlOfExternal, SEQ_2) 10 # Check if the Seqdata field SEQ_2 is valid If(XferSEQ_2FieldNum invalid) ResultFlag +- SeqFieldlnvalid Output ResultFlag 15 Return EndIf # Get SeqData SEQ_1 data from device being upgraded 20 GetFieldDataWords (XferSEQ_1FieldNum, XferSEQlDataFromDevice, MOOfExternal, M10fExternal) # Get SeqData SEQ 2 data from device being upgraded 25 GetFieldDataWords (XferSEQ_2FieldNum, XferSEQ_2DataFromDevice, MOOfExternal,M1OfExternal) 30 # Check Xfer Entry in cache is correct - dataset exists, Field data # and sequence field data matches and Xfer State is correct XferEntryOK <- CheckEntry(ChipId, FieldNumE, FieldNumL, XferSEQ 1DataFromDevice, XferSEQ2DataFromDevice) 35 If( XferEntryOK= 0) ResultFlag +- RollBackinvalid WO 2004/050369 PCT/AU2003/001616 878 Output ResultFlag Return Endif 5 # Generate Seqdata for SEQ 3 and SEQ_2 fields XferSEQ 1DataToDevice = XferSEQ 1DataFromDevice - 1 XferSEQ_2DataToDevice = XferSEQ_2DataFromDevice - 2 10 # Generate FieldSelect and FieldVal for sequence fields SEQl and SEQ_2 CurrentFieldSelect- 0 FieldVal <- 0 GenerateFieldSelectAndFieldVal (XferSEQ_1FieldNum, 15 XferSEQ_1DataToDevice, XferSEQ_2FieldNum, XferSEQ_2DataToDevice, FieldSelect, FieldVal) #Generate message for passing into GenerateSignature function data <- RWSenseiFieldSelectIChipIdjFieldVal)# Refer to Figure 373. 20 #Create output signature for FieldNumE SIGout+- GenerateSignature (KeyRef , data, R 2 , RE 2 ) Update RL2 to RM ResultFlag <-Pass Output ResultFlag, FieldData, RL 2 ,SIGout 25 Return EndIf 27.3 ROLLBACKAMOUNT Input: KeyRef, moOfExternal, mlOfExternal, Chipid, FieldNumL, FleldNumE, InputParameterCheck (optional), RE, SIGE 30 Output: ResultFlag Changes: mo and RL Availablity: Ink refill QA Device 27.3.1 Function description RolBackAmount function finally adjusts the value of the FieldNumL of the upgarding QA Device to a 35 previous value before the transfer request, if the QA Device being upgraded didn't receive the transfer message correctly (and hence was not upgraded).
WO 2004/050369 PCT/AU2003/001616 879 The upgrading QA Device checks that the QA Device being upgraded didn't actually receive the transfer message correctly, by comparing the sequence data field values read from the device with the values stored in the Xfer Entry cache. The sequence data field values read must match what was previously written using the StartRoltBack function. After all checks are fulfilled, the upgrading 5 QA Device adjusts its FieldNumL. Additional /nputParameterCheck value must be provided for the parameters not included in the SIGE, if the transmission between the System and Ink Refill QA Device is error prone, and these errors are not corrected by the transimission protocol itself. InputParameterCheck is SHA 1[FieldNumL I Fie/dNumE], and is required to ensure the integrity of these parameters, when these 10 inputs are received by the Ink Refill QA Device. The Rol/BackAmount function must first calculate the SHA-1[FieldNumL I FieldNumE], compare the calculated value to the value received (/nputParameterCheck) and only if the values match act upon the inputs. 27.3.2 Input parameters 15 Table 296 describes each of the input parameters for RollbackAmount function. Parameter Description KeyRef For common key input signature: KeyRef.keyNum = Slot number of the key to be used for testing input signature. SIGE produced using KKeyRef.keyNum by the QA Device being upgraded. KeyRef.useChipld = 0 For variant key input signature: KeyRef.keyNum = Slot number of the key to be used for generating the variant key for testing input signature. SIGE produced using a variant of KKeyRef.keyNum by the QA Device being upgraded. KeyRef.useChipld 1 KeyRef.chip/d = Chipid of the device which generated SIGE, MOfExterna/ All 16 words of Mo of the QA Device being upgraded which failed to upgrade.
M
1 OfExternal All 16 words of mi of the QA Device being upgraded which failed to upgrade. Chip/d Chipid of the QA Device being upgraded which failed to upgrade. FieldNumL MO field number of the local (refill) device from which the value was supposed to transferred. FieldNumE Mo field number of the QA Device being upgraded to which the value was not transferred. RE External random value used to verify input signature. This will be the R from the input signature generator (i.e device generating SIGE). The input signal generator in this case, is the device which failed to upgrade or a translation device. S/GE External signature required for authenticating input data. The input data in this WO 2004/050369 PCT/AU2003/001616 880 case, is the output from the Read function performed on the device which failed to upgrade. A correct SiGE= SIGKeyRe(Data I RE RL) 27.3.2.1 Input signature generation data format Refer to Section 27.1.2.1 for details. 27.3.3 Output parameters 5 Table 297 describes each of the output parameters for RollbackAmount. Parameter Description Resu/tFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1, Table 292 and Table 295. 27.3.4 Function sequence 10 The Rol/BackAmount command is illustrated by the following pseudocode: Accept input parameters-KeyRef, M0OfExternal, M1OfExternal, ChipId, FieldNumL, FieldNumE, RE, SIGE #Generate message for passing into ValidateKeyRefAndSignature 15 function data <- (RWSense|MSelect|KeyIdSelect IChipId WordSelect MO|Ml) # Refer to Figure 382. # Validate KeyRef, and then verify signature 20 ResultFlag = ValidateKeyRefAndSignature (KeyRef,data,R,RL) If (ResultFlag # Pass) Output ResultFlag Return EndIf 25 ---------- # Check Seq Fields Exist and get their Field Num # Get Seqdata field SEQ_1 num for the device being upgraded XferSEQ 1FieldNum<-GetFieldNum(M10fExternal, SEQ_1) 30 # Check if the Seqdata field SEQ 1 is valid WO 2004/050369 PCT/AU2003/001616 881 If(XferSEQ_1FieldNum invalid) ResultFlag +- SeqFieldinvalid Output ResultFlag Return 5 EndIf # Get Seqdata field SEQ_2 num for the device being upgraded XferSEQ_2FieldNum<-GetFieldNum(MlfExternal, SEQ_2) # Check if the Seqdata field SEQ_2 is valid 10 If(XferSEQ_2FieldNum invalid) ResultFlag <- SeqFieldinvalid Output ResultFlag Return Endif 15 # Get SeqData SEQ_1 data from device being upgraded GetFieldDataWords (XferSEQ lFieldNum, 20 XferSEQ lDataFromDevice,MOOfExternal, MlOfExternal) # Get SeqData SEQ_2 data from device being upgraded GetFieldDataWords (XferSEQ2FieldNum, XferSEQ 2DataFromDevice, 25 MoOfExternal , M1OfExternal) # Generate Seqdata for SEQ_1 and SEQ_2 fields with the data that is read 30 XferSEQ lData = XferSEQ lDataFromDevice + 1 XferSEQ_2Data = XferSEQ_2DataFromDevice + 2 # Check Xfer Entry in cache is correct - dataset exists, Field data 35 # and sequence field data matches and Xfer State is correct XferEntryOK +-CheckEntry(ChipId, FieldNumE, FieldNumL, XferSEQlData, XferSEQ_2Data) WO 2004/050369 PCT/AU2003/001616 882 If( XferEntryCK= 0) ResultFlag <-RollBackInvalid Output ResultFlag 5 Return EndIf # Get AFieldDataL from DataSet GetVal(ChipId, FieldNumE,AFieldDataL) # Add AFieldDataL to FieldNumL 10 AddValToField(FieldNumL,AFieldDataL) # Update XferState in DataSet to complete/deleted UpdateXferStateToComplete(ChipId,FieldNumE) ResultFlag <-Pass Output ResultFlag 15 Return WO 2004/050369 PCT/AU2003/001616 883 FUNCTIONS UPGRADE DEVICE (PRINTER UPGRADE) 28 Concepts 5 This section is very similar to Section 26. The differences between this section and Section 26 have been summarised and underlined, where required. 28.1 PURPOSE In a printing application, a printer contains a Printer QA Device, which stores details of the various operating parameters of a printer, some of which may be upgradeable. The upgradeable 10 parameters must be written (initially) and changed in an authorised manner. The authorisation for the write or change is achieved by using a Parameter Upgrader QA Device which contains the necessary functions to allow a write or a change of a parameter value (e.g. a print speed) into another QA Device, typically a printer QA Device. This QA Device is also referred to as an upgrading QA Device. 15 A parameter upgrader QA Device is able to perform a fixed number of upgrades, and this number is effectively a consumable value. The number of upgrades remaining is also referred to as count remaining. With each write/change of an operating parameter in a Printer QA Device, the count remaining decreases by 1, and can be replenished by a value upgrader QA Device. The Parameter Upgrader QA Device can also be referred to as the Upgrading QA Device, and the 20 Printer QA Device can also be referred to as the QA Device being upgraded. The writing or changing of the parameter can also be referred to as a transfer of a parameter. The Parameter Uipgrader QA Device copies its parameter value field to the parameter value field of Printer QA Device, and decrements the count-remaininq field associated with the parameter value field by 1. 25 28.2 REQUIREMENTS The transfer of a parameter has two basic requirements: * The transfer can only be performed if the transfer request is valid. The validity of the transfer request must be completely checked by the Parameter Upgrader QA Device, before it produces the required output for the transfer. It must not be possible to apply the transfer 30 output to the Printer QA Device, if the Parameter Upgrader QA Device has been already been rolled back for that particular transfer. * A process of rollback is available if the transfer was not received by the Printer QA Device. A rollback is performed only if the rollback request is valid. The validity of the rollback request must be completely checked by the Parameter Upgrader QA Device, before the 35 count-remaining value is incremented by 1. It must not be possible to rollback an Parameter Upgrader QA Device for a transfer, which has already been applied to the Printer QA WO 2004/050369 PCT/AU2003/001616 884 Device i.e the Parameter Upgrader QA Device must only be rolled back for transfers that have actually failed. 28.3 BASIC SCHEME 5 The transfer and rollback process is shown in Figure 383. Following is a sequential description of the transfer and rollback process: 1. The System Reads the memory vectors MO and M1 of the Printer QA Device. The output from the read which includes the MO and M1 words of the Printer QA Device, and a signature, is passed as an input to the Transfer Request. It is essential that MO and M1 are 10 read together. This ensures that the field information for MO fields are correct, and have not been modified, or substituted from another device. Entire MO and M1 must be read to verify the correctness of the subsequent Transfer Request by the Parameter Upgrader QA Device. 2. The System makes a Transfer Request to the Parameter Upgrader QA Device with the field in the Parameter Upgrader QA Device whose data will be copied to the Printer QA Device, 15 and the field in Printer QA Device to which this data will be copied to. The Transfer Request also includes the output from Read of the Printer QA Device. The Parameter Upgrader QA Device validates the Transfer Request based on the Read output, checks that it has enough count-remaining for a successful transfer, and then produces the necessary Transfer output. The Transfer Output typically consists of new field data for the field being refilled or 20 upgraded, additional field data required to ensure the correctness of transfer/rollback, along with a signature. 3. The System then applies the Transfer Output on the Printer QA Device, by calling an authenticated Write on it, passing in the Transfer Output. The Write is either successful or not. If the Write is not successful, then the System will repeat calling the Write function using 25 the same transfer output, which may be successful or not. If unsuccessful the System will initiate a rollback of the transfer. The rollback must be performed on the Parameter Upgrader QA Device, so that it can adjust its value to a previous value before the current Transfer Request was initiated. 4. The System starts a rollback by Reading the memory vectors MO and M1 of the Printer QA 30 Device. 5. The System makes a StartRollBack Request to the Parameter Upgrader QA Device with same input parameters as the Transfer Request, and the output from Read in (4). The Parameter Upgrader QA Device validates the StartRol/Back Request based on the Read output, and then produces the necessary Pre-rollback output. The Pre-ro/lback output 35 typically consists only of additional field data along with a signature. 6. The System then applies the Pre-rollback output on the Parameter Upgrader QA Device, by calling an authenticated Write on it, passing in the Pre-rollback output. The Write is either WO 2004/050369 PCT/AU2003/001616 885 successful or not. If the Write is not successful, then either (6), or (5) and (6) must be repeated. 7. The System then Reads the memory vectors MO and M1 of the Printer QA Device. 8. The System makes a RollBack Request to the Parameter Upgrader QA Device with same 5 input parameters as the Transfer Request, and the output from Read (7). The Parameter Upgrader QA Device validates the RollBack Request based on the Read output, and then rolls back its count-remaining field by incrementing it by 1. 28.3.1 Transfer The Printer QA Device stores upgradeable operating parameter values in MO fields, and its 10 corresponding M 1 words contains field information for its operating parameter fields. The field information consists of the size of the field, the Type of data stored in field and the access permission to the field. See Section 8.1.1 for details. The Parameter Upgrader QA Device also stores the new operating parameter values (which will be written to the Printer QA Device) in its MO fields, and its coressponding M 1 words contains field 15 information for the new operating parameter fields. Additionally, the Parameter Upgrader QA Device has a count-remaining field associated with the new operating parameter value field. The count remaining field occupies the higher field position when compared to its associated operating parameter value field. 28.3.1.1 Authorisation 20 The basic authorisation for a transfer comes from a key, which has authenticated ReadWrite permission (stored in field information as KeyNum) to the operating parameter field in the Printer QA Device. We will refer to this key as the upgrade key. The same upgrade key must also have authenticated decrement-only permission to the count-remaining field (which decrements by 1 with every transfer) in the Parameter Upgrader QA Device. 25 After validating the input upgrade request, the Parameter Upgrader QA Device will decrement the value of the count-remaining field by 1, and produce data (by copying the data stored from its operating parameter field) and signature for the new operating parameter using the upgrade key. Note that the Parameter Upgrader QA Device can decrement its count-remaining field only if the upgrade key has the permission to decrement it. 30 The data and signature produced by the Parameter Upgrader QA Device is subsequently applied to the Printer QA Device. The Printer QA Device will accept the new transferred operating parameter, only if the signature is valid. Note that the signature will only be valid if it was produced using the upgrade key which has write permission to the operating parameter field being written. The upgrade key has authenticated ReadWrite permission to the operating parameter field (which 35 will change) in the Printer QA Device. The upgrade key has decrement-only permission to the the count-remaining field (which decrements by 1 with every transfer of field) in the Parameter Upgrader QA Device.
WO 2004/050369 PCT/AU2003/001616 886 28.3.1.2 Data Type matching The Parameter Upgrader QA Device validates the transfer request by matching the Type of the data in the field information of operating parameter field (stored in MI) of Printer QA Device to the Type of data in the field information of operating parameter field of the Parameter Upgrader QA Device. 5 This ensures that equivalent data types are being transferred i.e NetworkOEM1 _printspeed_1500 is not transferred to NetworkOEM1 _printspeed_2000. 28.3.1.3 Addition validation Additional validation of the transfer request must be performed before a transfer output is generated by the Parameter Upgrader QA Device. These are as follows: 10 9 For the Printer QA Device 1. Whether the field being upgraded is actually present. 2. Whether the field being upgraded can hold the changed value. * For the Parameter Upgrader QA Device: 1. Whether the new operating parameter field and its associated count-remaining is actually 15 present. 2. Whether the count-remaining field has an upgrade left for the transfer to succeed. 28.3.1.4 Rollback facilitation To facilitate a rollback, the Parameter Upgrade QA Device will store a list of transfer requests processed by it. This list is referred to as the Xfer Entry cache. Each record in the list consists of the 20 transfer parameters corresponding to the transfer request. 28.3.2 Rollback A rollback request will be validated by looking through the Xfer Entry cache of the Parameter Upgrader QA Device. After the right transfer request is found the Parameter Upgrade QA Device checks that the output from the transfer request was not applied to the Printer QA Device by 25 comparing the current Read of the Printer QA Device to the values in the Xfer Entry cache, and finally rolling back the Parameter Upgrader QA Device count-remaining field by incrementing it by 1. The Parameter Upgrader QA Device must be absolutely sure that the Printer QA Device didn't receive the transfer. This factor determines the additional fields that must be written along with new operating parameter data, and also the parameters of the transfer request that must be stored in the 30 Xfer Entry cache to facilitate a rollback, to prove that the Printer QA Device didn't actually receive the transfer. The rollback process increments the count-remaininq field by 1 in the Parameter Upgrader QA Device. 28.3.2.1 Sequence fields 35 The rollback process must ensure that the transfer output (which was previously produced) for which the rollback is being performed, cannot be applied after the rollback has been performed.
WO 2004/050369 PCT/AU2003/001616 887 How do we achieve this? There are two separate decrement-only sequence fields (SEQI and SEQ_2) in the Printer QA Device which can only be decremented by the Parameter Upgrader QA Device using the upgrade key. The nature of data to be written to the sequence fields is such that either the transfer output or the pre-rollback output can be applied to the Printer QA Device, but not 5 both i.e they must be mutually exclusive. Refer to Table 285 for details. The two sequence fields are initialised to OxFFFFFFFF using sequence key.The sequence key is different to the upgrade key, and has authenticated ReadWrite permission to both the sequence fields. The transfer output consists of the new data for the field being upgraded, field data of the two 10 sequence fields, and a signature using the upgrade key. The field data for SEQ_1 is decremented by 2 from the original value that was passed in with the transfer request. The field data for SEQ_2 is decremented by 1 from the original value that was passed in with the transfer request. The pre-rollback output consists only of the field data for the two sequence fields, and a signature using the upgrade key. The field data for SEQ_1 is decremented by 1 from the original value that 15 was passed in with the transfer request. The field data for SEQ_2 is decremented by 2 from the original value that was passed in with the transfer request. Since the two sequence fields are decrement-only fields, the writing of the transfer output to QA Device being upgraded will prevent the writing of the pre-rollback output to QA Device being upgraded, since the sequence fields are decrement-only fields, and only one possible set can be 20 written. If the writing of the transfer output fails, then pre-rollback can be written. However, the transfer output cannot be written after the pre-rollback output has been written. Before a rollback is performed, the Parameter Upgrader QA Device must confirm that the sequence fields was successfully written to the pre-rollback values in the Printer QA Device. Because the sequence fields are decrement-only fields, the Printer QA Device will allow pre-rollback output to be 25 written only if the transfer output has not been written. 28.3.2.1.1 Field information of the sequence data field For a device to be upgradeable the device must have two sequence fields SEQ_1 and SEQ_2 which are written with sequence data during the transfer sequence. Thus all upgrading QA Devices, ink QA Devices and printer QA Devices must have two sequence fields. The upgrading QA Devices 30 must have these fields because they can be upgraded as well. The sequence field information are defined in Table 298.
WO 2004/050369 PCT/AU2003/001616 888 Attribute Name Value Explanation Type TYPESEQ_1 or TYPESEQ_2. See Appendix A for exact data. KeyNum Slot number of the sequence key. Only the sequence key has authenticated ReadWrite access to this field. Non Auth RW 0 Non authenticated ReadWrite Permb is not allowed to the field. Auth RW Perm" 1 Authenticated (key based) ReadWrite access is allowed to the field. KeyPerm KeyPerms[KeyNum] = 0 KeyNum is the slot number of the sequence key, which has ReadWrite permission to the field. KeyPerms[Slot number of upgrade key] = Upgrade key can decrement the 1 sequence field. KeyPerms[others= 0 ..7(except upgrade All other keys have ReadOnly access. key)] = 0 End Pos Set as required. Size is typically 1 word. a. This is a sample type only and is not included in the Type Map in Appendix A. 5 b. Non authenticated Read Write permission. c. Authenticated Read Write permission. 28.3.3 Upgrade states There are three states in an transfer sequence, the first state is initiated for every transfer, while the next two states are initiated only when the transfer fails. The states are - Xfer, StartRollback, and 10 Rollback. 28.3.3.1 Upgrade Flow Figure 384 shows a typical upgrade flow. 28.3.3.2 Xfer This state indicates the start of the transfer process, and is the only state required if the transfer is 15 successful. During this state, the Parameter Upgrader QA Device adds a new record to its Xfer Entry cache, decrements its count-remaining by 1, produces new operating parameter field, new sequence data (as described in Section 28.3.2.1) and a signature based on the upgrade key.
WO 2004/050369 PCT/AU2003/001616 889 The Printer QA Device will subsequently write the new operating parameter field and new sequence data, after verifying the signature. If the new operating parameter field can be successfully written to the Printer QA Device, then this will finish a successful transfer. If the writing of the new amount is unsuccessful (result returned is BAD SIG ), the System will re 5 transmit the transfer output to the Printer QA Device, by calling the authenticated Write function on it again, using the same transfer output. If retrying to write the same transfer output fails repeatedly, the System will start the rollback process on Parameter Upgrader QA Device, by calling the Read function on the Printer QA Device, and subsequently calling the StartRollBack function on the Parameter Upgrader QA Device. After a 10 successful rollback is performed, the System will invoke the transfer sequence again. 28.3.3.3 StartRollBack This state indicates the start of the rollback process. During this state, the Parameter Upgrade QA Device produces the next sequence data and a signature based on the upgrade key. This is also called a pre-rollback, as described in Section 26.3.2. 15 The pre-rollback output can only be written to the Printer QA Device, if the previous transfer output has not been written. The writing of the pre-rollback sequence data also ensures, that if the previous transfer output was captured and not applied, then it cannot be applied to the Printer QA Device in the future. If the writing of the pre-rollback output is unsuccessful (result returned is BAD SIG ), the System will 20 re-transmit the pre-rollback output to the Printer QA Device, by calling the authenticated Write function on it again, using the same pre-rollback output. If retrying to write the same pre-rollback output fails repeatedly, the System will call the StartRollback on the Parameter Upgrade QA Device again, and subsequently calling the authenticated Write function on the Printer QA Device using this output. 25 28.3.3.4 Rollback This state indicates a successful deletion (completion) of a transfer sequence. During this state, the Parameter Upgrader QA Device verifies the sequence data produced from StartRollBack has been correctly written to Printer QA Device, then rolls its count-remaining field to a previous value before the transfer request was issued. 30 28.3.4 Xfer Entry cache The Xfer Entry data structure must allow for the following: * Stores the transfer state and sequence data for a given transfer sequence. * Store all data corresponding to a given transfer, to facilitate a rollback to the previous value before the transfer output was generated. 35 The Xfer Entry cache depth will depend on the QA Chip Logical Interface implementation. For some implementations a single Xfer Entry value will be saved. If the Parameter Upgrader QA Device has no powersafe storage of Xfer Entry cache, a power down will cause the erasure of the Xfer Entry WO 2004/050369 PCT/AU2003/001616 890 cache and the Parameter Upgrader QA Device will not be able to rollback to a pre-power-down value. A dataset in the Xfer Entry cache will consist of the following: * Information about the Printer QA Device: 5 a. Chipld of the device. b. FieldNum of the MO field (i.e what was being upgraded). * Information about the Parameter Upgrader QA Device: a. FieldNum of the MO field used to transfer the count-remaining from. * Xfer State- indicating at which state the transfer sequence is. This will consist of: 10 a. State definition which could be one of the following: - Xfer, StartRollBack and deleted (completed). b. The value of sequence data fields SEQ_1 and SEQ_2. The Xfer Entry cache stores the FleldNum of the count-remaining field of the Parameter Upgrader QA Device. 15 28.3.4.1 Adding new dataset A new dataset is added to Xfer Entry cache by the Xfer function. There are three methods which can be used to add new dataset to the Xfer Entry cache. The methods have been listed below in the order of their priority: 1. Replacing existing dataset in Xfer Entry cache with new dataset based on Chipid and 20 FeidNum of the Ink QA Device in the new dataset. A matching Chipld and FieldNum could be found because a previous transfer output corresponding to the dataset stored in the Xfer Entry cache has been correctly received and processed by the Parameter Upgrader QA Device, and a new transfer request for the same Printer QA Device, same field, has come through to the Parameter Upgrader QA Device. 25 2. Replace existing dataset cache with new dataset based on the Xfer State. If the Xfer State for a dataset indicates deleted (complete), then such a dataset will not be used for any further functions, and can be overwritten by a new dataset. 3. Add new dataset to the end of the cache. This will automatically delete the oldest dataset from the cache regardless of the Xfer State. 30 28.4 UPGRADING THE COUNT-REMAINING FIELD This section is only applicable to the Parameter Upgrader QA Device. The transfer of count-remaining is similar to transfer ink-remaining because both involve transferring of amounts. Therefore, this transfer uses the XferAmount function. The XferAmount function performs additional checks when transferring count-remaining. This 35 includes checking of the operating parameter field, associated with the count-remaining. They are as follows: WO 2004/050369 PCT/AU2003/001616 891 * The operating parameter value of the upgrading QA Device and the QA Device being upgraded must match. * The operating parameter field (in both devices) must be upgradeable by one key only, and all other keys must have ReadOnly access. This key which has authenticated ReadWrite 5 permission to the operating parameter field, must be different to the key that has authenticated Read Write permission to the count-remaining field. * The data Type for the operating parameter field in the upgrading QA Device must match the data Type for the operating parameter field in the QA Device being upgraded. 28.5 NEW OPERATING PARAMETER FIELD INFORMATION 10 This section is only applicable to the Parameter Uparader QA Device. This field stores the operating parameter value that is copied from the Parameter Upgrader QA Device to the operating parameter field being updated in the Printer QA Device. This field has a single key associated with it. This key has authenticated ReadWrite permission to this field and will be referred to as write-parameter key. 15 Table 299 shows the field information for the new operating parameter field in the Parameter Upgrader QA Device. Attribute Name Value Explanation Type For e.g - Type describing the upgrade. TYPEUPGRADE PRINTSPEED_ 15 KeyNum Slot number of the write-parameter key. Only the write-parameter key has authenticated ReadWrite access to this field. Non Auth RW 0 Non authenticated ReadWrite Permb is not allowed to the field. Auth RW Perm 1 Authenticated (key based) ReadWrite access is allowed to the field. KeyPerm KeyPerms[KeyNum] = 0 KeyNum is the slot number of the write parameter key which has ReadWrite permission to the field. KeyPerms[others= 0 .. 7] = 0 All other keys have ReadOnly access. End Pos Set as required. a. This is a sample type only and is not included in the Type Map in Appendix A. 20 b. Non authenticated Read Write permission. c. Authenticated Read Write permission.
WO 2004/050369 PCT/AU2003/001616 892 28.6 DIFFERENT TYPES OF TRANSFER There can be three types of transfer: * Parameter Transfer -This is transfer of an operating parameter value from a Parameter 5 Upgrader QA Device to a Printer QA Device. This is performed when an upgradeable operating parameter is written (for the first time) or changed. * Hierarchical refill -This is a transfer of count-remaining value from one Parameter Upgrader Refill QA Device to a Parameter Upgrader QA Device, where both QA Devices belong to the same OEM. This is typically performed when OEM divides the number of upgrades from one 10 of its Parameter Upgrader QA Device to many of its Parameter Upgrader QA Devices. * Peer to Peer refill - This is a transfer of count-remaining value from one Parameter Upgrader Refill QA Device to Parameter Upgrader Refill QA Device, where the QA Devices belong to different organisations, say ComCo and OEM. This is typically performed when ComCo divides number of upgrades from its Parameter Upgrader QA Device to several Parameter Upgrader QA 15 Device belonging to several OEMs. Transfer of count-remaining between peers, and hierarchical transfer of count-remaining. is similar to an ink transfer, but additional checks on the transfer request is performed when transferring count-remaining amounts. This is described in Section 28.4. 1. Transfer of an operating parameter value decrements the count-remaining by 1, hence is different 20 to a ink-transfer. Figure 385 is a representation of various authorised upgrade paths in the printing system. 28.6.1 Hierarchical transfers Referring to Figure 385, this transfer is typically performed when count-remaining amount is transferred from ComCo's Parameter Upgrader Refill QA Device to OEM's Parameter Upgrader 25 Refill QA Device, or from QACo's Parameter Upgrader Refill QA Device to ComCo's Parameter Upgrader Refill QA Device. This transfers are made using the XferAmount function (and not with the XferFie/d described in Section 29.1). because count-remaininq transfer is similar to fill/refilling of ink amounts, where ink amount is replaced by count-remaininq amount. 30 28.6.1.1 Keys and access permission We will explain this using a transfer from ComCo to OEM. There is a count-remaining field associated with the ComCo's Parameter Upgrader Refill QA Device. This count-remaining field has two keys associated with: * The first key transfers count-remaining to the device from another Parameter Upgrader Refill 35 QA device(device is higher in the heirachy), fills/refills the device itself. * The second key transfers count-remaining from it to other devices (which are lower in the heirachy), fills/refills other devices from it.
WO 2004/050369 PCT/AU2003/001616 893 There is a count-remaining field associated with the OEM's Parameter Upgrader Refill QA Device. This count-remaining field has a single key associated with: e This key transfers count-remaining to the device from another Parameter Upgrader Refilli QA device (which is higher or at the same level in the heirachy), fills/refills (upgrades) the device 5 itself, and additionally transfers count-remaining from it to other devices (which are lower in the heirachy), fills/refills (upgrades) other devices from it. For a successful transfer of count-remaining from ComCo's refill device to an OEM's refill device, the ComCo's refill device and the OEM's refill device must share a common key or a variant key. This key is fill/refill key with respect to the OEM's refill device and it is the transfer key with respect 10 to the ComCo's refill device. For a ComCo to successfully fill/refill its refill device from another refill device (which is higher in the heirachy possibly belonging to the QACo), the ComCo's refill device and the QACo's refill device must share a common key or a variant key. This key is fill/refill key with respect to the ComCo's refill device and it is the transfer key with respect to the QACo's refill device. 15 28.6.1.1.1 Count-remaining field information Table 300 shows the field information for an MO field storing logical count-remaining amounts in the refill device, which has the ability to transfer down the heirachy. Attribute Name Value Explanation Type TYPECOUNT-REMAININGa Type describes that the field is a count remaining field. KeyNum Slot number of the refill key. Only the refill key has authenticated ReadWrite access to this field. Non Auth RW 0 Non authenticated ReadWrite Permb is not allowed to the field. Auth RW Perm* I Authenticated (key based) ReadWrite access is allowed to the field. KeyPerm KeyPerms[KeyNum] = 0 KeyNum is the slot number of the refill key, which has ReadWrite permission to the field. KeyPerms[Slot Num of transfer key]= 1 Transfer key can decrement the field. KeyPerms[others= 0 ..7(except transfer All other keys have ReadOnly access. key)] = 0 End Pos Set as required. Depends on the amount of logical ink the WO 2004/050369 PCT/AU2003/001616 894 device can store and storage resolution i.e in picolitres or in microlitres. a. Refer to Type Map in Appendix A for exact value. b. Non authenticated Read Write permission. c. Authenticated Read Write permission. 5 28.6.2 Peer to Peer transfer Referring to Figure 385, this transfer is typically performed when count-remaining amount is transferred from OEM's Parameter Upgrader Refill QA Device to another Parameter Device Refill QA Device belonging to the same OEM. 10 28.6.2.1 Keys and access permission There is an count-remaining field associated with the refill device. This count-remaining field has a single key associated with: This key transfers count-remaining amount to the device from another refill device (which is higher or at the same level in the heirachy), fills/refills (upgrades) the device itself, and 15 additionally transfers ink from it to other devices (which are lower in the heirachy), fills/refills (upgrades) other devices from it. This key is referred to as the fill/refill key and is used for both fillrefill and transfer. Hence, this key has both ReadWrite and Decrement-Only permission to the count-remaining field in the refill device. 28.6.2.1.1 Count-remaining field information 20 Table 301 shows the field information for an Mo field storing logical count-remaining amounts in the refill device with the ability to transfer between peers. Table 301. Field information for ink-remaining field for refill devices transferring between peers Attribute Value Explanation Name Type TYPECOUNTREMAININGa Type describes that the field is a count-remaining field. KeyNum Slot number of the refill key. Only the refill key has authenticated ReadWrite access to this field. Non Auth 0 Non authenticated ReadWrite is not allowed to the field. RW Permb Auth RW 1 Authenticated (key based) ReadWrite access Perm' is allowed to the field. KeyPerm KeyPerms[KeyNum] = 1 KeyNum is the slot number of the refill key, WO 2004/050369 PCT/AU2003/001616 895 which has ReadWrite and Decrement permission to the field. KeyPerms[others= 0 ..7(except All other keys have ReadOnly access. KeyNum)] = 0 End Pos Set as required. Depends on the amount of logical ink the device can store and storage resolution - i.e in picolitres or in microlitres. a. Refer to Type Map in Appendix A for exact value. b. Non authenticated Read Write permission. c. Authenticated Read Write permission. 5 29 Functions 29.1 XFERFIELD Input: KeyRef, MoOfExternal, mlOfExternal, Chipid, FieldNumL, FieldNumE, InputParameterCheck (Optional), RE, SIGE, RE2 Output: ResultFlag, Field data, RL2, SIG& 10 Changes: Mo and RL Availablity: Parameter Upgrader QA Device 29.1.1 Function description The XferField is similar to the XferAmount function in that it produces data and signature for updating a given MO field. This data and signature when applied to the appropriate device through 15 the WriteFieldsAuth function, will upgrade the FieldNumE (Mo field) of a device to the same value as FieldNumL of the upgrading device. The system calls the XferField function on the upgrade device with a certain FieldNumL to be transferred to the device being upgraded The FieldNumE is validated by the XferField function according to various rules as described in Section 29.1.4. If validation succeeds the XferField 20 function produces the data and signature for subsequent passing into the WriteFieldsAuth function for the device being upgraded. The transfer field output consists of the new data for the field being upgraded, field data of the two sequence fields, and a signature. When a transfer output is produced, the sequence field data in SEQ_1 is decremented by 2 from the previous value (as passed in with the input), and the 25 sequence field data in SEQ_2 is decremented by 1 from the previous value (as passed in with the input). Additional InputParameterCheck value must be provided for the parameters not included in the SIGE, if the transmission between the System and Parameter Upgrader QA Device is error prone, and these errors are not corrected by the transimission protocol itself. InputParameterCheck is WO 2004/050369 PCT/AU2003/001616 896 SHA-1[FieldNumL I FieldNumE I XferValLength I XferVal], and is required to ensure the integrity of these parameters, when these inputs are received by the Parameter Upgrader QA Device. The XferField function must first calculate the SHA-1[FieldNumL I FieldNumE], compare the calculated value to the value received (inputParameterCheck) and only if the values match act upon 5 the inputs. 29.1.2 Input parameters Table 302 describes each of the input parameters for XferField function. 10 Parameter Description KeyRef For common key input and output signature: KeyRef keyNum = Slot number of he key to be used for testing input signature and producing the output signature. S/GE produced using KKeyRef.keyNum by the QA Device being upgraded. S/Gout produced using KKeyRef.keyNum for delivery to the QA Device being upgraded. KeyRef.useChip/d = 0 For variant key input and output signatures: KeyRef keyNum = Slot number of the key to be used for generating the variant key. SIGE produced using a variant of KKeyRef.keyNum by the QA Device being upgraded. SiGout produced using a variant of KKeyRef.keyNum for delivery to the QA Device being upgraded. KeyRef.useChipid = 1 KeyRef.chipid = Chipid of the device which generated SIGE and will receive S/Gout. MOfExternal All 16 words of MO of the QA Device being upgraded MlOfExternal Ali 16 words of m, of the QA Device being upgraded. Chipid Chipid of the QA Device being upgraded. FieidNumL MO field number of the local (updating) device. The data stored in this field will be copied from the upgrading device. FieldNumE MO field number of the QA Device being upgraded. This field will be updated to the value stored in FieldNumL within the upgrading device. RE External random value used to verify input signature. This will be the R from the input signature generator (i.e device generating SIGE). The input signal generator in this case, is the device being upgraded or a translation device. RE2 External random value used to produce output signature. This will be the R obtained by calling the Random function on the device which will receive the SIGout from the XferField function. The device receiving the SIGo, in this case, is the device being upgraded or a translation device.
WO 2004/050369 PCT/AU2003/001616 897 S/GE JExternal signature required for authenticating input data. The input data in this case, is the output from the Read function performed on the device being upgraded. A correct SIGE = SIGKeyRef(Data RE I RL) 29.1.2.1 Input signature verification data format Refer to Section 27.1.2.1. 29.1.3 Output parameters 5 Table 303 describes each of the output parameters for XferField function. Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1, Table 292 and Table 303. FieldSelect Selection of fields to be written In this case the bit corresponding to SEQ_1, SEQ_2 and to Fie/dNumE are set to 1. All other bits are set to 0. FieldVal Updated data words for sequence data field and FieldNumE for QA Device being upgraded. Starts with LSW of lower field. This must be passed as input to the WriteFieldsAuth function of the QA Device being upgraded. RL2 Internal random value required to generate output signature This must be passed as input to the WriteFieldsAuth function or Translate function of the QA Device being upgraded. S/Gout Output signature which must be passed as an input to the WriteFieldsAuth function or Translate function of the QA Device being upgraded. SIGout = SIGKeype,(data I RL2 I RE2) as per Figure 373 10 WO 2004/050369 PCT/AU2003/001616 898 Table 303. Result Flag definitions for XferField ReultFlag Definition Description CountRemainingFieldinva The count- remaining field in Upgrading QA Device is invalid. lid FieldNumEKeyPermlnvali The upgrade field in the QA Device being upgraded doesn't have the d correct authenticated permission. NoUpgradesRemaining The count-remaining field assocaited with the upgrade field in the Upgrading QA Device doesn't have any more upgrades left. 29.1.3.1 Output signature generation data format 5 Refer to Section 27.1.3.1. 29.1.4 Function sequence The XferField command is illustrated by the following pseudocode: Accept input parameters-KeyRef, M00fExternal, MlOfExternal, Chipld, FieldNumL, FieldNumE, RE, SIGE, RE2 10 #Generate message for passing into ValidateKeyRefAndSignature function data <- (RWSenselMSelectjKeyIdSelectiChipIdI WordSelect MO|M1) # Refer to Figure 382. 15 # Validate KeyRef, and then verify signature ResultFlag = ValidateKeyRefAndSignature (KeyRef ,data, RE, RL) 20 If (ResultFlag # Pass) Output ResultFlag Return Endif 25 # Validatate FieldNumE # FieldNumE is present in the device being upgraded PresentFlagFieldNumE <- GetFieldPresent (MlOf External, FieldNumE) # Check FieldNumE present flag 30 If(PresentFlagFieldNumE #; 1) WO 2004/050369 PCT/AU2003/001616 899 ResultFlag +- FieldNumElnvalid Output ResultFlag Return EndIf 5 ----------- - - - - - - - - - - - - - - - - - - - - - - - - - # Check Seq fields exist and get their Field Number # Get Seqdata field SEQ_1 for the device being upgraded XferSEQlFieldNum<-GetFieldNum(MlOfExternal, SEQ_1) 10 # Check if the Seqdata field SEQ_1 is valid If(XferSEQlFieldNum invalid) ResultFlag +- SeqFieldinvalid Output ResultFlag 15 Return Endlf # Get Seqdata field SEQ_2 for the device being upgraded XferSEQ_2FieldNum+-GetFieldNum(MlfExternal, SEQ_2) 20 # Check if the Seqdata field SEQ_2 is valid If(XferSEQ_2FieldNum invalid) ResultFlag +- SeqFieldinvalid Output ResultFlag Return 25 EndIf
------------------------------------------------------------------
#Check write permission for FieldNumE 30 PermOKFieldNumE +- CheckFieldNumEPerm (M1OfExternal, FieldNumE) If (PermOKFieldNumE #1) ResultFlag <- FieldNumEWritePerm Invalid Output ResultFlag Return 35 EndIf WO 2004/050369 PCT/AU2003/001616 900 #Check that both SeqData fields have Decrement-only permission with the same key 5 #that has write permission on FieldumE PermOKXferSeqData <- CheckSeqDataFieldPerms (M1OfExternal, XferSEQ_1FieldNum, XferSEQ_2FieldNum, FieldNumE) If (PermOKXferSeqData # 1) 10 ResultFlag +- SeqWritePermlnvalid Output ResultFlag Return EndIf 15 ------------ # Get SeqData SEQ_1 data from device being upgraded GetFieldDataWords (XferSEQ lFieldNum, 20 XferSEQ lDataFromDevice,MOOfExternal,M1OfExternal) # Get SeqData SEQ_2 data from device being upgraded GetFieldDataWords (XferSEQ2FieldNum, XferSEQ 2DataFromDevice, 25 M0OfExternal,MlOfExternal) # FielduumL(upgrade value)is a valid field in the upgrading device PresentFlagFieldNumL +- GetFieldPresent (M1, FieldNumL) 30 If(PresentFlagFieldNumL #1) ResultFla4 <- FieldNumL.Invalid Output ResultFlag Return EndIf 35 ------------------------------------------------------------ #Get the CountRemaining field associated with the upgrade value field WO 2004/050369 PCT/AU2003/001616 901 # The CountRemaining field is the next higher field from the upgrade value field FieldNumCountRemaining<- FieldNumL + 1 5 # FieldumCountRemaining is a valid field in the upgrading device PresentFlagFieldNumCountRemaining <-GetFieldPresent (M1, FieldNumCountRemaining) If (PresentFlagFieldNumCountRemaining # 1) ResultFlag +- CountRemainingField Invalid 10 Output ResultFlag Return EndIf #Check permission for upgrade value field. Only one key (different 15 # from KeRef.keyNum) has write permissions to the field and no key has decrement permissions. CheckOK +- CheckUpgradeKeyForField(FieldNumL,M1, KeyRef) If(CheckOK #1) ResultFlag +- FieldNum EKeyPermInvalid 20 Output ResultFlag Return Endlf #Pind the type attribute for FieldNumE 25 TypeFieldNumE +- FindFieldNumType (M1OfExternal, FieldNumE) #Find the type attribute for FieldNumL (upgrade value) TypeFieldNumL *- FindFieldNumType (Ml, FieldNumL) If (TypeFieldNumE # TypeFieldNumL) 30 ResultFlag +- TypeMismatch Output ResultFlag Return EndIf 35 WO 2004/050369 PCT/AU2003/001616 902 # Check permissions for CountRemaining field # Check upgrades are available in the CountRemaining field of the # upgrading device i.e value of CountRemaining is non-zero positive number 5 CountRemainingOK <-CheckCountRemaining (FieldNumCountRemaining, MO, M1) If(CountRemainingOK #1) ResultFlag <- NoUpgradesRemaining Output ResultFlag 10 Return EndIf
----------------------------------------------------------------
#Get the size of the FieldNumrL (upgrade value) 15 If(FieldNumL = 0) FieldSizeOfFieldNumL+- MaxWordInM- M1 [FieldNumL] .EndPos Else FieldSizeOfFieldNumL<- M1[FieldNumL-1 .EndPos M1 [FieldNumL] .EndPos 20 EndIf #Get the size of the FieldNumE (field being updated) If(FieldNumL = 0) 25 FieldSizeOfFieldNumE+- MaxWordlnM- MIOf External [FieldNumE 1] .EndPos Else FieldSizeOfFieldNumE+- M10fExternal [FieldNumE-1] .EndPos - M1OfExternal[FieldNumLj .EndPos 30 EndIf # Check whether the device being upgraded can hold the upgrade value from # FieldNumL 35 If(FieldSizeOfFieldNumE < FieldSizeOfFieldNumL) ResultFlag <- FieldNum ESizelnsufficient Output ResultFlag WO 2004/050369 PCT/AU2003/001616 903 Return EndIf f All checks complete ..... 5 # Generate Seqdata for SEQ_1 and SEQ_2 fields XferSEQ_1DataToDevice = XferSEQ.1DataFromDevice - 2 XferSEQ_2DataToDevice = XferSEQ_2DataFromDevice - 1 10 # Add DataSet to Xfer Entry Cache AddDataSetToXferEntryCache (ChipId, FieldNumE, FieldNumL, XferSEQlDataFromDevice, XferSEQ_2DataFromDevice) 15 #Decrement CountRemaining field by one DecrementField (FieldNumCountRemaining, MO) #Get the upgrade value words from FieldNumE of the upgrading device 20 GetFieldDataWords (FieldNumL,UpgradeValue,MO,M1) #Generate new field data words for FieldNumE. The upgrade value is copied to FieldDataE 25 FieldDataE- UpgradeValue # Generate FieldSelect and FieldVal for SeqData field SEQ_l, SEQ_2 and # FieldDataE... 30 CurrentFieldSelect<- 0 FieldVal +- 0 GenerateFieldSelectAndFieldVal (FieldNumE, FieldDataE, XferSEQ_1FieldNum, XferSEQlDataToDevice,XferSEQ_2FieldNum, XferSEQ_2DataToDevice, 35 FieldSelect, FieldVal) #Generate message for passing into GenerateSignature function WO 2004/050369 PCT/AU2003/001616 904 data - (RWSense)FieldSelectlchipIdiFieldVal)# Refer to Figure 373. #Create output signature for PieldNumE SIGout+- GenerateSignature (KeyRef , data, RL2, RE2) Update RL 2 to RL 3 5 ResultFlag * Pass Output ResultFlag, FieldSelect,FieldVal, RL2 ,SIGout Return EndIf 29.1.4.1 CountRemainingOK 10 CheckCountRemainingFieldNumL(FieldNumCountRemainingM1,MO) This functions checks permissions for CountRemaining field and also checks that upgrades are available in the CountRemaining field of the upgrading device. AuthRW 4-Mi [FieldNumCountRemaining] .AuthRW NonAuthRW <-Ml [FieldNumCountRemaining] .NonAuthRW 15 DOForKeys <- M1 [FieldNumCountRemaining] . DOForKeys [KeyNum] Type + M1 [FieldNumCountRemaining] .Type If (AuthRW = 1 A NonAuthRW = 0 A (DOForKeys = 1A (Type = TYPECOUNTREMAINING) PermOK <-1 20 Else PermOK <-0 Return PermOK EndIf #Get the count-remaining value from the upgrading device 25 GetFieldDataWords (FieldNumCountRemaining, CountRemainingValue, MO, M1 If(CountRemainingValue <= 0) PermOK 4- 0 Return PermOK 30 EndIf PermOK <- 1 Return PermOK 35 WO 2004/050369 PCT/AU2003/001616 905 29.2 ROLLBACKFIELD Input: KeyRef, moOfExternal, mlOfExternal, Chipid, FieldNumL, FleldNumE, InputParameterCheck (optional), RE, SIGE Output: ResultFlag 5 Changes: mo and RL Availablity: Parameter Upgrader QA Device 29.2.1 Function description The RollBackField function is very similar to the Rol/BackAmount function, the only difference being that the Rol/BackField function adjusts the value of the count-remaining field associated with the 10 upgrade value field of the upgrading device, instead of the upgrade value field itself. A successful rollback, increments the count-remaining by 1. The Parameter Upgrader QA Device checks that the Printer QA Device didn't actually receive the transfer message correctly, by comparing the sequence data field values read from the device with the values stored in the Xfer Entry cache. The sequence data field values read must match what 15 was previously written using the StartRol/Back function. After all checks are fulfilled, the Parameter Upgrader QA Device adjusts its FieldNumL. Additional lnputParameterCheck value must be provided for the parameters not included in the SIGE, if the transmission between the System and Parameter Upgrader QA Device is error prone, and these errors are not corrected by the transimission protocol itself. InputParameterCheck is 20 SHA-1[FieldNumL I Fie/dNumE J, and is required to ensure the integrity of these parameters, when these inputs are received by the Parameter Upgrader QA Device. The RollBackField function must first calculate the SHA-1[FieldNumL I FieldNumE], compare the calculated value to the value received (inputParameterCheck) and only if the values match act upon the inputs. 25 29.2.2 Input parameters Table 305 describes each of the input parameters for RollBackField function. Parameter Description KeyRef For common key input signature: KeyRef.keyNum = Slot number of the key to be used for testing input signature. SIGE produced using KKeyRef.keyNum by the QA Device being upgraded. KeyRef.useChipld = 0 For variant key input signature: KeyRef.keyNum = Slot number of the key to be used for generating the variant key. S/GE produced using a variant of KKeyRef.keyNum by the QA Device being upgraded. KeyRef.useChipld = 1 KeyRef.chipid = Chipld of the device which WO 2004/050369 PCT/AU2003/001616 906 generated SIGE. MOfExternal 16 words of mo of the QA Device being upgraded which failed to upgrade. oCfExternal 16 words of m, of the QA Device being upgraded which failed to upgrade. Chip/d Chipid of the QA Device being upgraded which failed to upgrade. FieldNumL mo field number of the local (upgrading) device whose value could not be copied to the device being upgraded. FieidNumE Mo field number of the QA Device being upgraded to which the upgrade value in FieldNumL couldn't be copied. RE External random value used to verify input signature. This will be the R from the input signature generator (i.e device generating SIGE). The input signal generator in this case, is the device which failed to upgrade or a translation device. SIGE External signature required for authenticating input data. The input data in this case, is the output from the Read function performed on the device which failed to upgrade. A correct SIGE = SIGKeyRef(Data I RE I RL). 29.2.2.1 Input signature generation data format Refer to Section 27.1.2.1 for details. 29.2.3 Output parameters 5 Table 306 describes each of the output parameters for RollBackField. Parameter Description ResultFlag Indicates whether the function completed successfully or not. If it did not complete successfully, the reason for the failure is returned here. See Section 12.1, Table 292, Table 304 and Table 295. 29.2.4 Function sequence 10 The Rol/BackField command is illustrated by the following pseudocode: Accept input parameters-KeyRef, MOOfExternal, M1fExternal, ChipId, FieldNumL, FieldNumE, RE, SIGE #Generate message for passing into GenerateSignature function WO 2004/050369 PCT/AU2003/001616 907 data +- (RWSenseiMSelectiKeyIdSelectI ChipIdi WordSelectjMo M1) # Refer to Figure 382. 5 # Validate KeyRef, and then verify signature ResultFlag = ValidateKeyRefAndSignature (KeyRef, data, RE, RL) If (ResultFlag # Pass) Output ResultFlag Return 10 Endlf # Check Seq fields exist and get their Field Number # Get Seqdata field SEQ_1 num for the device being upgraded XferSEQlFieldNum+-GetFieldNum(MlOfExternal, SEQ_1) 15 # Check if the Seqdata field SEQ_1 is valid If(XferSEQ lFieldNum invalid) ResultFlag <- SeqFieldlnvalid 20 Output ResultFlag Return EndIf # Get Seqdata field SEQ_2 num for the device being upgraded XferSEQ_2FieldNum<-GetFieldNum(MlOfExternal, SEQ_2) 25 # Check if the Seqdata field SEQ_2 is valid If(XferSEQ_2FieldNum invalid) ResultFlag +- SeqFieldlnvalid Output ResultFlag 30 Return EndIf # Get SeqData SEQ_1 data from device being upgraded 35 GetFieldDataWords (XferSEQ lFieldNum, XferSEQ lDataFromDevice, MOOfExternal, MlOfExternal) WO 2004/050369 PCT/AU2003/001616 .908 # Get SeqData SEQ_2 data from device being upgraded GetFieldDataWords (XferSEQ_2FieldNum, XferSEQ 2DataFromDevice, 5 MOOfExternal,MlafExternal) # Generate Seqdata for SEQ_1 and SEQ 2 fields with the data that is read XferSEQ 1Data = XferSEQ 1DataFromDevice + 1 10 XferSEQ_2Data = XferSEQ_2DataFromDevice + 2 # Check Xfer Entry in cache is correct - dataset exists, Field data 15 # and sequence field data matches and Xfer State is correct XferEntryOK <- CheckEntry (ChipId, FieldNumE, FieldNumL, XferSEQ 1Data, XferSEQ_2Data) If( XferEntryOK= 0) 20 ResultFlag +-RollBackInvalid Output ResultFlag Return EndIf 25 # Increment associated CountRemaining by 1 Increment CountRemaining (FieldNumCountRemaining) # Update XferState in DataSet to complete/deleted UpdateXferStateToComplete (ChipId, FieldNumE) ResultFlag +-Pass 30 Output ResultFlag Return EXAMPLE SEQUENCE OF OPERATIONS 30 Concepts The QA Chip Logical Interface interface devices do not initiate any activities themselves. Instead 35 the System reads data and signature from various untrusted devices, and sends the data and signature to a trusted device for validation of signature, and then uses the data to perform operations required for printing, refilling, upgrading and key replacement. The system will therefore WO 2004/050369 PCT/AU2003/001616 909 be responsible for performing the functional sequences required for printing, refilling, upgrading and key replacement. It formats all input parameters required for a particular function, then calls the function with the input parameters on the appropriate QA Chip Logical Interface instance, and then processes/stores the output parameters from the function appropriately. 5 Validation of signatures is achieved by either of the following schemes: e Direct - the signature produced by an untrusted device is directly passed in for validation to the trusted device. The direct validation requires the untrusted device to share a common key or a variant key with the trusted device. Refer to Section 7 for further details on common and variant keys. 10 e Translation - the signature produced by an untrusted is first validated by the translating device, and a new signature of the read data is produced by the translation device for validation by the trusted device. Several translation device may be chained together -the first translation device validates the signature from the untrusted device, and the last translation device produces the final signature for validation by the trusted device. The translation device 15 must share a common key or a variant key with the trusted/untrusted device and among themselves, if several translation devices are chained together for signature validation. 30.1 REPRESENTATION Each functional sequence consists of the following devices (refer to Section 4.3): e System. 20 e A trusted QA Device - which may be a system trusted QA Device, or an Parameter Upgrader QA Device, or a Ink Refill QA Device, or a Key Programmer QA Device depending on the function performed. This device is referred to as device A. e An untrusted QA Device - which may be a Printer QA Device, or an Ink QA Device. This device is referred to as device B. 25 * A translation QA Device will be used if a translation scheme is used to validate signatures. This device is referred to as device C. The command sequence produced by the system for further sequences will be documented as shown in Table 307. Table 307. Command sequence representation 30 Sequence Function Parameters No Sequence order Device.FunctionName Input Parameters and their values. Output parameters and their description.
WO 2004/050369 PCT/AU2003/001616 910 Therefore, a typical direct signature validation sequence can be represented by Figure 386 and Table 308. For a direct signature to be used, A and B must share a common or a variant key 5 i.e B.Kn 1 = A.K, 2 or B.Kn 1 = FormKeyVariant(A.Kn2, B.Chipld). Table 308. Command sequence for direct signature validation Sequence Function Parameters No 1 A.Random None RA=RL 2 B.Read KeyRef = n1, SigOnly 0, MSelect = Any one M, KeyldSelect = 0, WordSelectForDesiredM = Any one word in the selected M, RE = RA If ResultFlag Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB RL, SIGB= S[Gout Refer to Section 15.3.1. 3 A.Test KeyRef = n2, DataLength = Length of MWords in words preformatted as per Section 16.1, Data = MWords preformatted as per Section 16.1, RE =RB, SIGE = SIGB ResultFlag = Pass/Fail 10 WO 2004/050369 PCT/AU2003/001616 911 A typical signature validation using translation can be represented by Figure 387 and Table 309. For validating signatures using translation: " A and C must share a common or a variant key 5 i.e C.Kn 3 = A.Kn 2 or C.Kn 3 = FormKeyVariant(A.Kn 2 , C.Chipld). " B and C must share a common or a variant key i.e C.Kn 2 = B.Kn 1 or B.Kml = FormKeyVariant(C.Kn 2 , B.Chipld). Table 309. Command sequence for signature validation using translation 10 Sequence Function Parameters No 1 C.Random None Rc=RL 2 B.Read KeyRef = n1, SigOnly = 1 or 0, MSelect = any, KeyldSelect any, WordSelectForDesiredM = any, RE= Rc If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect and [WordSelectForDesiredM], RB= RL, SIGB= SIGout Refer to Section 15.3.1. 3 A.Random None RA=RL C. Translate InputKeyRef =n2, DataLength Length of MWords in words preformatted as per Section 17.1, Data = MWords preformatted as per Section 17.1, RE= RB, SIGE = SIGB, OutputKeyRef n3, RE2 = RA If ResultFlag = Pass then Rc 1 = RL2, SIGc= SIGOut Refer to Section 15.3.1 5 A. Test KeyRef = n2, DataLength = Length of MWords in words preformatted as per Section 16.1, Data = MWords preformatted as per Section 16.1, RE =Rc 1 , SIGE SIGc ResuitFlag = Pass/Fail 31 In field use This section covers functional sequences for printer and ink QA Devices, as they perform their usual function of printing. 15 WO 2004/050369 PCT/AU2003/001616 912 31.1 STARTUP SEQUENCE At startup of any operation (a printer startup or an upgrade startup), the system determines the properties of each QA Device it is going to communicate with. These properties are: 5 * Software version of the QA Device. This includes SoftwareReleaseldMajor and Soft wareReleaseldMinor. The SoftwareReleaseldMajor identifies the functions available in the QA Device. Refer to Section 13.2 for details. * The number of memory vectors in the QA Device. * The number of keys in the QA Device. 10 * The Chipid of the QA Device. The properties allow the system to determine which functions are available in a given QA Device, as well as the value of input parameters required to communicate with the QA Device. Table 310 shows the startup sequence. Table 310. Startup command sequence 15 Sequence No Function Command I B.GetInfo None Major release identifier of the QA Device = SoftwareReleaseldMajor, Minor release identifier of the QA Device= SoftwareReleasedMinor, Number of memory vectors in the QA Device= NumVectors, Number of keys in the QA Device= NumKeys, Id of the QA Device = Chipid 0 = VarDataLen No VarData in case of an ink or printer QA Device 31.1.1 Clearing the preauthorisation field Preauthorisation of ink is one of the schemes that a printer may use to decrement logical ink as physical ink is used. This is discussed in details in Section 31.4.3. 20 If the printer uses preauthorisation, the system must read the preauthorisation field at startup. If the preauthorisation field is not clear, then the system must apply (decrement) the preauth amount to the corresponding ink field, by performing a non-authenticated write of the decremented amount to the appropriate ink field, and then clear the preauthorisation field by performing an authenticated write to the preauthorisation field. 25 31.2 PRESENCE ONLY AUTHENTICATION The purpose of presence only authentication is to determine whether the printer should or shouldn't work with the ink cartridge.
WO 2004/050369 PCT/AU2003/001616 913 31.2.1 Without data interpretation This sequence is performed when the printer authenticates the ink cartridge. The authentication consists of verifying a signature generated by the untrusted ink QA Device (in the ink cartridge) using the system's trusted QA Device. 5 For signature to be valid, the trusted QA Device (A) and the untrusted ink QA Device (B) must share a common or a variant key i.e B.Kas = A.K2 or B.K, = FormKeyVariant(A.K, 2 , B.Chipid). A single word of a single M is read because the system is only interested in the validity of signature for a given data. If the printer wants to verify the signature and doesn't require any data from the ink cartridge 10 (because it is cached in the printer), then the printer calls the Read function with SigOnly set to 1. The Read returns only the signature of the data as requested by the input parameters. The printer then sends its cached data and signature (from the Read function) to its trusted QA Device for verification. The printer may use this signature verification scheme if it has read the data previously from the ink QA Device, and the printer knows that the data in the ink QA Device has not changed 15 from value that was read earlier by the printer. Table 311 shows the command sequence for performing presence only authentication requiring both data and signature. Seq Function Parameters No 1 A.Random None RA= RL 2 B.Read KeyRef = n1, SigOnly = 0, MSelect = Any one M, KeyldSelect = 0, WordSelectForDesiredM = Any one word in the selected M, RE= RA If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelectl and [WordSelectForDesiredM], RB = RL, SIGB SIGout Refer to Section 15.3.1. 3 A. Test KeyRef = n2, DataLength Length of MWords in words preformatted as per Section 16.1, Data = MWords preformatted as per Section 16.1, RE =RB, SIGE = SIGB ResultFlag Pass/Fail 20 31.2.2 With data interpretation This sequence is performed when the printer reads the relevant data from the untrusted QA Device in the ink cartridge. The system validates the signature from the external ink QA Device, and then uses this data for further processing.
WO 2004/050369 PCT/AU2003/001616 914 For signature to be valid, the trusted QA Device (A) and the untrusted QA Device (B) must share a common or a variant key i.e B.Kn 1 = A.Kn2 or B.Kn 1 = FormKeyVariant(A.Kn 2 , B.Chipld). The data read assists the printer to determine the following before printing can commence: * Which fields in MO store logical ink amounts in the ink QA Device. 5 * The size of the ink fields in the ink QA Device. Refer to Section 8.1.1.1. * The type of ink. * The amount of ink in the field. Table 312 shows the command sequence for performing presence only authentication (with data interpretation). 10 Seq Function Parameters No 1 4.Random None RA = RL 2 B.Read KeyRef = ni, SigOnly = 0, MSelect Ox03(indicates MO and Ml), KeyldSelect = OxFF (Read all Keylds), WordSelectForDesiredM (for MO)= OxFFFF (Read all 16 M0words), WordSelectForDesiredM (for M1)= OxFFFF(Read all 16 M1words), RE= RA If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSeledtForDesiredM], All 16 words of MO and Ml. R= RL SIGB= SIGout Refer to Section 15.3.1, 3 4. Test Input Key = n2, DataLength = Length of MWords in words preformatted as per Section 16.1, Data MWords preformatted as per Section 16.1, RE =RB, SIGE = SIGB ResultFlag Pass/Fail 31.2.2.1 Locating ink fields and determining ink amounts remaining Before printing can commence, the printer must determine the ink fields in the ink cartridge so that it 15 can decrement these fields with the physical use of ink. The printer must also verify that the ink in the ink cartridge is suitable for use by the printer. This process requires reading data from the ink QA Device and then comparing the data to what is required. To perform the comparison the printer must store a list for each ink it uses. The ink list must consist of the following: 20 Ink Id - A identifier for the ink * Keyld - The Keyld of the key used to fill/refill this ink. e Type - This is the type attribute of the ink.
WO 2004/050369 PCT/AU2003/001616 915 The ink list stored in the printer is shown in Table 313. Ink Id Keyld Type 1- represents black ink 1- represents Keyld of 0x55 NetworkOEM InkFill/Refill TYPEREGULARBLACKINKa Key' 2- represents cyan ink 1- represents Keyld of Ox9F NetworkOEMInkFill/Refill TYPEHIGHQUALITYCYANINK Keyb 3- represents magenta 1- represents Keyld of Ox9A ink NetworkOEM InkFill/Refill TYPEHIGHQUALITYMAGENTA Keyb _INKa 4- represents yellow 1- represents Keyld of Ox9C ink NetworkOEMInkFill/Refill TYPEHIGHQUALITYYELLOWI Keyb NKa 5 a. These Types are only used as an example. b. These Keylds are only used as an example. The printer will perform a Read of the ink QA Device's MO, M1 and Keylds to determine the following: e The correct ink field (Mo field) in the ink QA Device. 10 * The amount of ink-remaining in the field. The ink QA Device's M1 and Keyld helps the printer determine the location of the ink field and ink QA Device's MO and M1 helps determine the amount of ink-remaining in the field. 31.2.2.2 FieldNum FindFieldNum(keyldRequired, typeRequired) This function returns a Fie/dNum of an MO field, whose authenticated ReadWrite access key's 15 Keyld is key/dRequired, and whose Type attribute matches typeRequired. If no matching field is found it returns a FeidNum = 255. This function must be available in the printer system so that it can determine the ink field required by it. The function sequence is described below. # Get total number of fields in the ink QA Device 20 FieldSize[16] +-o # Array to hold FieldSize assuming there are 16 fields NumFields- FindNumberOfFieldsInMO (M1,FieldSize) # Refer to Section 19.4.1.
WO 2004/050369 PCT/AU2003/001616 916 # Loop through Keylds read assuming all Keylds have been read from ink QA Device For i - 0 to 7 #Check if Keyld read matches 5 If (Key~d,= keyIdRequired # Matching Keyld found KeyNum <-i # Get the KeyNum of the matching KeyId # Now look through the field to check which field has 10 #write permissions with this KeyNum For j <- 0 to NumOfFields AuthRW <- M [j I .AuthRW # Isolate AuthRW for field # Check authenticated write is allowed to the field 15 If(AuthRW = 1) KeyNumj<- MiI[j] .KeyNum # Isolate KeyNum of the field Typej <M1[j] .Type #Islotate Type attribute of the field # Check if Key is write key for the field and type of Ink Id#2 20 If (KeyNum = KeyNumg) A (Typej = typeRequired) FieldNum <-j return FieldNum EndIf EndIf 25 EndFor # Loop through to next field FieldNum <-255 # Error - no field found return FieldNum EndIf EndFor # Loop through to next KeyId 30 For e.g if the printer wants to find an ink field that matches Ink Id#2 (from Table 313) in the ink QA Device, it must call the function FindFieldNum with keyldRequired = Keyld of NetworkOEMInkFill/Refill Key and typeRequired = TYPEHIGHQUALITYCYANINK. 35 WO 2004/050369 PCT/AU2003/001616 917 31.2.2.3 Ink-remaining amount This can be determined by using the function GetFieldDataWords(FieldNumFiedData, MO,M1) described in Section 27.1.4.14. Fie/dNum must be set to the value returned from function in Section 31.2.2.2. FieldData returns the ink-remaining amount. 5 The function GetFieldDataWords(FiedNum,FieldDataL, M,M1) must be implemented in the printer system. 31.3 PRESENCE ONLY AUTHENTICATION THROUGH THE TRANSLATE FUNCTION This sequence is performed when the printer reads the data from the untrusted ink QA Device in the ink cartridge but uses a translating QA Device to indirectly validate the read data. The translating 10 QA Device validates the signature using the key it shares with the untrusted QA Device, and then signs the data using the key it shares with the trusted QA Device. The trusted QA Device then validates the signature produced by the translating QA Device. For validating signatures using translation: " A and C must share a common or a variant key 15 i.e C.Kn 3 = A.Kn 2 or C.Kn 3 = FormKeyVariant(A.Kn2, C.Chipld). " B and C must share a common or a variant key i.e C.Kn 2 = B.Kn, or B.K, 1 = FormKeyVariant(C.Kn 2 , B.Chipld). Table 314 shows a command sequence for presence only authentication using translation 20 Seq Function Parameters No 1 C.Random None Rc= RL 2 B.Read KeyRef = n1, SigOnly = 1 or 0, MSelect = any M, KeyldSelect = 0, WordSelectForDesiredM = any, RE= Rc If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelectl and [WordSelectForDesiredM], R3 = RL, SIG 5 = SIGout Refer to Section 15.3.1 3 A.Random None RA= RL 4 C. Translate InputKeyRef =n2, DataLength = Length of MWords in words preformatted as per Section 17.1, Data = MWords preformatted as per Section 17.1, RE= RB, SIGE = SIG 2 , OutputKeyRef = n3, RE2 = RA If ResultFlag = Pass then Re =RL1, SIGc= SIGOut Refer to Section 15.3.1 WO 2004/050369 PCT/AU2003/001616 918 5 A.Test KeyRef = n2, DataLength = Length of MWords in words preformatted as per Section 16.1, Data = MWords preformatted as per Section 16.1, RE =Rc 1 , SIGE = SIGc ResultFlag = Pass/Fail 31.4 UPDATING THE INK-REMAINING This sequence is performed when the printer is printing. The ink QA Device holds the logical amount of ink-remaining corresponding to the physical ink left in the cartridge. This logical ink 5 amount must decrease, as physical ink from the ink cartridge is used for printing. 31.4.1 Sequence of update The primary question is when to deduct the logical ink amount - before or after the physical ink is used. a. Print first (use physical ink) and then update the logical ink. If the power is cut off after a 10 physical print and before a logical update, then the logical update is not performed. Therefore, the logical ink-remaining is more than the physical ink-remaining. Performing repeated power cuts will increase the differential amount, and finally any physical ink could be used to refill the QA Device. b. Update the logical ink and then print (use physical ink). This is better than 15 (a) because other physical inks cannot be used. However, if a problem occurs during printing, after the logical amount has already been deducted, there will be a disparity between logical and physical amounts. This might result in the printer not printing even if physical ink is present in the ink cartridge. The amount of disparity can be reduced by increasing the frequency of updating logical ink i.e update after each line instead of after each page. 20 c. Preauthorise logical ink. Preauthorise certain amount of ink (depends on the frequency of logical updates) before print and clear it at the end of printing. If power is cut off after a page is printed, then on start up, the printer reads the preauthorisation field, if it has not been cleared, it applies the preauth amount to the ink-remaining amount, and then clears the preauthorisation field. 25 31.4.2 Basic update Some printers may use one of methods described in Section 31.4.1 (a) or (b) to update logical ink amounts in the ink QA Device. This method of updating the ink is termed as a basic update. The decremented amount is written to the appropriate ink field (which has been previously determined using Section 31.2.2) in mo. The printer verifies the write, by reading the signature of the written 30 data, then passing it to the Test function of the trusted QA Device. For signature to be valid, the trusted QA Device (A) and ink QA Device (B) must share a common or a variant key i.e B.Kn 1 = A.Kn2 or B.Kn 1 = FormKeyVariant(A.Kn 2 , B.Chipld).
WO 2004/050369 PCT/AU2003/001616 919 Table 315. Command sequence for updating the ink-remaining (basic) Seq Function Parameter No 1 B.WriteFields VectNum = 0, FieldSelect =Select bits corresponding to the ink fields, The ink field locations should have been determined before by using the method in Section '31.2.2.1 FieldVal= Decremented ink-remaining amount ResultFlag = Pass/Fail 2 A.Random None RA = RL 3 B.Read KeyRef = n1, SigOnly 1, (We only need the signature because we already know the data) MSelect = Mo, KeyldSelect = 0, WordSelectForDesiredM = corresponds to the ink fields written in Seq No 1, RE= RA If ResultFlag = Pass then SelectedWordsOfSelectedMs not returned because [SigOnly] = 1 in Seq 3, RB RL, SIG 3 = SIGout Refer to Section 15.3.1. 4 A. Test KeyRef = n2, DataLength = length in words as per Seq No 1 [MVal] preformatted as per Section 16.1, Data = as per Seq No I [MVal] preformatted as per Section 16.1, RE =RB, SIGE = SIGB ResultFiag = Pass/Fail 31.4.3 Preauthorisation 5 This section describes the update of logical ink amounts using preauthorisation. The basic preauthorisation sequence is as follows: a. Preauthorise before the first print. Preauthorisation amount depends on the printer model. Example amounts could be the ink required for an fully covered A4 page or an A3 page. Value corresponding to the preauth amount is written to the preauth field in the ink QA 10 Device. Note: The preauth value must be correctly interpreted on different printer models i.e if a preauthorisation amount of A4 page is set in the ink cartridge in printer modelll, and later the ink cartridge is placed in printer2(model2) with its preauth still set, printer2 must deduct an A4 page worth of ink from ink-remaining amount. 15 b. Print the page. c. Write the deducted logical amount to the ink field of the ink QA Device and validate the write by reading the signature of the ink field. d. Repeat b to c till the last page has been printed. e. Clear the preauth amount.
WO 2004/050369 PCT/AU2003/001616 920 f. If the power is cut off before the preauth is applied, on startup apply the preauth amount to the corresponding ink field, by performing a non authenticated write of the decremented amount and clear the preauth amount by performing an authenticated write of the preauth field. 5 31.4.3.1 Setup of the preauth field Only a single preauth gield must exist in an Ink QA Device. Preauth field will consist of a single Mo word but can be optionally extended to two MO words by using a different value of type attribute. Figure 388 shows the setup of preauth field's attributes in M1 10 . The preauth field has authenticated ReadWrite access using the INKUSAGEKEY i.e INKUSAGEKEY can perform authenticated writes to this field. This key or its variant is shared between the ink QA Device and the printer QA Device to validate any data read from the ink cartridge. For signature to be valid, B.Kn 1 = A.Kn 2 or B.K 1 = FormKeyVariant(A.Kn 2 , B.Chipld), where Kn 1 = INK USAGEKEY. The system performs a WriteAuth to the preauth field using this 15 key, to set up the preauth amount, and to clear the preauth amount. The preauth field is identified by two attributes: * Type attribute - TYPEPREAUTH . Refer to Appendix A. * Keyld of KeyNum attribute must be the same as the Key/d of the INKUSAGEKEYwhich the printer uses to validate the any data read from the ink QA 20 Device. The Preauth field can be applied to a single ink field or multiple ink fields. 31.4.3.2 Preauth applied to a single ink field In this case the entire preauth field is used to store the preauth amount and is only linked to one ink field. 25 31.4.3.3 Preauth applied to multiple ink fields Multiple preauth fields can be accommodated in a single Mo field by a scheme shown in Figure 388A. This scheme supports a maximum of 8 ink fields being present in the Ink QA Device. The field in mo is divided into two parts- preauth field select and preauth amount. Each bit in preauth 30 field select corresponds to a single ink field, and the preauth amount for each ink field is the same. If an Ink cartridge uses multiple inks which are preauthorised, then each of the inks will have a corresponding preauth field bit. Before a particular ink is used for printing the corresponding preauth field bit is set. The preauth amount field is also set if the previous amount is zero. At finish, the preauth field bit is cleared. If more than one ink is used, the preauth bit for each ink field is set, and 35 at finish each bit is cleared with last bit clearing the preauth amount as well. 31.4.3.4 Locating preauth fields and determining preauth field value WO 2004/050369 PCT/AU2003/001616 921 The preauth field can be located in the same manner as the ink field. If the printer wants to find the preauth field in the ink QA Device, it must call the function FindFieldNum (see Section 31.2.2.2) with key/dRequired = Keyid of NetworkOEM_InkUsageKey and typeRequired = TYPEPREAUTH. The preauth field value can be read in the same manner as the ink-remaining amount. This requires 5 using of the function GetFieldDataWords(FieldNum,FieldData, MO,M1) described in Section 27.1.4.14. FieldNum must be set to the value returned from function FindFieldNum, which in this case is the field number of the preauth field. FieldData returns the value of the preauth field. 31.4.3.5 Command sequence The command sequence can be broken up into three parts: 10 e Start of print sequence. * During print sequence. * End of print sequence., 31.4.3.5.1 Start of print sequence This sets up the preauth amount before the start of printing. 15 Table 316 shows the command sequence for start of print sequence. The first Random- Read-Test sequence determines the preauth field in the ink QA Device and its value. The Random-SignM WriteFieldsAuth sequence, then writes to the preauth field the new preauth value. Table 316. Updating the consumable remaining (preauth) start of print sequence Seq Function Parameters No Random-Read -Test sequence to determine the location of the preauth field in the ink QA Device end its value I A.Random None RA = RL 2 B.Read KeyRef = n1, SigOnly = 0, WordSelectForDesiredM (for Mo) = all 16 words of MO and all 16 words of M1 MSelect = Ox03(indicates MO and Ml), KeyldSelect = OxFF (Read all Keylds), WordSelectForDesiredM (for Mo)= OxFFFF (Read all 16 mowords), WordSelectForDesiredM (for ml)= OxFFFF(Read all 16 miwords), RE= RA If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB = R SIGB= SiGout Refer to Section 15.3.1 3 A. Test KeyRef = n2, DataLength = length of MWords in words preformatted as per Section 16.1, Data = MWords as per Seq No 2 preformatted as per Section 16.1, RE =RB, SIGE SIGB WO 2004/050369 PCT/AU2003/001616 922 ResutFlag = PassFail Random-SignM-WriteFieldsAuth sequence to write the new preauth value 4 B.Random None RB= RL 5 A.SignM KeyRef n2, FieldSelect = Select bit corresponding to the Preauth field, FieldVal = new preauth value, Chipid = Chipld of B, RE= RB1 If ResuitFiag = Pass then RAI = RL SIGA= SiGout Refer to Section 27.1.3.1 6 B.WriteFieldsAuth KeyRef = n1, FieldSelect= same as Seq 5 [FieldSelect], FieldVal= same as Seq 5 [FieldVal], RE= RA1, SIGE = SIGA ResultFlag = Pass'/Fail 31.4.3.5,2 During print sequence 5 This set of commands are repeated at equal intervals to update logical ink amounts to the ink QA Device during printing. Table 317 shows the command sequence for the print sequence. The WriteFields writes the updated value to the ink field. Random-Read-Test reads back the value written and tests whether the value read matches the value written. 10 Table 317. Updating the consumable remaining (preauth) during print sequence Seq Function Parameters INo Write the decremented ink-remaining account. 7 8. WriteFields FieldSelect = Select bits corresponding to the Ink fields, FieldVal= Decremented ink-remaining amount for a single ink or multiple ink fields as per FieldSelect. ResultFlag = Pass /Fail Random-Read-Test sequence to read and verify the ink-remaining amount written 8 A.Random None RA = RL 9 B.Read KeyRef = n1, SigOnly = 1 -(We only need the signature because we already know the data), MSelect =0x01 (only Mo), KeyldSelect = 0, WordSelectForDesiredM = corresponds to the ink fields written in Seq No 7, RE= RA WO 2004/050369 PCT/AU2003/001616 923 If ResultFlag Pass then SelectedWordsOfSelectedMs not returned because [SigOnly] I in Seq 9 RB = RL, SIGB = SIGout Refer to Section 15.3,1. 10 A. Test KeyRef = n2, DataLength = length in words as per Seq No 7 [MVal] preformatted as per Section 16.1, Data = as per Seq No 7 [MVal] preformatted as per Section 16.1, RE =RB, SIGE = SIGB ResultFlag =. Pass/Fail 31.4.3.5.3 End of print sequence This sequence clears preauth amount before the print sequence is completed. Table 318 shows the command sequence for the end of print sequence. 5 The preauth field is read using the Random-Read-Test sequence. And the preauth field is cleared using the Random-SignM-WriteFieldsAuth sequence. Table 318. Updating the consumable remaining (preauth) end of print sequence Seq Function Parameters No Random-Read-Test sequence to read the preauth field and verify the preauth data II 4.Random None RA = RL 12 8.Read KeyRef = n1, SigOnly = 1, MSelect = OxO1 (only MO), KeyldSelect 0, WordSelectForDesiredM (for Mo)= Words corresponding to the Preauthfield that has been written to in Seq 5 [FieldSelect] in Table 317. RE= RA If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per Seq No 12 [MSelect] and [WordSelectForDesiredM], RB = RL, SIGR= SIGout Refer to Section 15.3.1 13 4. Test KeyRef = n2, DataLength = length of MWords in words as per Seq No 12 preformatted as per Section 16.1, Data = MWords as per Seq No 12 preformatted as per Section 16.1, RE =RB, SIGE = SIG8 ResultFlag = Pass/Fail |Random-SignM-WriteFieldsAuth sequence clears the preauth field 14 B.Random None RB1=RL 15 4.SignM KeyRef = n2, FieldSelect =Select bit corresponding to Pre authfield, FieldVa = Clear the preauth field, Chipid = Chipid of B, RE= RB1 If ResultFlag = Pass then RA1= RL SIGA =SlGout Refer to Section 27.1.3.1 WO 2004/050369 PCT/AU2003/001616 924 16 B.WriteFieldsAuth KeyRef = n1, FieldNum = same as Seq 5 {FieldSelect], FieldData = same as Seq 5 [FieldVal], RE= RB1, SIGE = SIGA ResuitFiag = Pass /Fail 31.4.4 Preauthorisation through the Translate function This is performed when the system trusted QA Device doesn't share a key with the ink QA Device, and uses a translating QA Device to Translate a Read from the ink QA Device, and to Translate a 5 SignM to the ink QA Device. The basic translate principle involves translating the Read data from the untrusted QA Device, to the Test data of the trusted QA Device, and translating the SignM data from the trusted QA Device, to the WriteFieldsAuth data of the untrusted QA Device. For validating signatures using translation: 10 9 The trusted QA Device (A) and the translating QA Device (C) must share a common or a variant key i.e C.Ka 3 = A.Kn 2 or C.Ka 3 = FormKeyVariant(A.Kn2, C.Chipid). * The ink QA Device (B) and the translating QA Device (C) must share a common or a variant keyi.e C.Kn 2 = B.Kn 1 or B.Kn 1 = FormKeyVariant(C.Kn 2 , B.Chipid). Only the start of print sequence is described using Translate. The rest of the sequences in 15 preauthorisation can be modified to apply translation using this example. Table 319 shows the command sequence for preauth (start of print sequence) using translation. Table 319. Preauth(start of print sequence) using translate command Seq Function Parameter No Random-Read-Random-Translate-Test sequence reads the location of the preauth field and its value using the translating QA Device C 1 C Random None Rc= RL 2 B.Read KeyRef = ni, SigOnly = 0, MSelect = 0x03(indicates MO and M1), KeyldSelect = OxFF (Read all Keylds), WordSelectForDesiredM (for Mo)= OxFFFF (Read all 16 mo words), WordSelectForDesiredM (for M1)= OxFFFF(Read all 16 Mlwords), RE= RA If ResuitFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB3 RL, SIGB SIGout Refer to Section 15.3.1 3 A.Random None RA= RL WO 2004/050369 PCT/AU2003/001616 925 4 C. Translate InputKeyRef =n2, DataLength (in words) = length of MWords in words as per Seq No 2 preformatted as per Section n 17.1, Data = MWords as returned from Seq No 2 preformatted as per Section 17.1, RE= RB, SIGE = SIGB OutputKeyRef = n3, RE2 = RA If ResuitFiag = Pass then Rc 1 = RL2, SIG' = SIGOut Refer to Figure 15.3.1 5 A. Test KeyRef = n2, DataLength = length of MWords in words as per Seq No 2 preformatted as per Section 16.1, Data = MWords as returned from Seq No 2 parameter preformatted as per Section 16.1, RE =Rc 1 , SIGE = SIGc ResultFlag = Pass/Fail Random-SignM-Random-Translate-WriteFieldAuth sequence to write the new preauth value using the translating QA Device C 6 C.Random None
RC
2 = RL 7 A.SignM KeyRef = n2, FieldSelect =Select bit corresponding to Pre authfield, FieldVal = new value of preauth field, Chipid = Chipid of B, RE= RC 2 If ResultFlag = Pass then RAI = RL SIGA= SIGout Refer to Section 27.1 .3. 8 B.Random None PRBI= R 9 C. Translate lnputKeyRef =n3, DataLength (in words) = length in words as per Seq 7 [FieldSelect] preformatted as per Section 17.1, Data = same as Seq 7 [FieldVal] preformatted as per Section 17.1, RE= RAI, SIGE = SIGA, OutputKeyRef = n2, RE2 = RB, If ResultFlag = Pass then Rca= RL2.S[Gc= SIGOut Refer to Figure 15.3.1 10 B. WriteFieldsAuth KeyRef = n1, FieldNum = same as Seq 7 [FieldSelect], FieldData = same as Seq 7 [FieldVal], RE= RC 3 , SIGE = SIGc ResultFlag = Pass /Fail, 31.5 UPGRADING THE PRINTER PARAMETERS This sequence is performed when a printer's operating parameter is upgraded. The Parameter Upgrader QA Device stores the upgrade value which is copied to the operating 5 parameter field of the Printer QA Device, and the count-remaining associated with upgrade value is decremented by 1 in the Parameter Upgrader QA Device. The Parameter Upgrader QA Device output the data and signature only after completing all necessary checks for the upgrade. 10 WO 2004/050369 PCT/AU2003/001616 926 31.5.1 Basic The basic upgrade is used when the Parameter Upgrader QA Device and Printer QA Device being upgraded share a common key or a variant key i.e B.Kn 1 = A.Kn 2 or B.K, 1 = FormKeyVariant(A.Kn 2 , B.Chipid), where B is the Printer QA Device and A is the Parameter Upgrader QA Device. 5 Therefore, the messages and their signatures, generated by each of them can be correctly interpreted by the other. The transfer sequence is performed using Random-Read-Random-XferField-WriteFieldsAuth. Table 320 shows the command sequence for a basic upgrade. Table 320. Basic upgrade command sequence 10 Seq Function Parameter lNo Random-Read-Random-XferField-WriteFieldsAuth reads MO and M1of the QA Device being upgraded, Parameter Upgrader QA Device produces the upgrade value for FleldNumE and Sequence data fields SEQ_1 and SEQ 2, then these values are written to the Printer QA Device. 1 .Random None RA RL 2 B.Read KeyRef = n1, SigOnly = 0, MSelect = 3 (indicates Mo and Ml), KeyldSelect OxO (no KeyIds required), WordSelectForDesiredM (for MO)= OxFFFF (Read all Mowords), WordSelectForDesiredM (for ml)= OxFFFF(Read all M1words), RE= RA If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs, as per input [MSelect] and WordSelectForDesredM],Ra = RL,. SIGB= SiGout Refer to Section 15.3.1 3 B.Random None
RB
1 = RL A.XferField KeyRef = n2, MoOfExternal = First 16 words of MWords, miOfExternal= Last 16 words of MWords, Chipid = Chipid of B, FieldNumL= The field storing the upgrade value in the Parameter Upgrader QA Device. The value of this field will be copied to FieldNumE. FieldNumE= The field which will be upgraded in the Printer QA Device. RE= RB, RE2 = RB1, SIGE= SIGB If ResultFlag = Pass then FieldSelectB1 = FieldSelect - Select bits for FieldNumE and Seq data fields SEQ_1 and SEQ_2 field, FieldValB1 = FieldVal -New Value for FleidNumE (Copied from FieldNumL of the Parameter Upgrader QA Device) and sequence data fields RAI= R , SIGA = SIGout = Refer to Section 27.1.3.1.
WO 2004/050369 PCT/AU2003/001616 927 5 B.WriteFieldsAuth KeyRef = n1, FieldSelect= FieldSelectBl, FieldData = FieldValBI, RE = RA1, SIGE = SIGA ResultFlag = Pass/Fail 31.5.2 Using the Translate function The upgrade through the Translate function is used when the Parameter Upgrader QA Device and the Printer QA Device don't share a key between them. The translating QA Device shares a key 5 with the Parameter Upgrader QA Device and a second key with the Printer QA Device. Therefore the messages and their signatures, generated by the Parameter Upgrader QA Device and the Printer QA Device are translated appropriately by the translating QA Device. The translating QA Device validates the Read from the Printer QA Device, and translates it for input to the XferField function. The translating QA Device will validate the output from the XferFieldfunction, and then 10 translate it for input to WriteFieldsAuth message of the Printer QA Device. For validating signatures using translation: * The Parameter Upgrader QA Device (A) and the translating QA Device (C) must share a common or a variant key i.e C.Ka 3 = A.Kn2 or C.Kn3= FormKeyVariant(A.Kn 2 , C.Chipld). " The Printer QA Device (B) and the translating QA Device (C) must share a common or a 15 variant key i.e C.Kn 2 = B.Kn 1 or B.Kn 1 = FormKeyVariant(C.Kn 2 , B.Chipid). Table 321 shows the command sequence for a basic refill using translation. Table 321. An upgrade with translate command sequence Seq Function Command No Random-Read-Random-Translate-Random-XferField-Random-Transate-Random-WriteFieldsAuth reads MO and M1of the Printer QA Device using the translating QA Device C and then does a write of the upgrade value to FieldNumE and new sequence data to the seq data fields SEQI and SEQ 2 field of the Printer QA Device using the translating QA Device C. 1 C.Random None Rc RL 2 B.Read KeyRef = n1, SigOnly = 0, MSelect =0x03(indicates mo and ml), KeyldSelect = OxOO (no KeyIds required), WordSelectForDesiredM (for MO)= OxFFFF (Read all Mowords), WordSelectForDesiredM (for mi)= OxFFFF(Read all mi words), RE= Rc If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB RL, SIGB = SIGout Refer to Section 15.3.1 3 .Random None WO 2004/050369 PCT/AU2003/001616 928 RA= RL 4 C. Translate InputKeyRef =n2, DataLength = MWords length in words as per Seq No 2 preformatted as per Section 17.1, Data = MWords as returned from Seq No 2 preformatted as per Section 17.1, RE= RB, SIGE= SIGB, OutputKeyRef = n3, RE2 = RA If ResultFlag Pass then Rc RL2, S[Gc= SIGOut Refer to Section 17.3.1 5 C.Random None Re2= RL 6 A.XferField KeyRef = n2, moOfExternal = First 16 words of MWords, mOfExternal= Last 16 words of MWords, Chipld = Chipld of B, FieldNumL= The field storing the upgrade value in the Parameter Upgrader QA Device. FieldNumE= The field which will be upgraded in the Printer QA Device. RE= Rc 1 , RE2= Rc 2 , SIGE= SIGc If ResultFlag = Pass then FieldSelectB1 = FieldSelect -Select bits for FieldNumE and sequence fields, FieldValB1 = FieldVal -New Value for FieldNumE (Copied from FieldNumL of the Parameter Upgrader QA Device) and sequence fields SEQ_1 and SEQ_2, RA1= RL2, SIGA= SIGout RefertoSection 27.1.3.1 7 B.Random None RBI = RL 8 C. Translate InputKeyRef =n3, DataLength = FieldValBI length in words as per Seq No 6 preformatted as per Section 17.1, Data = FieldValB1 as returned from Seq No 6 preformatted as per Section 17.1, RE= RA1, SIGE = SIGA, OutputKeyRef= n2, RE2 = RB1 If ResultFlag = Pass then Rc 3 = RL2, SIG 0 SlGOut Refer to Section 17.3.1 19 B.WriteFieldsA KeyRef = n1, FieldSelect = FieldSelectBl, FieldVal = FieldValB1, RE = Rc 3 , uth SIGE = SIGc 10 ResultFlag = Pass/Fail 31.6 RECOVERING FROM A FAILED UPGRADE This sequence is performed if the upgrade failed (for e.g Printer QA Device didn't receive the upgrade message correctly and hence didn't upgrade successfully). The Parameter Upgrader QA 5 Device therefore needs to be rolled back to the previous value before the upgrade. In this case, the count-remaining associated with the upgrade value in the Parameter Upgrader QA Device is increased by one. The Parameter Upgrader QA Device checks that the Printer QA Device didn't actually receive the message correctly using the StartRolBack function. The RollBackField performs further 10 comparisons on sequence fields and Fle/dNumE of the Printer QA Device to values stored in the XferEntry cache. After performing all checks, the Parameter Upgrader QA Device increments the WO 2004/050369 PCT/AU2003/001616 929 count remaining field associated with the upgrade value field by one. Refer to Section 26 and Section 28 for details. The rollback is started using the Random-Read-Random-StartRollBack-WriteFieldsAuth and the rollback of the Parameter Upgrader QA Device is performed using Random-Read-RollBackField 5 sequence. Table 322 shows the command sequence for a rollback upgrade. Seq Function Command No Random-Read-Random-StartRollBack-WriteFieldsAuth starts the rollback and updates data for the sequence fields. 1 A.Random None RA = RL 2 B.Read KeyRef = ni, SigOnly = 0, MSelect =0x03(indicates Mo and ml), KeyldSelect = OxOO (no Keylds required), WordSelectForDesiredM (for mo)= OxFFFF (Read all mowords), WordSelectForDesiredM (for mi)= OxFFFF(Read all Miwords), RE= RA If ResultFlag Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB = RL, SIGB= SIGout Refer to Section 15.3.1 3 B.Random None RB1 = RL 4 A.StartRoll KeyRef = n2, MoOfExternal = First 16 words of MWords, mIOfExternal= Last 16 Back words of MWords, Chipid = ChipId of B, FieldNumE= The field which was not upgraded in the Printer QA Device, FieldNumL = The upgrade value in the Parameter Upgrader QA Device which couldn't be copied to FieldNumE of the Printer QA Device, RE= RB, RE2 = RB1, SIEGE= SIGB If ResultFlag = Pass then FieldSelectB = FieldSelect - Select bits for sequence data fields SEQ_1 and SEQ 2, FieldVaIB = FieldVal - New values for SEQ_1 and SEEQ_2 fields RA1 = RL2 SIGA = SIGout Refer to Section 27.1.3.1. 5 B. WriteFiel KeyRef = n1, FieldSelect= FieldSelectB, FieldData = FieldValB, RE = RA1, SIGE dsAuth SIGA ResultFlag = Pass/Fal Random-Read-RollBackField performs a read of the QA Device being upgraded, checks its values are as per Xfer Entry cache, and then adjusts its count-remaining field. A.Random None =RA =RL WO 2004/050369 PCT/AU2003/001616 930 7 B.Read KeyRef = n1, SigOnly = 0, MSelect =0x03(indicates Mo and ml), KeyldSelect = 0x00 (no Keylds required), WordSelectForDesiredM (for Mo)= OxFFFF (Read all M0words), WordSelectForDesiredM (for m1)= OxFFFF(Read all MIwords), RE= RA2 If ResultFlag =.Pass then MWords = SelectedWordsOfSelectedMs as per input [M~elect] and [WordSelectForDesiredM], RB2 = RL, SIGB= SIGout Refer to Section 15.3.1 8 A.RollBack KeyRef = n2, MOfExternal First 16 words of MWords, MiOfExternal= Last 16 Field ords of MWords, Chipid = Chipid of B, FieldNumE= The field which was not upgraded in the Printer QA Device, FieldNumL = The upgrade value in the Parameter Upgrader QA Device which couldn't be copied to FieldNumE of the Printer QA Device, RE= RB 2 , SIGE= SIGB ResultFlag = Pass/Fail 31.7 RE/FILLING THE CONSUMABLE (INK) This sequence is performed when an ink cartridge is first manufactured or after all the physical ink has been used, it can be filled or refilled. The re/fill protocol is used to transfer the logical ink from 5 the Ink Refill QA Device to the Ink QA Device in the ink cartridge. The Ink Refill QA Device stores the amount of logical ink corresponding to the physical ink in the refill station. During the refill, the required logical amount (corresponding to the physical transfer amount) is transferred from the Ink Refill QA Device to the Ink QA Device. The Ink Refill QA Device output the transfer data only after completing all necessary checks to 10 ensure that correct logical ink type is being transferred e.g NetworkOEM1_infrared ink is not transferred to NetworkOEM2_cyan ink. Refer to the XferAmount command in Section 27.1. 31.7.1 Basic refill The basic refill is used when the Ink Refill QA Device and the Ink QA Device share a common key or a variant key i.e B.Kmj = A.Kn 2 or B.K 1 = FormKeyVariant(A.Kn 2 , B.Chipld) where B is the Ink QA 15 Device and A is the Ink Refill QA Device. Therefore, the messages and their signatures, generated by each of them can be correctly interpreted by the other. The Xfer Sequence is started using Random-Read-Random-StartXfer-WriteAuth and the the Xfer Amount is written to the QA Device being refilled using Random-Read-Random-XferAmount WriteFieldsAuth sequence. 20 WO 2004/050369 PCT/AU2003/001616 931 Table 323 - the command sequence for a basic refill. Seq Function Parameter NoI Random-Read-Random-XferAmount-WriteFieldsAuth reads MO and M1 of the Ink QA Device being refilled, produce updated amount for FieldNumE and sequence datat field by calling XferAmount on Ink Refill QA Device, and finally writing the updated value to Ink QA Device using WriteFieldsAuth. 1 A.Random None RA RL 2 B.Read KeyRef = n1, SigOnly = 0, MSelect = 0x03(indicates mo and ml), KeyldSelect = OxO (no Keylds required), WordSelectForDesiredM (for mo)= OxFFFF (Read all Mowords), WordSelectForDesiredM (for m1)= OxFFFF(Read all M1words), RE= RA If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB = RL, SIGB= SIGout Refer to Section 15.3.1 3 B.Random None
RB
1 = RL 4 AxferAmount KeyRef = n2, MoOfExternal = First 16 words of MWords, mlOfExternal= Last 16 words of MWords, Chipld = Chipld of B, FieldNumL= ink-remaining field of the Ink Refill QA Device, FieldNumE= ink-remaining field of the Ink QA Device, XferValLength = length in words of XferVal XferVal = Value to be transferred from Ink Refill QA Device to Ink QA Device being refilled, RE= RB, RE2= RB1, SIGE= SIGB If ResultFlag = Pass then FieldSelectB1 = FieldSelect - Select bits for FieldNumE and sequence data field SEQ_1 and SEQ 2, FieldValB1 = FieldVal -New Value for FieldNumE (transferred from FieldNumL of the Ink Refill QA Device) and sequence data fields SEQ_1 and SEQ_2, RA1 = RL2, SIGA = SIGout Refer to Section 27.1.3.1. 5 B. WriteFieldsAut KeyRef = n1, FieldSelect= FieldSelectB, FieldData = FieIdValB, RE = RA1, SIGE h = SIGA ResultFlag = Pass/Fal 5 31.7.2 Using the Translate function The refill through the Translate function is used when the Ink Refill QA Device and the Ink QA Device don't share a key between them. The translating QA Device shares a key with the Ink Refill WO 2004/050369 PCT/AU2003/001616 932 QA Device and a second key with the Ink QA Device. Therefore the messages and their signatures, generated by the Ink Refill QA Device and the Ink QA Device, are translated appropriately by the translating QA Device. The translating QA Device validates the Read from the Ink QA Device, and translates it for input to the XferAmount function. The translating QA Device will validate the output 5 from the XferAmount function, and then translate it for input to WriteFieldsAuth message of the Ink QA Device. For validating signatures using translation: e The Ink Refill QA Device (A) and the translating QA Device (C) must share a common or a variant key i.e C.Kn 3 = A.Kn 2 or C.Kn 3 = FormKeyVariant(A.Kn 2 , C.Chipld). 10 * The Ink Refill QA Device being refilled (B) and the translating QA Device (C) must share a common or a variant key i.e C.Ka 2 = B.Kn 1 or B.Kn 1 = FormKeyVariant(C.Kn 2 , B.Chipid). Table 324. A basic refill using translation command sequence Seq Function Command No Random-Read-Random-Translate-Random-XferAmount-Random-Translate-Random-WriteFieldsAuth reads MO and M1 of the Ink QA Device being refilled using the translating QA Device C, produce updated amount for FieidNumE and sequence data field by calling XferAmount on Ink Refill QA Device, and finally writing the updated value to Ink QA Device using the translating QA Device. 1 C.Random None
R
c = RL 2 B.Read KeyRef = n1, SigOnly = 0, MSelect =0x03(indicates MO and Ml), KeyldSelect OxOO (no Keylds required), WordSelectForDesiredM (for Mo)= OxFFFF (Read all mowords), WordSelectForDesiredM (for ml)= OxFFFF(Read all Miwords), RE= RC If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB = RL, SIGB= SIGout Refer to Section 15.3.1 3 Random None RA =RL 4 C. Translate InputKeyRef =n2, DataLength = MWords length in words as per Seq No 2 preformatted as per Section 17.1, Data = MWords as returned from Seq No 2 preformatted as per Section 17.1, RE= RB, SIGE= SIGB, OutputKeyRef = n3, RE2 = RA If ResultFlag = Pass then Rc 1 = RL, SlGc= SIGOut Refer to Section 17.3.1 5 C. Random None RL =Rca WO 2004/050369 PCT/AU2003/001616 933 6 A.XferAmount KeyRef = n2, MOfExternal = First 16 words of MWords, MlOfExternal= Last 16 words of MWords, Chipld = Chipid of B, FieldNumL= ink-remaining field of the Ink Refill QA Device, FieldNumE= ink-remaining field of the Ink QA Device, XferValLength = length in words of XferVal XferVal = Value to be transferred from Ink Refill QA Device to Ink QA Device being refilled, RE= Rc 1 , RE2 = RC 2 , SIGE= SIGc If ResultFlag = Pass then FieldSelectB1 = FieldSelect - Select bits for FieldNumE and sequence data field SEQ_1 and SEQ_2, FieldValB1 = FleldVal -New Value for FieldNumE (transferred fromFieldNumL of the Ink Refill QA Device) and sequence data fields SEQ_1 and SEQ 2, RA1= RL2, SIGA SIGout Refer to Section, 27.1.3.1 7 B.Random None RBI=RL 8 C. Translate InputKeyRef =n3, DataLength = FieldVaIB length in words as per Seq No 6 preformatted as per Section 17.1, Data = FieldVaIB as returned from Seq No 6 preformatted as per Section 17.1, RE= RA1, SIGE = SIGA, OutputKeyRef= n2, RE2 = RB 1 If ResultFlag = Pass then ReC 3 = RL2, SIGc= SIGOut Refer to Section 17.3.1 9 B. WriteFieldsAuth KeyRef = ni, FieldSelect= FieldSelectB, FieldData = FieldValB, RE = Rc 3 , SIGE = SIGc ResultFlag ='Pass/Fail 31.8 RECOVERING FROM A FAILED REFILL This sequence is performed if the refill failed (for e.g Ink QA Device didn't receive the refill message correctly and hence didn't refill successfully). The Ink Refill QA Device therefore needs to be rolled 5 back to the previous value before the refill. The Ink Refill QA Device checks that the Ink QA Device didn't actually receive the message correctly using the StartRollBack function. The Rol/BackAmount performs further comparisons on sequence data field and F/eldNumE of the Ink QA Device, to values stored in the XferEntry cache. After performing all checks, the Ink Refill QA Device adjusts its ink field to a previous value before 10 the transfer request was processed by it. Refer to Section 26 and Section 28 for details. The rollback is started using the Random-Read-Random-StartRolBack-WriteFieldsAuth and the rollback of the Ink Refill QA Device is performed using Random-Read-RollBackAmount sequence.
WO 2004/050369 PCT/AU2003/001616 934 Table 325. Rollback amount command sequence SeqFunction Command No Random-Read-Random-StartRollBack-WriteAuth starts the rollback and updates data for the sequence data fields SEQ_I and SEQ_2. 1 A. Random None RA = RL 2 B.Read KeyRef = n1, SigOnly = 0, MSelect =0x03(indicates mo and mi), KeyldSelect = OxOO (no Keylds required), WordSelectForDesiredM (for Mo)= OxFFFF (Read all Mowords), WordSelectForDesiredM (for mi)= OxFFFF(Read all Miwords), RE= RA If ResultFlag = Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], R= RL, SIGB SIGout Refer to Section 15.3.1 3 B.Random None
RB
1 = RL 4 A.StartRol/Back KeyRef = n2, moOfExternal = First 16 words of MWords, mlOfExternal= Last 16 words of MWords, Chipid = Chipld of B, FieldNumL= ink-remaining field of the Ink Refill QA Device which will be adjusted to the value before the failed refill, FieldNumE= ink-remaining field of the Ink QA Device which failed to refill, RE RB, RE2 = RB 1 SIGE= SIGB If ResultFlag = Pass then FieldSelectB = FieldSelect -Select bits for sequence data fields- SEQ_1 and SEQ_2, FieIdValB = FieldVal - New value for sequence data fields SEQ_1 and SEQ_2 RA1 = RL2, SIGA = SIGout Refer to Section 27.1.3.1. 5 B.WriteFieldsAuth KeyRef = n1, FieldSelect= FieldSelectB in Seq No 4, FieldData = FieldVaIB in Seq No 4 RE = RA1, SIGE = SIGA 10 ResultFlag Pass/Fail Random-Read-RollBackAmount performs a read of the Ink QA Device, checks its values are as per Xfer Entry cache, and then adjusts its ink-remaining field. 11 A.Random None RA. = RL 12 B.Read KeyRef =n1, SigOnly= 0, MSelect =0x03(indicates Mo and ml), KeyldReq = 0 (not required), KeyldSelect = OxOO (no Keylds required), WordSelectForDesiredM (for Mo)= OxFFFF (Read all Mowords), WordSelectForDesiredM (for ml)= OxFFFF(Read all WO 2004/050369 PCT/AU2003/001616 935 w ordss, RE= RA2 If ResultFlag Pass then MWords = SelectedWordsOfSelectedMs as per input [MSelect] and [WordSelectForDesiredM], RB 2 = RL, SIGB = SIGout Refer to Section 15.3.1 13 A.RollBackAmount KeyRef = n2, moOfExternal =First 16 words of MWords, MIOfExternal= Last 16 words of MWords, Chipid = Chipid of B, FieldNumL= ink-remaining field of Ink Refill QA Device which will be adjusted to the value before the failed refill, FieldNumE= ink-remaining field of Ink QA Device which failed to refill, RE= RB2, SIGE= SIGB ResultFlag Pass/Fail 31.9 UPGRADING/REFILLING/FILLING THE UPGRADER This sequence is performed when a count-remaining field in the Parameter QA Device must be updated or when the ink-remaining field in the Ink Refill QA Device requires re/filling. 5 In case of the Parameter QA Device, another Parameter Upgrader Refill QA Device transfers its count-remaining value to the Parameter QA Device using the transfer sequence described in Section 31.4. Also refer to Section 28.6. This means the count-remaining in the Paramater Upgrader Refill QA Device must be decremented by the same amount that Parameter Upgrader QA Device is incremented by i.e a credit transfer occurs. 10 In case of the Ink Refill QA Device, another Ink Refill QA Device transfers its ink-remaining value to the Ink Refill QA Device using the transfer sequence described in Section 31.4. Also refer to Section 26.4. This means the logical ink-remaining in the Ink Refill QA Device must be decremented by the same amount that QA Device being refilled is incremented by i.e a credit transfer occurs. 32 Setting up for field use 15 This section consists of setting up the data structures in the QA Device correctly for field use. All data structures are first programmed to factory values. Some of the data structures can then be changed to application specific values at the ComCo or the OEM, while others are set to fixed values. 32.1 INSTANTIATING THE QA CHIP LOGICAL INTERFACE 20 This sequence is performed when the QA Device is first created. Table 326 shows the data structure on final program load.
WO 2004/050369 PCT/AU2003/001616 936 Table 326. Data structure set up during final program load Data Structure Value Set to Fixed or Updatable Name Chipid Unique Identifier for QA Device Fixed NumKey Number of keys the QA Device can hold Fixed Kn All Kn = Kbatch. The K batch is unique for a Updateable if previous value is production batch. known Keyld All Keylds = Keyld of Kbatch. Updateable along with K. KeyLock All KeyLock = unlocked Updateable NumVectors Number of memory vectors in the QA Device. Fixed M0 Set to zeros Updateable MO Set to zeros Updateable
M
2 1 Set to zeros Updateable P" Set to ones Updateable R Set to an initial random value Updateable Each key slot has the same Kbatch. If each key slot had a different Kbatch, and any one of the Kbatch 5 was compromised then the entire batch would be compromised till the Kbatch was replaced to another key. Hence, each key slot having a different Kbatch doesn't have any security advantages but requires more keys to be managed. 32.2 SETTING UP APPLICATION SPECIFIC DATA The section defines the sequences for configuring the data structures in the QA Device to 10 application specific data. 32.2.1 Replacing keys The QA Devices are programmed with production batch keys at final program load. The COMCO keys replace the production batch keys before the QA Devices are shipped to the ComCo. The ComCo replaces the COMCO keys to COMCOOEMwhen shipping QA Devices to its OEMs. 15 The OEM replaces the COMCOOEM to COMCOOEM app as the QA Devices are placed in ink cartridges or printers. The replacement occurs without the ComCo or the OEM knowing the actual value of the key. The actual value of the keys is only to known to QACo. The ComCo or the OEM is able to perform these replacements because the QACo provides them with a key programming QA Device with keys 20 appropriately set which can generate the necessary messages and signatures to replace the old key with the new key. Table 327 shows the command sequence for ReplaceKey. The GetProgramKey gets the new encrypted key from the key programming QA Device, and the encrypted new key is passed into the WO 2004/050369 PCT/AU2003/001616 937 QA Device whose key is being replaced through the ReplaceKey function. Depending on the OldKeyRef and NewKeyRef objects a common encrypted key or a variant encrypted key can be produced for the ReplaceKey function Table 327. ReplaceKey command sequence 5 Seq Function Command No 1 B.Random None RB = RL 2 A.GetProgramKe OldKeyRef = Key Num of the old key. This key must be changed to the y NewKeyRef in the QA Device whose key s being replaced. Chipid = Chip identifier of the QA Device whose key is being replaced. RE= RB KeyLock = Set depending on whether the new key is the final key for the key slot or it will be replaced further. NewKeyRef = Key Num of the new key. This key will change the OldKeyRef in the QA Device whose key is being replaced. If ResultFlag = Pass then RA = RL, Keylde 6 KeyldOfNewKey EncryptedNewKey = EncryptedKey, SIGA = SIGout Refer to Section 22.2.1. 3 B.ReplaceKey KeyNumToBeReplaced = Old key number, the old key could be a common key or a variant key, Keyld = Keyldnew, EncryptedKey= EncryptedNewKey, RE = RA, SIGE = SIGA ResultFlag = Pass/Fail 32.2.2 Setting up ReadOnly data This sets the permanent functional parameters of the application where the QA Device has been placed. These parameters remain unchanged for the lifetime of the QA Device. In case of the ink 10 cartridge such parameters are colour and viscosity of the ink. These values are written to M 2 . memory vectors using the WriteMl+ function, and its permissions are set to ReadOnly by SetPerm function. These values are typically set at the OEM. Table 328 shows the command sequence for setting up ReadOnly data. Table 328. ReadOnly data setup command sequence 15 Seq Function Command No 1 B. WriteMl+ VectNum = 2 or 3, WordSelect = the selected words to be written, MVal = words corresponding to word select starting from LSW WO 2004/050369 PCT/AU2003/001616 938 ResultFlag = PasslFail 2 B.SetPerm (VectNum =same as Seq No I parameter [VectNumJ, PermVal =same as Seq No 1 parameter [WordSelect]) If ResultFlag = Pass then CurrPerm = NewPerm Current permission value after applying PermVal In case of the SBR4320, the values written to M 2 .memory vectors is write-once only i.e they are set to ReadOnly as soon as they are written to once, therefore the command sequence consists only of Seq No 1 in Table 329. 5 32.2.3 Defining fields in Mo The QACo must determine the field definitions for MO depending on the application of the QA Device. These field definitions will consist of the following: * Number of fields and the size of each field. * The Type attribute of each field. 10 * The access permission for each field. Following fields have been presently defined in an ink QA Device: * ink-remaining field. See Section 26 for details. * Preauthorisation field. See Section 31.4.3 for details. * Sequence data fields SEQ_1 and SEQ_2. See Section 26 for details. 15 Following fields have been presently defined in a printer QA Device: * Operating parameter field.See Section 28 for details. * Sequence data fields SEQ-1 and SEQ_2. See Section 26 for details. After the field definitions are determined, they are formatted as per Section 8.1.1.4. These formatted values are then written to M1 using a WriteMl+ function. 20 Table 329. Defining MO fields command sequence Sequence Function Command No 1 B. WriteMl+ VectNum = 1, WordSelect = The selected words corresponding to the attribute field/fields of mo, MVal = words corresponding to word select starting from LSW) ResultFlag = Pass/Fail 32.2.4 Writing values to fields in Mo WO 2004/050369 PCT/AU2003/001616 939 The writing of Mo fields for an Ink QA Device will typically occur when the ink cartridge is filled with physical ink for the first time, and the equivalent logical ink is written to the Ink QA Device. Refer to Section 31.7 for details. The writing of Mo fields for a Printer QA Device will typically occur when the printer parameters are 5 written for the first time. The procedure for writing of a printer parameter for the first time or upgrading a printer parameters is exactly the same. Refer to Section 31.5 for details. Before any value is written to a field, the key slot containing the key which has authenticated ReadWrite access to the field must be locked. Both Ink QA Device and Printer QA Device has a sequence data fields SEQ_1 and SEQ_2 as 10 described in Section 27. These two fields must be initialised to OxFFFFFFFF, refer to Section 27 for details. The Ink QA Device/Printer QA Device and the trusted QA Device writing to it, share the sequence key or a variant sequence key between them i.e B.Kr 1 = A.Kn2or B.Kn 1 = FormKeyVariant(A.Kn 2 , B.Chipld), where B is the Ink QA Device/Printer QA Device and A is the trusted QA Device. The 15 command sequence used is described in Table 330. Table 330. Command sequence for writing sequence data fields to the QA Devices. Sequence Function Parameters No 1 B.Random B= RL 2 A.SignM KeyRef = n2, FieldSelect =Select bit correponding to SEQ_1 and SEQ-2 FieldVal = both fields set OxFFFFFFFF. Refer to Section 31.4.3.3 Chipld = Chipld of B, RE= RB If ResultFlag = Pass then RA= RL SIGA =SlGout Refer to Section 27.1.3.1 3 B. WriteFieldsAuth KeyRef = n1, FieldSelect = same as Seq 2[FieldSelect], FieldVal = same as Seq 2[FieldVal], RE= RA, SIGE = SIGA ResultFlag = Pass /Fail 32.3 SETTING UP THE UPGRADING QA DEVICE 20 The upgrading QA Device must be set up either as an Ink Refill QA Device or as a Parameter Upgrader QA Device. Each upgrading QA Device must go through the following set up: The upgrading QA Device must be set to factory defaults. Refer to Section 32.1. At the end of this process the upgrading QA Device is either an Ink Refill QA Device or a Parameter 25 Upgrader QA Device with production batch keys and MO fields set to deafult.
WO 2004/050369 PCT/AU2003/001616 940 The upgrading QA Device must be programmed with the appropriate keys and upgrade data before it can start upgrading other QA Devices. Following must be performed on each upgrade QA Device: a. The upgrading QA Device must be programmed with the appropriate keys required to upgrade 5 other QA Devices and to upgrade itself when necessary. b. The MO fields must be correctly defined and set in M1. For a Ink Refill QA Device the ink-remaining field must be defined and set. For a printer upgrade QA Device the upgrade value field and the count-remaining field must be defined and set. All upgrade QA Devices must also have a sequence datat fields SEQ_1 and SEQ_2 which are 10 used to upgrade the upgrading QA Device itself. c. Finally, MO fields defined in b must be written with appropriate values so that the upgrade QA Device can perform upgrades. An Ink Refill QA Device will typically store the logical ink equivalent to the physical ink in a refill station, hence the Ink Refill QA Device's ink-remaining field must be written with the equivalent 15 logical ink amount. For a Parameter Upgrader QA Device the upgrade value field and the count-remaining field must be written. The upgrade value depends on the type of upgrade the Parameter Upgrader QA Device can perform i.e one Parameter Upgrader QA Device can upgrade to 10 ppm (pages per minute) while another Parameter Upgrader QA Device can upgrade to 5ppm. The count 20 remaining is the number of times the Parameter Upgrader QA Device is permitted to write the associated upgrade value to other QA Devices. The count-remaining field must be written to a positive non-zero value for the Parameter Upgrader QA Device to perform successful upgrades. Refer to Section 32.3.1 and Section 32.3.2 for details. 32.3.1 Setting up the Ink Refill QA Device 25 32.3.1.1 Setting up the keys The Ink Refill QA DeviceQA Device could be transferring ink between peers or transferring ink down the heirachy, accordingly the peer to peer Ink Refill QA Device has two keys (fill/refill key and sequence key) as described in Section 27, and a Ink Refill QA Device transferring down the heirachy has three keys (fill/refill key, transfer key and sequence key). These keys must be 30 programmed into the Ink Refill QA Device using the sequence described in Section 32.2.1. The Key Programming QA Device must be programmed with the appropriate production batch keys , and the fill/refill, transfer key and sequence key The GetProgramKey function is called on the Key Programming QA Device with OldKeyRef (OldKeyRef - refer to Section 32.2.1) pointing to a production batch key, and the NewKeyRef 35 (NewKeyRef - refer to Section 32.2.1) pointing to either a fill/refill key or a transfer key or a sequence key. The outputs from the GetProgram Key (signature and encrypted New Key) is passed in to ReplaceKey function of the Ink Refill QA Device.
WO 2004/050369 PCT/AU2003/001616 941 The GetProgramKey function must be called (on the Key Programming QA Device) for replacing each of the production batch keys in the Ink Refill QA Device. The output of the GetProgramKey will be passed in to the ReplaceKey function called on the Ink Refill QA Device. The successful processing of the ReplaceKey function will replace an old key(production keys ) to a corresponding 5 new key ( either a fill/refill key or a transfer key or a sequence key). 32.3.1.2 Setting up the MO field information in m1 The ink-remaining field and the sequence data fields SEQ_1 and SEQ_2 must be defined and set in the Ink Refill QA Device using the sequence described in Section 32.2.3. 32.3.1.3 Transferring ink amounts 10 Finally, the logical ink amounts are transferred to the ink-remaining field using the sequence described in Section 31.7. The QACo will transfer to the ComCo Ink Refill QA Device at the top of the heirachy using the command sequence in Table 331. For a successful transfer from QACo to ComCo, ComCo and QACo must share a common key or a 15 variant key be i.e ComCo.Kn 1 = QACo.K, 2 or ComCo.Kn 1 = FormKeyVariant(QACo.Kn 2 ,ComCo.Chipid)Kn 1 is the fill/refill key for the ComCo refill QA Device.. Table 331. Command sequence for writing ink-remaining amounts to the highest QA Device in the heirachy. Sequence Function Parameters No 1 B.Random R= RL 2 .SignM KeyRef = n2, FieldSelect =Select bit correponding to the ink remaining field, FieldVal = Ink amount to be transferred, Refer to Section 31.4.3.3 Chipld = Chipid of B, RE= RB If ResultFlag = Pass then RA= RL SIGA =SlGout Refer to Section 27.1.3.1 3 B. WriteFieldsAuth KeyRef = n1, FieldSelect = same as Seq 2[FieldSelect], FieldVal = same as Seq 2[FieldVal], RE= RA, SIGE = SIGA ResultFlag = Pass /Fal 20 32.3.1.4 Setting up sequence data fields The Ink Refill QA Device has sequence data fields SEQ_1 and SEQ_2 (as described in Section 27) because its ink-remaining fields can be refilled as well. These two fields must be initialised to OxFFFFFFFF, refer to Section 27 for details.
WO 2004/050369 PCT/AU2003/001616 942 The Ink Refill QA Device and the trusted QA Device writing to it, share the sequence key or a variant sequence key between them i.e B.Kn 1 = A.Kn 2 or B.Ka 1 = FormKeyVariant(A.Kn 2 , B.Chipld), where B is the ink Refill QA Device and A is the trusted QA Device. The command sequence used is described in Table 331. 5 32.3.2 Setting up the Parameter Upgrader QA Device 32.3.2.1 Setting up the keys The Parameter Upgrader QA Device could be transferring upgrades between peers or transferring upgrades down the heirachy, accordingly the peer to peer Parameter Upgrader QA Device has three keys (write-parameter key, fill/refill key and sequence key) as described in Section 28.6 and 10 Section 26, and a Parameter Upgrader QA Device transferring down the heirachy has four keys (write-parameter key, fill/refill key, transfer key and sequence Key). These keys must be programmed into the Parameter Upgrader QA Device using the sequence described in Section 32.2.1. The Key Programming QA Device must be programmed with the appropriate production batch keys 15 , and write-parameter key, fill/refill key, transfer key and sequence key The GetProgramKey function is called on the Key Programming QA Device with OldKeyRef (OldKeyRef - refer to Section 32.2.1) pointing to a production batch key, and the NewKeyRef (NewKeyRef - refer to Section 32.2.1) pointing to either a write-parameter key, or a fill/refill key, or a transfer key, or a sequence key. The outputs from the GetProgramKey (signature and encrypted 20 New Key) is passed in to ReplaceKey function of the Parameter Upgrader QA Device. 32.3.2.2 Setting up the MO field in m1 The upgrade value field and the count-remaining field must be defined and set in the upgrade QA Device using the sequence described in Section 32.2.3. 32.3.2.3 Writing upgrade value to the upgrade field 25 The upgrade value is written to upgrade field using the write-parameter key. The upgrade QA Device and the trusted QA Device writing to it, share the write-parameter key or a variant write parameter key between them i.e B.K, 1 = A.Kn 2 or B.K, 1 = FormKeyVariant(A.Kn 2 , B.Chipld), where B is the upgrade QA Device and A is the trusted QA Device. The command sequence used is described in Table 331. 30 32.3.2.4 Transferring count-remaining amounts Finally, the logical count-remaining amounts are transferred to the count-remaining field using the sequence described in Section 31.7. The QACo will also transfer to the ComCo's upgrade QA Device using the command sequence in Table 331. 35 For a successful transfer from QACo to ComCo, ComCo and QACo must share a common key or a variant key be i.e ComCo.Kan = QACo.Kn 2 or ComCo.K, 1 = Form KeyVariant(QACo.Kn2 ,ComCo.Chipld). Kn 1 is the fill/refil key for the ComCo upgrade QA Device.
WO 2004/050369 PCT/AU2003/001616 943 32.3.2.5 Setting up sequence data fields The Parameter Upgrader QA Device has sequence data fields SEQ_1 and SEQ_2 (as described in Section 27) because its count-remaining fields can be refilled as well. These two fields must be initialised to OxFFFFFFFF, refer to Section 27 for details. 5 The Parameter Upgrader QA Device and the trusted QA Device writing to it, share the sequence key or a variant sequence key between them i.e B.Kel = A.K 2 or B.K = FormKeyVariant(A.Kn 2 , B.Chipld), where B is the Parameter Upgrader QA Device and A is the trusted QA Device. The command sequence used is described in Table 331. 32.4 SETTING UP THE KEY PROGRAMMER 10 The key programming QA Device is set up to replace keys in other QA Devices. Each key programming QA Device must go through the following set up: 0 The key programming QA Device must be instantiated to factory defaults. Refer to Section 32.1. At the end of instantiation the key programming QA Device has production batch keys and no key replacement data. 15 9 The key programming QA Device must be programmed with the appropriate keys and key replacement map before it can start to replace keys in other QA Devices. 32.4.1 Setting up the keys The key programming QA Device must be programmed with the key replacement map key. The key replacement map key is described in details in Section 24. 20 The key programming QA Device must programmed with the old and new keys for the QA Devices it is going to perform key replacement on. Each of the keys is set in the key programming QA Device using the sequence described in Section 32.2.1. 32.4.2 Setting up key replacement map field information 25 First the key replacement map field information is worked out as per Section 24.1. This field information is set in M1 as per the sequence described Section 32.2.3. 32.4.3 Setting up key replacement map Finally, the key replacement map field must be written with the valid mapping using the key replacement map key. The key programming QA Device and the trusted QA Device writing to it 30 must share the key replacement map key or a variant of the key replacement map key between them. For a successful write of the key replacement map B.Ke = A.Kn 2 or B.K 1 = FormKeyVariant(AKnz, B.Chipld), where B is the key replacement QA Device and A is the trusted QA Device. The command sequence used is described in Table 331. 35 Appendix A: Field Types WO 2004/050369 PCT/AU2003/001616 944 Table 332 lists the field types that are specifically required by the QA Chip Logical Interface and therefore apply across all applications. Additional field types are application specific, and are defined in the relevant application documentation. Table 332. Predefined Field Types 5 Value Type Description Ox0000 0 Non-initialised (default value after final program load) OxOO01 TYPEPREAUTH Defines a preauth field in an Ink QA Device Ox0002 TYPECOUNTREMAININ Defines a countRemaining field in an Parameter G Upgrader QA Device Ox0003 TYPESEQ_1 Defines a sequence data field SEQ_1 in an Ink QA Device or in a Printer QA Device or in an upgrader QA Device 0x0004 TYPESEQ_2 Defines a sequence data fields SEQ_2 in an Ink QA Device or in a Printer QA Device or in an upgrader QA Device Ox0005 TYPEKEYMAP Defines a key replacement map in a Key Programmer QA Device 0x0006 reserved reserved for future use and above Appendix B: Key and field definition for different QA Devices B.1 PARAMETER UPGRADER QA DEVICE B.1.1 Peer to peer QA Device 10 Table 333. Key definitions for a peer to peer Parameter Upgrader QA Device Key Purpose Name Fill/refill Key This key has is used for upgrading count-remaining values when the upgrade QA Device is upgraded by another upgrade QA Device and is also used to decrement the count-remaining when upgrading other QA Devices. Sequence Key This key is used to initialise sequence data fields SEQ_1 and SEQ_2 to OxFFFFFFF. Write Parameter This key is used to write the upgrade value to the Parameter Upgrader QA Key Device.
WO 2004/050369 PCT/AU2003/001616 945 Table 334. Field definitions for a peer to peer Parameter Upgrader QA Device Field Purpose Field Attrinutes Name Type KeyNum A a KPerms" EndPos RW W (Size) Count The field stores TYPECOUNT_REMAINI SNt fill/refill key 1 0 KPerms[K Depends Remaining the number of NG N*]= 1 on the times the Rest are 0 maximum Parameter number Upgrade QA of Device is upgrades permitted to that upgrade a printer can be QA Device. stored. Upgrade This stores the Must define the type of the SNwrite-parameter 1 0 KPerms[K Set as per Value value that is upgrade value key N*]=0 upgrade copied from the i.e TYPEPRINT_SPEEDd Rest are 0 value. Parameter as well Upgrade QA Device to the field being upgraded on the printer QA Device during the upgrade SEQi This field holds TYPESEQ_1 SN sequence key 1 0 KPerms[K Typically the data for N9]= 0 32 bit. sequence data KPerms[fill field SEQj refilll= I when the Rest are 0 Parameter as well. Upgrade QA Device is being upgraded by WO 2004/050369 PCT/AU2003/001616 946 another Parameter Upgrade Refill QA Device. SEQ_2 This field holds TYPE SEQ2 SN sequence key 1 0 KPerms[K Typically the data for N1= 0 32 bit. sequence data KPerms[fill fieldsSEQ_2 /refill] = 1 when the Rest are 0 Parameter as well. Upgrade QA Device is being upgraded by another Parameter Upgrade Refill QADevice. a. Authenticated ReadWrite permission b. Non-authenticated ReadWrite permission c. KeyPerms 5 d. This is a sample type only e. KeyNum f. Key Slot Number g.Fill/Refill key has authenticated decrement-only permission to the sequence data fields 10 B.1.2 Heirarchical Transfer QA Device Key definitions Table 335. Key definitions for a Parameter Upgrader QA Device (transferring down the heirachy) Key Purpose Name Transfer Key This key is used to decrement the count-remaining when upgrading other QA Devices. Fill/refill Key This key has is used for upgrading count-remaining values when the Parameter Upgrader QA Device is upgraded by another Parameter WO 2004/050369 PCT/AU2003/001616 947 Upgrader QA Device Refill QA Device. Sequence Key This key is used to initialise sequence data fields SEQ_1 and SEQ_2 to OxEFFEFFF. Write Parameter This key is used to write the upgrade value to the Parameter Upgrader QA Key Device. Field definitions Table 336. Field definitions for Parameter Upgrader QA Device transferring down the hierachy 5 Field Purpose Field Attrinutes Name Type KeyNum A a NAb KPerms" EndPo RW RW s(Size Count The field stores the TYPE COUNTREMAINI SN'fill/refill 1 0 KPerms[KN*] Depen Remaining number of times NG key = 0 ds on the Parameter KPerms[Trans the Upgrade QA fer Key]=1 maxi Device is permitted Rest are 0 mum to upgrade a printer numbe QA Device. r of upgra des that can be stored. Upgrade This stores the Must define the type of SN'write- 1 0 KeyPerms[K Set Value value that is the parameter N'] = 0 as copied from the upgrade value key Rest are 0 per Parameter i.e upgra Upgrader QA TYPEPRINTSPEEDd de Device to the value. field being upgraded on the printer QA WO 2004/050369 PCT/AU2003/001616 948 Device during the upgrade SEQI This field holds TYPESEQ_1 SN'sequence 1 0 KPerms[KNej Typic the data for key = 0 ally sequence data KPerms[fill/re 32 bit. fields SEQ_1 fill,] = 1 hen the Rest are 0 as Parameter well. Upgrader QA Device is being upgraded by another Parameter Upgrader Refill QA Device. SEQ_2 This field holds TYPESEQ_2 SN'sequence 1 0 KPerms[KN"] Typic the data for key = 0 ally sequence data KPerms[fill/re 32 bit. fields SEQ_2 fili 9 ] = 1 hen the Rest are 0 as Parameter well. Upgrader QA Device is being upgraded by another Parameter Upgrader Refill QA Device. a. Authenticated ReadWrite permission b. Non-authenticated ReadWrite permission c. KeyPerms 5 d. This is a sample type only e. KeyNum f. Key Slot Number g.Fill/Refill key has authenticated decrement-only permission to the sequence data fields 10 WO 2004/050369 PCT/AU2003/001616 949 B.2 INK REFILL QA DEViCE B.2.1 Peer to peer QA Device Key definitions Table 337. Key definitions for a peer to peer Ink Refill QA Device 5 Key Purpose Name Fill/refill Key This key has is used for filling/refilling ink-remaining values when the Ink Refill QA Device is upgraded by another Ink Refill QA Device and is also used to decrement from the ink-remaining when transferring ink to other QA Devices (typically Ink QA Device). Sequence Key This key is used to initialise sequence data fields SEQ_1 and SEQ_2 to OxFFFFFFF. Field definitions Table 338. Field definitions for a peer to peer Ink Refill QA Device 10 Field Purpose Field Attrinutes Name Type Key A a ePerms EndPos(Size) urn W Num RW r Ink The field stores the Must define the SN' fill/refill 1 1 KeyPerms[K Depends on Remainin amount of type of Ink key N] = 1 the g logical ink-remaining in e.g Rest are 0 maximum the TYPE_HIGHQUA amount ink refill QA Device. LITYBLACKIN of ink that Kd can be stored and the storage resolution i.e in pico litres or in micro litres. SEQ1 This field holds the data YPESEQ_ SN1 sequence 1 0 KPerms[KN" Typically 32 for key 1=0 it.
WO 2004/050369 PCT/AU2003/001616 950 sequence data field KPerns[fill/r SEQ_1 efill] = 1 when the Ink Refill QA Rest are 0 as Device well. is being filled/refilled by another Ink Refill QA Device. SEQ_2 This field holds the data TYESEQO2 SNI sequence 1 0 Kerms[Klf Typically 32 for key ]=0 bit. sequence data field KPerms[fill/r SEQ_2 efillg] 1 when the Ink Refill QA Rest are 0 as Device well. is being filled/refilled by another Ink Refill QA Device. a. Authenticated ReadWrite permission b. Non-authenticated ReadWrite permission c. Decrement-Only For Keys 5 d. This is a sample type only e. KeyNum f. Key Slot Number g.Fill/Refill key has authenticated decrement-only permission to the sequence data fields B.2.2 Heirarchical Transfer QA Device 10 Key definitions Table 339. Key definitions for a ink refill QA Device (transferring down the heirachy) Key Purpose Name Transfer Key This key is used to decrement from the ink-remaining when transferring ink to other QA Devices . Fill/refill Key This key has is used for filling/refilling ink-remaining values when the Ink Refill QA Device is upgraded by another Ink Refill QA Device. Sequence Key This key is used to initialise sequence data fields SEQ_-1 and SEQ_2 to OxFFFFFFF.
WO 2004/050369 PCT/AU2003/001616 951 Field definitions Table 340. Field definitions for a Ink Refill QA Device (transferring down the heirachy) Field Purpose Field Attrinutes Name Type KeyNum A a A' eyPem"s EndPos( RW W Size) nk The field stores the Must define the type SNffill/refill 1 0 KPerms[KN"]= 0 Depends emainin amount of Ink key KPerns[Transfer on the of logical ink- e.g- Key]=1 maximum remaining in the TYPEHIGHQUALI Rest are 0 m Ink Refill QA TY_BLACKINKd amount Device. of ink that can be stored and the storage resolution n i.e in Pico litres or in micro litres. SEQ_1 This field holds the TYPESEQ_1 SN sequence 1 0 KPerms[Kl] 0 Typicall data for key KPerms[fill/refill] y32 bit. sequence data field =1 SEQ_1 Rest are 0. when the Ink Refill QA Device is being filled/refilled by another Ink Refill QA WO 2004/050369 PCT/AU2003/001616 952 Device. SEQ_2 This field holds the TYPE.SEQ_2 SN sequence 1 0 EPerms[KN*]= 0 Typicall data for key KPerms[fill/refill] y 32 bit. sequence data field = 1 SEQ_2 Rest are 0. when the Ink Refill QA Device is being filled/refilled by another Ink Refill QA Device. a. Authenticated ReadWrite permission b. Non-authenticated ReadWrite permission c. KeyPerms 5 d. This is a sample type only e. KeyNum f. Key Slot Number g.Fill/Refill key has authenticated decrement-only permission to the sequence data fields B.3 KEY PROGRAMMING QA DEVICE 10 B.3.1 Key definitions Table 341. Key definitions for a Key Programming QA Device Key Purpose Name Key replacement map This key is used to write the key replacement map. Key Old Keys These are the old keys of the QA Device whose keys will be replaced by the Key Programming QA Device. New Keys These are the new keys of the QA Device whose old keys will be replaced by the Key Programming QA Device. B.3.2 Field definitions WO 2004/050369 PCT/AU2003/001616 953 Table 342. Field definitions for a key replacement QA Device Field Purpose Field Attrinutes Name Type KeyNum A* NAb KPerms* EndPo RW RW s (Size) Key This defines the TYPEKEYM Key Replacement 1 0 KPerms[KN" 2 replacement mapping AP Map key ] = 0 words map between the old Rest are 0 (64 key and the new bits) key for the QA Device whose old key will be replaced by the new key. a. Authenticated ReadWrite permission 5 b. Non-authenticated ReadWrite permission c. KeyPerms d. KeyNum B.4 INK QA DEVICE B.4.1 Key definitions 10 Table 343. Key definitions for a Ink QA Device Key Purpose Name Fill/refill Key This key is used for fiil/refilling ink-remaining amount in the ink QA Device. Ink usage Key This key is verifying the data read from the ink QA Device and for writing preauth data. Sequence Key This key is used to initialise sequence data fields SEQ_1 and SEQ_2 to OxFFFFFFF.
WO 2004/050369 PCT/AU2003/001616 954 B.4.2 Field definitions Table 344. Field definitions for a Ink QA Device Field Purpose Field Attrinutes Name Type Key A a NA ermsC EndPos Num RW W (Size) Ink The amount of logical Must define the type SN' 1 1 KPerms[K ] Depends Remaining ink-remaining in the of Ink fill/refill 1 on the ink QA Device. i.e key Rest are 0 maximum More than one ink- YPEHQBLACK amount remaining field may be _1NKd of ink that present depending on can be the number of physical stored inks stored in the ink and cartridge. the storage resolution i.e in pico litres or in micro litres. Preauth This field defines the TYPEPREAUTH SN ink 0 1 KPerms[KN']= Depends preauth value. usage key 0 on preauth Rest are 0 amount. Typically 32 bits, may be 64 bits to accomodat e larger preauth amounts. SEQ_1 This field holds the TYPESEQ_1 SN' 1 0 KPerms[KN] - Typically data for sequence 0 32 bit. sequence data field key KPerms[fill/refil WO 2004/050369 PCT/AU2003/001616 955 SEQ1 1 when the Ink QA Rest are 0. Device is being filled/refilled by a Ink Refill QA Device. SEQ2 This field holds the TYPESEQ_2 SN 1 0 KPerms[KN]= Typically data for sequence 0 32 bit. sequence data field key KPerms[fill/refil SEQ_2 18]= 1 when the Ink QA Rest are 0. Device is being filled/refilled by another Ink Refill QA Device. a. Authenticated ReadWrite permission b. Non-authenticated ReadWrite permission c. KeyPerms 5 d. This is a sample type only e. KeyNum f. Key Slot Number g.Fill/Refill key has authenticated decrement-only permission to the sequence data fields 10 B.5 PRINTER QA DEVICE B.5.1 Key definition Table 345. Key definitions for a Printer QA Device Key Purpose Name Upgrade key This key is used for writing / upgrading the functional parameter. (fill/refill key) Ink usage Key This key is verifying the data read from the Ink QA Device. Sequence Key This key is used to initialise sequence data fields SEQ_1 and SEQ_2 to OxFFFFFFF.
WO 2004/050369 PCT/AU2003/001616 956 PECID/SOPECID This key is used to verify the data read from the printer QA Device. This Key key is unique to each printer. Also used to translate data from the ink QA Device to the trusted printer system QA Device. B.5.2 Field definition Table 346. Field definitions for a Printer QA Device Field Purpose Field Attrinutes Name Type Key A a NA KPerms EndPo Num RW RW s (Size) Functional The field stores an Must define the type of SN' 1 0 KPerms[KN' Set as parameter upgradeable functional print speed fill/refill = 0 per parameter. i.e key Rest are 0 functio More than one TYPEPRINTSPEEDd nal functional parameter parame can be stored in the ter. printer QA Device. EQ1 This field holds the TYPESEQ_ SN 1 0 erms[KN' Typicall data for sequence ]= 0 y 32 sequence data field key KPerms[fill/r bit. SEQ_1 efill] = 1 when the Printer QA Rest are 0. Device is being filled/refilled by a Parameter Upgrade QA Device. SEQ 2 This field holds the TYPESEQ_2 SN 1 0 KPerms[KN' Typicall data for sequence ]=0 y 32 sequence data field key KPerns[fill/r bit. SEQ_2 efill] = 1 when the Printer QA Rest are 0. Device is being filled/refilled by another Parameter Upgrader WO 2004/050369 PCT/AU2003/001616 957 QA Device. a. Authenticated ReadWrite permission b. Non-authenticated ReadWrite permission c. KeyPerms 5 d. This is a sample type only e. KeyNum f. Key Slot Number g.Fill/Refill key has authenticated decrement-only permission to the sequence data fields 10 B.6 TRUSTED PRINTER SYSTEM QA DEVICE B.6.1 Key definition Table 347. Key Purpose Name PECID/SOPECID This key is used to verify the data read from Key the printer QA Device. This key is unique to each printer. This key is also used for verifying translated data from the ink QA Device. 15 WO 2004/050369 PCT/AU2003/001616 958 INTRODUCTION 1 Background This document describes a QA Chip that can be used to hold contains authentication keys together 5 with circuitry specially designed to prevent copying. The chip is manufactured using a standard Flash memory manufacturing process, and is low cost enough to be included in consumables such as ink and toner cartridges. The implementation is approximately 1mm 2 in a 0.25 micron flash process, and has an expected die manufacturing cost of approximately 10 cents in 2003. Once programmed, the QA Chips as described here are compliant with the NSA export guidelines 10 since they do not constitute a strong encryption device. They can therefore be practically manufactured in the USA (and exported) or anywhere else in the world. Note that although the QA Chip is designed for use in authentication systems, it is microcoded, and can therefore be programmed for a variety of applications. 2 Nomenclature 15 The following symbolic nomenclature is used throughout this document: Table 348. Summary of symbolic nomenclature Symbol Description F[X] Function F, taking a single parameter X F[X, Y] Function F, taking two parameters, X and Y X Y X concatenated with Y XAY Bitwise X AND Y Xv Y Bitwise X OR Y (inclusive-OR) X E Y Bitwise X XOR Y (exclusive-OR) ,X Bitwise NOT X (complement) X <- Y X is assigned the value Y X <- {Y, Z} The domain of assignment inputs to X is Y and Z X= Y X is equal to Y X Y X is not equal to Y 4X Decrement X by 1 (floor 0) {X Increment X by 1 (modulo register length) Erase X Erase Flash memory register X SetBits[X, Y] Set the bits of the Flash memory register X based on Y <-- ShiftRight[X,Shift register X right one bit position, taking input bit Y] from Y and placing the output bit in Z WO 2004/050369 PCT/AU2003/001616 959 3 PSEUDOCODE 3.1 Asynchronous The following pseudocode: var = expression 5 means the var signal or output is equal to the evaluation of the expression. 3.2 Synchronous The following pseudocode: var <- expression means the var register is assigned the result of evaluating the expression during 10 this cycle. 3.3 Expression Expressions are defined using the nomenclature in Table 348 above. Therefore: var = (a = b) is interpreted as the var signal is 1 if a is equal to b, and 0 otherwise. 15 4 DIAGRAMS Black lines are used to denote data, while red lines are used to denote 1-bit control-signal lines.
WO 2004/050369 PCT/AU2003/001616 960 LOGICAL INTERFACE 5 Introduction The QA Chip has a physical and a logical external interface. The physical interface defines how the QA Chip can be connected to a physical System, while the logical interface determines how that 5 System can communicate with the QA Chip. This section deals with the logical interface. 5.1 OPERATING MODES The QA Chip has four operating modes - Idle Mode, Program Mode, Trim Mode and Active Mode. * Active Mode is entered on power-on Reset when the fuse has been blown, and whenever a specific authentication command arrives from the System. Program code is only executed in 10 Active Mode. When the reset program code has finished, or the results of the command have been returned to the System, the chip enters Idle Mode to wait for the next instruction. S Idle Mode is used to allow the chip to wait for the next instruction from the System. * Trim Mode is used to determine the clock speed of the chip and to trim the frequency during the initial programming stage of the chip (when Flash memory is garbage). The clock 15 frequency must be trimmed via Trim Mode before Program Mode is used to store the program code. e Program Mode is used to load up the operating program code, and is required because the operating program code is stored in Flash memory instead of ROM (for security reasons). Apart from while the QA Chip is executing Reset program code, it is always possible to interrupt the 20 QA Chip and change from one mode to another. 5.1.1 Active Mode Active Mode is entered in any of the following three situations: * power-on Reset when the fuse has been blown * receiving a command consisting of a global id write byte (OxOO) followed by the ActiveMode 25 command byte (0x06) e receiving a command consisting of a local id byte write followed by some number of bytes representing opcode and data. In all cases, Active Mode causes execution of program code previously stored in the flash memory via Program Mode. 30 If Active Mode is entered by power-on Reset or the global id mechanism, the QA Chip executes specific reset startup code, typically setting up the local id and other 10 specific data. The reset startup code cannot be interrupted except by a power-down condition. The power-on reset startup mechanism cannot be used before the fuse has been blown since the QA Chip cannot tell whether the flash memory is valid or not. In this case the globalid mechanism must be used instead. 35 If Active Mode is entered by the local id mechanism, the QA Chip executes specific code depending on the following bytes, which function as opcode plus data. The interpretation of the following bytes depends on whatever software happens to be stored in the QA Chip.
WO 2004/050369 PCT/AU2003/001616 961 5.1.2 Idle Mode The QA Chip starts up in Idle Mode when the fuse has not yet been blown, and returns to Idle Mode after the completion of another mode. When the QA Chip is in Idle Mode, it waits for a command from the master by watching the low speed serial line for an id that matches either the global id 5 (0x00), or the chip's local id. * If the primary id matches the global id (0x0, common to all QA Chips), and the following byte from the master is the Trim Mode id byte, and the fuse has not yet been blown, the QA Chip enters Trim Mode and starts counting the number of internal clock cycles until the next byte is received. Trim Mode cannot be entered if the fuse has been blown. 10 If the primary id matches the global id (OxO, common to all QA Chips), and the following byte from the master is the Program Mode id byte, and the fuse has not yet been blown, the QA Chip enters Program Mode. Program Mode cannot be entered if the fuse has been blown. * If the primary id matches the global id (0x00, common to all QA Chips), and the following byte from the master is the Active Mode id bytes, the QA Chip enters Active Mode and 15 executes startup code, allowing the chip to set itself into a state to subsequently receive authentication commands (includes setting a local id and a trim value). * If the primary id matches the chip's local id, the QA Chip enters Active Mode, allowing the subsequent command to be executed. The valid 8-bit serial mode values sent after a global id are as shown in Table 349: 20 Table 349. Command byte values to place chip in specific mode value Interpretation 10101011 rim Mode (only functions when the fuse has not been blown) (OxAB) 10001101 Program Mode (only functions when the fuse has not been blown) (OxAD) 00000110 active Mode (resets the chip & loads the localld) (0x06) 5.1.3 Trim Mode Trim Mode is enabled by sending a global id byte (OxOO) followed by the Trim Mode command byte 25 (OxAB). Trim Mode can only be entered while the fuse has not yet been blown. The purpose of Trim Mode is to set the trim value (an internal register setting) of the internal ring oscillator so that Flash erasures and writes are of the correct duration. This is necessary due to the 2:1 variation of the clock speed due to process variations. If writes an erasures are too long, the Flash memory will wear out faster than desired, and in some cases can even be damaged. Note WO 2004/050369 PCT/AU2003/001616 962 that the 2:1 variation due to temperature still remains, so the effective operating speed of the chip is 7-14 MHz around a nominal 10MHz. Trim Mode works by measuring the number of system clock cycles that occur inside the chip from the receipt of the Trim Mode command byte until the receipt of a data byte. When the data byte is 5 received, the data byte is copied to the trim register and the current value of the count is transmitted to the outside world. Once the count has been transmitted, the QA Chip returns to /dle Mode. At reset, the internal trim register setting is set to a known value r. The external user can now perform the following operations: 10 e send the global id+write followed by the Trim Mode command byte e send the 8-bit value v over a specified time t * send a stop bit to signify no more data e send the global id+read followed by the Trim Mode command byte e receive the count c 15 e send a stop bit to signify no more data At the end of this procedure, the trim register will be v, and the external user will know the relationship between external time t and internal time c. Therefore a new value for v can be calculated. The Trim Mode procedure can be repeated a number of times, varying both t and v in known ways, 20 measuring the resultant c. At the end of the process, the final value for v is established (and stored in the trim register for subsequent use in Program Mode). This value v must also be written to the flash for later use (every time the chip is placed in Active Mode for the first time after power-up). For more information about the internal workings of Trim Mode and the accuracy of trim in the QA Chip, see Section 11.2 on page 994. 25 5.1.4 Program Mode Program Mode is enabled by sending a global id byte (OxOO) followed by the Program Mode command byte. If the QA Chip knows already that the fuse has been blown, it simply does not enter Program Mode. If the QA Chip does not know the state of the fuse, it determines whether or not the internal fuse 30 has been blown by reading 32-bit word 0 of the information block of flash memory. If the fuse has been blown the remainder of data from the Program Mode command is ignored, and the QA Chip returns to Idle Mode. If the fuse is still intact, the chip enters Program Mode and erases the entire contents of Flash memory. The QA Chip then validates the erasure. If the erasure was successful, the QA Chip 35 receives up to 4096 bytes of data corresponding to the new program code and variable data, The bytes are transferred in order byteo to byte 4 09 5 . Once all bytes of data have been loaded into Flash, the QA Chip returns to Idle Mode.
WO 2004/050369 PCT/AU2003/001616 963 Note that Trim Mode functionality must be performed before a chip enters Program Mode for the first time. Otherwise the erasure and write durations could be incorrect. Once the desired number of bytes have been downloaded in Program Mode, the LSS Master must wait for 80ps (the time taken to write two bytes to flash at nybble rates) before sending the new 5 transaction (e.g. Active Mode). Otherwise the last nybbles may not be written to flash. 5.1.5 After Manufacture Directly after manufacture the flash memory will be invalid and the fuse will not have been blown. Therefore power-on-reset will not cause Active Mode. Trim Mode must therefore be entered first, and only after a suitable trim value is found, should Program Mode be entered to store a program. 10 Active Mode can be entered if the program is known to be valid. LOGICAL VIEW OF CPU 6 Introduction The QA Chip is a 32-bit microprocessor with on-board RAM for scratch storage, on-board flash for program storage, a serial interface, and specific security enhancements. 15 The high level commands that a user of an QA Chip sees are all implemented as small programs written in the CPU instruction set. The following sections describe the memory model, the various registers, and the instruction set of the CPU. 7 Memory Model 20 The QA Chip has its own internal memory, broken into the following conceptual regions: " RAM variables (3Kbits = 96 entries at 32-bits wide), used for scratch storage (e.g. HMAC SHA1 processing). " Flash memory (8Kbytes main block + 128 bytes info block) used to hold the non-volatile authentication variables (including program keys etc), and program code. Only 4 KBytes + 64 25 bytes is visible to the program addressing space due to shadowing. Shadowing is where half of each byte is used to validate and verify the other half, thus protecting against certain forms of physical and logical attacks. As a result, two bytes are read to obtain a single byte of data (this happens transparently). 7.1 RAM 30 The RAM region consists of 96 x 32-bit words required for the general functioning of the QA Chip, but only during the operation of the chip. RAM is volatile memory: once power is removed, the values are lost. Note that in actual fact memory retains its value for some period of time after power down, but cannot be considered to be available upon power-up. This has issues for security that are addressed in other sections of this document. 35 RAM is typically used for temporary storage of variables during chip operation. Short programs can also be stored and executed from the RAM.
WO 2004/050369 PCT/AU2003/001616 964 RAM is addressed from 0 to 5F. Since RAM is in an unknown state upon a RESET (RstL), program code should not assume the contents to be 0. Program code can, however, set the RAM to be a particular known state during execution of the reset command (guaranteed to be received before any other commands). 5 7.2 FLASH VARIABLES The flash memory region contains the non-volatile information in the QA Chip. Flash memory retains its value after a RESET or if power is removed, and can be expected to be unchanged when the power is next turned on. Byte 0 of main memory is the first byte of the program run for the command dispatcher. Note that 10 the command dispatcher is always run with shadows enabled. Bytes 0-7 of the information block flash memory is reserved as follows: " byte 0-3 = fuse. A value of Ox5555AAAA indicates that the fuse has been blown (think of a physical fuse whose wire is no longer intact). * bytes 4-7 = random number used to XOR all data for RAM and flash memory accesses 15 After power-on reset (when the fuse is blown) or upon receipt of a globalld Active command, the 32 bit data from bytes 4-7 in the information block of Flash memory is loaded into an internal ChipMask register. In Active Mode (the chip is executing program code), all data read from the flash and RAM is XORed with the ChipMask register, and all data written to the flash and RAM is XORed with the ChipMask register before being written out. This XORing happens completely transparently to the 20 program code. Main flash memory byte 0 onward is the start of program code. Note that byte 0 onward needs to be valid after being XORed with the appropriate bytes of ChipMask. Even though CPU access is in 8-bit and 32-bit quantities, the data is actually stored in flash a nybble-at-a-time. Each nybble write is written as a byte containing 4 sets of b/-,b pairs. Thus every byte write to flash is writing a nybble to real and shadow. A write mask allows the individual 25 targetting of nybble-at-a-time writes. The checking of flash vs shadow flash is automatically carried out each read (each byte contains both flash and shadow flash). If all 8 bits are 1, the byte is considered to be in its erased form', and returns 0 as the nybble. Otherwise, the value returned for the nybble depends on the size of the overall access and the setting of bit 0 of the 8-bit WriteMask. 30 - All 8-bit accesses (i.e. instruction and program code fetches) are checked to ensure that each byte read from flash is 4 sets of b/-,b pairs. If the data is not of this form, the chip hangs until a new command is issued over the serial interface. 0 With 32-bit accesses (i.e. data used by program code), each byte read from flash is checked to ensure that it is 4 sets of b/,b pairs. A setting of WriteMasko = 0 means that if the data is 1 TSMC's flash memory has an erased state of all Is WO 2004/050369 PCT/AU2003/001616 965 not valid, then the chip will hang until a new command is issued over the serial interface. A setting of WriteMasko = 1 means that each invalid nybble is replaced by the upper nybble of the WriteMask. This allows recovery after a write or erasure is interrupted by a power-down. 8 Registers 5 A number of registers are defined for use by the CPU. They are used for control, temporary storage, arithmetic functions, counting and indexing, and for 1/O. These registers do not need to be kept in non-volatile (Flash) memory. They can be read or written without the need for an erase cycle (unlike Flash memory). Temporary storage registers that contain secret information still need to be protected from physical attack by Tamper Prevention and 10 Detection circuitry and parity checks. All registers are cleared to 0 on a RESET. However, program code should not assume any RAM contents have any particular state, and should set up register values appropriately. In particular, at the startup entry point, the various address registers need to be set up from unknown states. 8.1 GO 15 A 1-bit GO register is 1 when the program is executing, and 0 when it is not. Programs can clear the GO register to halt execution of program code once the command has finished executing. 8.2 ACCUMULATOR AND Z FLAG The Accumulator is a 32-bit general-purpose register that can be thought of as the single data register. It is used as one of the inputs to all arithmetic operations, and is the register used for 20 transferring information between memory registers. The Z register is a 1-bit flag, and is updated each time the Accumulator is written to. The Z register contains the zero-ness of the Accumulator. Z = 1 if the last value written to the Accumulator was 0, and 0 if the last value written was non-0. Both the Accumulator and Z registers are directly accessible from the instruction set. 25 8.3 ADDRESS REGISTERS 8.3.1 Program Counter Array and Stack Pointer A 12-level deep 12-bit Program Counter Array (PCA) is defined. It is indexed by a 4-bit Stack Pointer (SP). The current Program Counter (PC), containing the address of the currently executing instruction, is effectively PCA[SP]. A single register bit, PCRamSel determines whether the program is 30 executing from flash or RAM (0 = flash, 1 = RAM). The PC is affected by calling subroutines or returning from them, and by executing branching instructions, The SP is affected by calling subroutines or returning from them. There is no bounds checking on calling too many subroutines: the oldest entry in the execution stack will be lost. The entry point for program code is defined to be address 0 in Flash. This entry point is used 35 whenever the master signals a new transaction.
WO 2004/050369 PCT/AU2003/001616 966 8.3.2 AO-A3 There are 4 8-bit address registers Each register has an associated memory mode bit designating the address as in Flash (0) or RAM (1). When an An register is pointing to an address in RAM, it holds the word number. When it is pointing 5 to an address in Flash, it points to a set of 32-bit words that start at a 128-bit (16 byte) alignment. The AO register has a special use of direct offset e.g. access is possible to (AO),0-7 which is the 32 bit word pointed to by AO offset by the specified number of words. 8.3.3 WriteMask The WriteMask register is used to determine how many nybbles will be written during a 32-bit write 10 to Flash, and whether or not an invalid nybble will be replaced during a read from Flash. During writes to flash, bit n (of 8) determines whether nybble n is written. The unit of writing is a nybble since half of each byte is used for shadow data. A setting of OxFF means that all 32-bits will be written to flash (as 8 sets of nybble writes). During 32-bit reads from flash (occurs as 8 reads), the value of WriteMasko is used to determine 15 whether a read of invalid data is replaced by the upper nybble of WriteMask. If 0, a read of invalid data is not replaced, and the chip hangs until a new command is issued over the serial interface. If 1, a read of invalid data is replaced by the upper nybble of the WriteMask. Thus a WriteMask setting of 0 (reset setting) means that no writes will occur to flash, and all reads are not replaced (causing the program to hang if an invalid value is encountered). 20 8.4 COUNTERS A number of special purpose counters/index registers are defined: Table 350. Counter/lndex registers Name Register Bits Description Size C1 1 x 3 3 Counter used to index arrays and general purpose counter C2 1 x 6 6 General purpose counter and can be used to index arrays 25 All these counter registers are directly accessible from the instruction set. Special instructions exist to load them with specific values, and other instructions exist to decrement or increment them, or to branch depending on the whether or not the specific counter is zero. There are also 2 special flags (not registers) associated with C1 and C2, and these flags hold the zero-ness of C1 or C2. The flags are used for loop control, and are listed here, for although they are 30 not registers, they can be tested like registers.
WO 2004/050369 PCT/AU2003/001616 967 Table 351. Flags for testing C1 and C2 Name Description CIZ 1 = C1 is current zero, 0 = C1 is currently non-zero. C2Z 1 = C2 is current zero, 0 = C2 is currently non-zero. 8.5 RTMP 5 The single bit register RTMP allows the implementation of LFSRs and multiple precision shift registers. During a rotate right (ROR) instruction with operand of RB, the bit shifted out (formally bit 0) is written to the RTMP register. The bit currently in the RTMP register becomes the new bit 31 of the Accumulator. Performing multiple ROR RB commands over several 32-bit values implements a multiple 10 precision rotate/shift right. The XRB operand operates in the same way as RB, in that the current value in the RTMP register becomes the new bit 31 of the Accumulator. However with the XRB instruction, the bit formally known as bit 0 does not simply replace RTMP (as in the RB instruction). Instead, it is XORed with RTMP, and the result stored in RTMP, thereby allowing the implementation of long LFSRs. 15 8.6 REGISTERS USED FOR I/O Several registers are defined for communication between the master and the QA Chip. These registers are Localid, InByte and OutByte. Localld (7 bits) defines the chip-specific id that this particular QA Chip will accept commands for. InByte (8 bits) provides the means for the QA Chip to obtain the next byte from the master. OutByte (8 20 bits) provides the means for the QA Chip to send a byte of data to the master. From the QA Chip's point of view: e Reads from InByte will hang until there is 1 byte of data present from the master. * Writes to OutByte will hang if the master has not already consumed the last OutByte. When the master begins a new command transaction, any existing data in InByte and OutByte is lost, 25 and the PC is reset to the entry point in the code, thus ensuring correct framing of data. 8.7 REGISTERS USED FOR TRIMMING CLOCK SPEED A single 8-bit Trim register is used to trim the ring oscillaor clock speed. The register has a known value of OxOO during reset to ensure that reads from flash will succeed at the fastest process corners, and can be set in one of two ways: 30 e via Trim Mode, which is necessary before the QA Chip is programmed for the first time; or * via the CPU, which is necessary every time the QA Chip is powered up before any flash write or erasure accesses can be carried out.
WO 2004/050369 PCT/AU2003/001616 968 8.8 REGISTERS USED FOR TESTING FLASH There are a number of registers specifically for testing the flash implementation. A single 32-bit write to an appropriate RAM address allows the setting of any combination of these flash test registers. 5 RAM consists of 96 x 32-bit words, and can be pointed to by any of the standard An address registers. A write to a RAM address in the range 97-127 does nothing with the RAM (reads return 0), but a write to a RAM address in the range 0x80-0x87 will write to specific groupings of registers according to the low 3 bits of the RAM address. A 1 in the address bit means the appropriate part of the 32-bit Accumulator value will be written to the appropriate flash test registers. A 0 in the address 10 bit means the register bits will be unaffected. The registers and address bit groupings are listed in Table 352: Table 352. Flash test registers settable from CPU in RAM address range Ox80 0x87 2 adr data bits name description bitSuperscriptp aranumonly 0 0 shadowsOff 0 = shadowing applies (nybble based flash access) 1 = shadowing disabled, 8-bit direct accesses to flash. I hiFlashAdr Only valid when shadowsOff = I 0 = accesses are to lower 4Kbytes of flash I = accesses are to upper 4 Kbytes of flash 2 1 3 enableFlashTes 0 = keep flash test register within the TSMC t flash IP in its reset state 1 = enable flash test register to take on non reset values. 8-4 flashTest Internal 5-bit flash test register within the TSMC flash IP (SFC008_08B9_HE). 2 This is from the programmer's perspective. Addresses sent from the CPU are byte aligned, so the MRU needs to test bit n+2. Similarly, checking DRAM address > 128 means testing bit 7 of the address In the CPU, and bit 9 In the MRU. 3 unshadowed 4 shadowed WO 2004/050369 PCT/AU2003/001616 969 If this is written with OxI E, then subsequent writes will be according to the TSMC write test mode. You must write a non-OxI E value or reset the register to exit this mode. 2 28-9 flashTime When timerSel is 1, this value is used for the duration of the program cycle within a standard flash write or erasure. 1 unit = 16 clock cycles (16 x 100ns typical). Regardless of timerSel, this value is also used for the timeout following power down detection before the QA Chip resets itself. 1 unit = 1 clock cycle (= 1 Ons typical). Note that this means the programmer should set this to an appropriate value (e.g. 5 us), just as the localld needs to be set. 29 timerSel 0 = use internal (default) timings for flash writes & erasures I = use flashTime for flash writes and erasures When none of the address register bits 0-2 are set (e.g. a write to RAM address 0x80), then invalid writes will clear the illChip and retryCount registers. For example, set the AO register to be Ox80 in RAM. A write to (AO),O will write to none of the flash 5 test registers, but will clear the illChip and retryCount registers. A write to (AO),7 will write to all of the flash test registers. A write to (AO),2 will write to the enableFlashTest and flashTest registers only. A write to (AO),4 will write to the flashTime and timerSel registers etc. Finally, a write to address 0x88 in RAM will cause a device erasure. If infoBlockSel is 0, then the device erasure will only be of main memory. If infoBlockSel is 1, then the device erasure is of both 10 main memory and the information block (which will also clear the ChipMask and the Fuse). Reads of invalid RAM areas will reveal information as follows: e all invalid addresses in RAM (e.g. Ox80) will return the illChip flag in the low bit (illChip is set whenever 16 consecutive bad reads occur for a single byte in memory) * all invalid addresses in RAM with the low address bit set (e.g. 0x81., or (AO),1 when AO holds 15 0x80), will additionally return the most recent retryCount setting (only updated by the chip when a bad read occurs). i.e. bit 0 = illChip, bits 4-1 = retryCount. 8.9 REGISTER SUMMARY Table 353 provides a summary of the registers used in the CPU. Table 353. Register summary WO 2004/050369 PCT/AU2003/001616 970 Register name Description #bits A[0-3] address registers 49 =36 Acc Accumulator 32 C1 general purpose counter and index 3 C2 general purpose counter and index 6 IllChip gets set whenever more than 15 consecutive bad1 reads from flash occurred (and any program executing has hung) InByte input byte from outside world 8 Go determines whether CPU is executing 1 Localld determines id for this chip's 10 7 OutByte output byte to outside world 8 Z zero flag for last xfer to Acc 1 PCA program counter array 1212=144 PCRamSel Program code is executing in flash (0) or ram (1) 1 RetryCount counts the number of retries for bad reads 4 RTMP bit used to alow multi-word rotations 1 SP stack pointer into PCA 4 Trim trims ring oscillator frequency 8 flash test registers various registers in the embedded flash and flash 30 access logic specifically for testing the flash memory TOTAL (bits) 295 8,10 STARTUP Whenever the chip is powered up, or receives a 'write' command over the serial interface, the PC 5 and PCRamSel get set to 0 and execution begins at 0 in Flash memory. The program (starting at 0) needs to determine how the program was started by reading the InByte register. If the first byte read is OxFF, the chip is being requested to perform software reset tasks. Execution of software reset can only be interrupted by a power down. The reset tasks include setting up RAM to contain known startup state information, setting up Trim and locallD registers etc. The CPU signals 10 that it is now ready to receive commands from an external device by writing to the OutByte register. An external Master is able to read the OutByte (and any further outbytes that the CPU decides to send) if it so wishes by a read using the localld.
WO 2004/050369 PCT/AU2003/001616 971 Otherwise the first byte read will be of the form where the least significant bit is 0, and bits 7-1 contain the localld of the device as read over the serial interface. This byte is usually discarded since it nominally only has a value of differentiation against a software reset request. The second and subsequent bytes contain the data message of a write using the localld. The CPU can prevent 5 interruption during execution by writing 0 to the localld and then restoring the desired localld at the later stage. 9 Instruction Set The CPU operates on 8-bit instructions and typically on 32-bit data items. Each instruction typically consists of an opcode and operand, although the number of bits allocated to opcode and operand 10 varies between instructions. 9.1 BASIc OPCODES (SUMMARY) The opcodes are summarized in Table 354: Table 354. Opcode bit pattern map Opcode Mnemonic Simple Description OOOOxxxx JMP Jump oooixxxx JSR Jump subroutine ooloxxxx TBR Test and branch Ol1xxxx DBR Decrement and branch O ooxxxx SC Set counter to a value oloixxxx ST Store Accumulator in specified location 0110000x - reserved oilooolo JPZ Jumpto0 01100011 JPI Jump indirect ollooixx - reserved olioixxx - reserved 01110000 - reserved oiloo01 ERA Erase page of flash memory pointed to by Accumulator 01110010 JSZ ump to subroutine at at 0 01110011 JSI Jump subroutine indirect 01110100 RTS Return from subroutine 01110101 HALT Stop the CPU 0111011x - reserved Oillixxx LIA Load immediate value into address register 10O Oxxx AND Bitwise AND Accumulator WO 2004/050369 PCT/AU2003/001616 972 100 Olxxx OR Bitwise OR Accumulator lo olxxxx XOR Exclusive-OR Accumulator loloxxxx ADD Add a 32 bit value to the Accumulator lO11xxxx LD Load Accumulator 110 oxxxx ROR Rotate Accumulator right 11010xxx AND Bitwise AND Accumulators 11011xxx OR Bitwise OR Accumulatorsupecn ptaranumony 1110xxx XOR Bitwise XOR Accumulatorupemonpipamnunony 11101xxx ADD Add a 32 bit value to the Accumulatorsuperscrptparanumonly 1111oxxx LD Load Accumulatorupe*cnptpa*numoniy 11111xxx RIA Rotate Accumulator into address register Table 355 is a summary of valid operands for each opcode. The table is ordered alphabetically by opcode mnemonic. The binary value for each operand can be found in the subsequent sections. Table 355. Valid operands for opcodes 5 Opcode Valid operands ADD immediate value (AO), offset (An), (Cl,C2} (where n = 0-3] AND immediate value (AO), offset DBR {C1, C2}, offset ERA HALT JMP address JPl JPZ JSI JSR address Jsz LIA {Flash,Ram}, An [where n = 0-3], {immediate value) LD immediate value immediate form of instruction WO 2004/050369 PCT/AU2003/001616 973 (AO), offset (An), {C1 ,C2} [where n = 0-3] OR immediate value (AO), offset RIA {Flash, Ram), An [where n = 0-3] ROR {InByte, OutByte, WriteMask, ID, C1, C2, RB, XRB, 1,3,8,24,31} RTS SC {C1, C2}, {immediate value} ST (AO), offset (An), {CI,C2} [where n = 0-3] TBR {0, 1}, offset XOR immediate value (AO), offset (An), {C1,C2} [where n = 0-3] Additional pseduo-opcodes (for programming convenience) are as follows: * DEC=ADD OxFF.. " INC= ADD 0x01 5 * NOT=XOR OxFF.. " LDZ=LDO " SC {C1, C2}, Acc = ROR {C1, C2} " RD ROR Inbyte * WR =ROR OutByte 10 * LDMASK = ROR WriteMask * LDID = ROR Id * NOP=XORO 9.2 ADDRESSING MODES The CPU supports a set of addressing modes as follows: 15 e immediate " accumulator indirect * indirect fixed " indirect indexed 9.2.1 Immediate 20 In this form of addressing, the operand itself supplies the 32-bit data.
WO 2004/050369 PCT/AU2003/001616 974 Immediate addressing relies on 3 bits of operand, plus an optional 8 bits at PC+1 to determine an 8 bit base value. Bits 0 to 1 of the opcode byte determine whether the base value comes from the opcode byte itself, or from PC+1, as shown in Table 356. Table 356. Selection for base value in immediate mode 5 Opcode 1 - Base value 00 00000000 01 00000001 10 From PC+1 (i.e. MlUData 7 .) 11 11111111 The base value is computed by using CMDo as bit 0, and copying CMD1 into the upper 7 bits. The resultant 8 bit base value is then used as a 32-bit value, with Os in the upper 24 bits, or the 8-bit value is replicated into the upper 32 bits. The selection is determined by bit 2 of the opcode byte, as 10 follows: Table 357. Replicate bits selection Opcode 2 Data o No replication. Data has 0 in upper 24 bits and baseVal in lower 8 bits 1 Replicated. Data is 32-bit value formed by replicating baseVal. Opcodes that support immediate addressing are LD, ADD, XOR, AND, OR. The SC and LIA 15 instructions are also immediate in that they store the data with the opcode, but they are not in the same form as that described here. See the detail on the individual instructions for more information. Single byte examples include: * LD 0 * ADD 1 20 e ADD OxFF... # this subtracts 1 from the acc * XOR OxFF... # this performs an effective logical NOT operation Double byte examples include: * LD 0x05 # a constant * AND OxOF # isolates the lower nybble 25 * LD 0x36... # useful for HMAC processing 9.2.2 Accumulator indirect In this form of addressing, the Accumulator holds the effective address.
WO 2004/050369 PCT/AU2003/001616 975 Opcodes that support Accumulator indirect addressing are JPI, JSi and ERA. In the case of JPI and JSI, the Accumulator holds the address to jump to. In the case of ERA, the Accumulator holds the address of the page in flash memory to be erased. Examples include: 5 e JPI e JSI * ERA 9.2.3 Indirect fixed In this form of addressing, address register AC is used as a base address, and then a specific fixed 10 offset is added to the base address to give the effective address. Bits 2-0 of the opcode byte specify the fixed offset from AO, which means the fixed offset has a range of 0 to 7. Opcodes that support indirect indexed addressing are LD, ST, ADD, XOR, AND, OR. Examples include: 15 9 LD (AO), 2 * ADD (AO), 3 " AND (AO), 4 " ST (AO), 7 9.2.4 Indirect indexed 20 In this form of addressing, an address register is used as a base address, and then an index register is used to offset from that base address to give the effective address. The address register is one of 4, and is selected via bits 2-1 of the opcode byte as follows: Table 358. Address register selection Opcode 2
-
1 address register selected 00 AO 01 Al 10 A2 11 A3 25 Bit 0 of the opcode byte selects whether index register C1 or C2 is used: WO 2004/050369 PCT/AU2003/001616 976 The counter is selected as follows: Table 359. Interpretation of counter for DBR Opcodeo interpretion o C1 I C2 5 Opcodes that support indirect indexed addressing are LD, ST, ADD, XOR. Examples include: " LD (A2), C1 " ADD (A1), C1 * ST (A3), C2 10 Since C1 and C2 can only decement, processing of data structures typically works by loading Cn with some number n and decrementing to 0. Thus (Ax),n is the first word accessed, and (Ax),O is the last 32-bit word accessed in the loop. 9.3 ADD - ADD To AccuMULATOR Mnemonic: ADD 15 Opcode: ioioxxxx, and iiolixxx Usage: ADD effective-address, or ADD immediate-value The ADD instruction adds the specified 32-bit value to the Accumulator via modulo 232 addition. The illoixxx form of the opcode follows the immediate addressing rules (see Section 9.2.1 on page 973). The loioxxxx form of the opcode defines an effective address as follows: 20 Table 360: Interpretation of operand for ADD (1OlOxxxx) bit 3 interpretion comment o (AO), offset indirect fixed addressing (see Section 9.2.3 on page 975) 1 (An), Cn indirect indexed addressing (see Section 9.2.4 on page 975) The Z flag is also set during this operation, depending on whether the result (loaded into the Accumulator) is zero or not. 25 9.4 AND - BITWISE AND Mnemonic: AND Opcode: looooxxx, and lioloxxx Usage: AND effective-address, or AND immediate-value The AND instruction performs a 32-bit bitwise AND operation on the Accumulator.
WO 2004/050369 PCT/AU2003/001616 977 The lilooxxx form of the opcode follows the immediate addressing rules (see Section 9.2.1 on page 973). The 0ooooxxx form of the opcode follows the indirect fixed addressing rules (see Section 9.2.3 on page 975). The Z flag is also set during this operation, depending on whether the resultant 32-bit value (loaded 5 into the Accumulator) is zero or not. 9.5 DBR - DECREMENT AND BRANCH Mnemonic: DBR Opcode: oolixxxx Usage: DBR Counter, Offset 10 This instruction provides the mechanism for building simple loops. The counter is selected from bit 0 of the opcode byte as follows: Table 361. Interpretation of counter for DBR bit 0 interpretion 0 C1 I C2 15 If the specified counter is non-zero, then the counter is decremented and the designated offset is added to the current instruction address (PC for 1-byte instructions, PC+1 for 2-byte instructions). If the specified counter is zero, it is decremented (all bits in the counter become set) and processing continues at the next instruction (PC+1 or PC+2). The designated offset will typically be negative for use in loops. 20 The instruction is either 1 or two bytes, as determined by bits 3-1 of the opcode byte: * If bits 3-1 = 000, the instruction consumes 2 bytes. The 8 bits at PC+1 are treated as a signed number and used as the offset amount. Thus OxFF is treated as -1, and 0x01 is treated as +1. * If bits 3-1 # 000, the instruction consumes 1 byte. Bits 3-1 are treated as a negative number (the sign bit is implied) and used as the offset amount. Thus 111 is treated as -1, and 001 is 25 treated as -7. This is useful for small loops. The effect is that if the branch is back 1-7 bytes (1 byte is not particularly useful), then the single byte form of the instruction can be used. If the branch is forward, or backward more than 7 bytes, then the 2-byte instruction is required. 9.6 ERA - ERASE 30 Mnemonic: ERA Opcode: 01110001 Usage: ERA This instruction causes an erasure of the 256-byte page of flash memory pointed to by the Accumulator. The Accumulator is assumed to contain an 8-bit pointer to a 128-bit (16 byte) aligned WO 2004/050369 PCT/AU2003/001616 978 structure (same structure as the address registers). The page number to be erased comes from bits 7-4, and the lower 4 bits are ignored. Note that the size of the flash memory page being erased is actually 512 bytes, but in terms of data storage and addressing from the point of view of the CPU, there is only 256 bytes in the page. 5 9.7 HALT - HALT CPU OPERATION Mnemonic: HALT Opcode: 01110101 Usage: HALT The HALT instruction writes a 0 to the internal GO register, thereby causing the CPU to terminate the 10 currently executing program. The CPU will only be restarted with a new locaild transaction from the Master or by a globalId plus Active Mode byte. 9.8 JMP - JUMP Mnemonic: JMP Opcode: OOOOxxxx 15 Usage: JMP effective-address The JMP instruction provides for a method of branching to a specified address. The instruction loads the PC with the effective address. The new PC is loaded as follows: bits 11-8 are obtained from bits 3-0 of the JMP opcode byte, and bits 7-0 are obtained from PC+1. 20 9.9 JPI - JUMP INDIRECT Mnemonic: JPI Opcode: 01100011 Usage: JPI The JPI instruction loads the PC with the lower 12 bits of the Accumulator, and sets the PCRamSel 25 register with bit 15 of the Accumulator. Note that the stack is unaffected (unlike JSI). 9.10 JPZ - JUMP TO ZERO Mnemonic: JPZ Opcode: 01100010 Usage: JPZ 30 The JPZ instruction loads the PC and PCRamSel with 0, thereby causing a jump to address 0 in Flash memory. Programmers will not typically use the JPZ command. However the CPU executes this instruction whenever a new command arrives over the serial interface, so that the code entry point is known i.e. every time the chip receives a new command, execution begins at address 0 in flash. This does 35 not change the status of any other internal register settings (e.g. the flash test registers). 9.11 JSI - JUMP SUBROUTINE INDIRECT Mnemonic: JSI WO 2004/050369 PCT/AU2003/001616 979 Opcode: 01110011 Usage: JSI The JSI instruction allows the jumping to a subroutine whose address is obtained from the Accumulator. The instruction pushes the current PC onto the stack, loads the PC with the lower 12 bits 5 of the Accumulator, and sets the PCRamSel register with bit 15 of the Accumulator. The stack provides for 12 levels of execution (11 subroutines deep). It is the responsibility of the programmer to ensure that this depth is not exceeded or the deepest return value will be overwritten (since the stack wraps). Programs can take advantage of the fact that the stack wraps. 9.12 JSR - JUMP SUBROUTINE 10 Mnemonic: JSR Opcode: O o Oixxxx Usage: JSR effective-address The JSR instruction provides for the most common usage of the subroutine construct. The instruction pushes the current PC onto the stack, and loads the PC with the effective address. 15 The new PC is loaded as follows: bits 11-8 are obtained from bits 3-0 of the JSR opcode byte, and bits 7-0 are obtained from PC+1. The stack provides for 12 levels of execution (11 subroutines deep). It is the responsibility of the programmer to ensure that this depth is not exceeded or the return value will be overwritten (since the stack wraps). Programs can take advantage of the fact that the stack wraps. 20 9.13 JSZ - JUMP TO SUBROUTINE AT ZERO Mnemonic: JSZ Opcode: 01110010 Usage: JSZ The JSZ instruction jumps to the subroutine at flash address 0 (i.e. it pushes the current PC onto the 25 stack, and loads the PC and PCRamSeI with 0). Programmers will not typically use the JSZ command. It exists merely as a result of opcode decoding minimization and can be used to assist with the testing of the chip. 9.14 LD - LOAD ACCUMULATOR Mnemonic: LD 30 Opcode: lixxxx, and illioxxx Usage: LD effective-address, or LD immediate-value The LD instruction loads the Accumulator with the 32-bit value. The 1111oxxx form of the opcode follows the immediate addressing rules (see Section 9.2.1 on page 973). The iolixxxx form of the opcode defines an effective address as follows: 35 WO 2004/050369 PCT/AU2003/001616 980 Table 362. Interpretation of operand for LD (1011 xxxx) bit 3 interpretion comment 0 (AO), offset indirect fixed addressing (see Section 9.2.3 on page 975) 1 (An), Cn indirect indexed addressing (see Section 9.2.4 on page 975) The Z flag is also set during this operation, depending on whether the value loaded into the 5 Accumulator is zero or not. 9.15 LIA - LOAD IMMEDIATE ADDRESS Mnemonic: LIA Opcode: ollilxxx Usage: LIAF AddressRegister, Value # for flash addresses 10 LIAR AddressRegister, Value # for ram addresses The LIA instruction transfers the data from PC+1 into the designated address register (AO-A3), and sets the memory mode bit for that address register. Bit 0 specifies whether the address is in flash or ram, as follows: Table 363. Interpretation of memory mode for LIA 15 bit 0 interpretion o Flash I Ram The address register to be targetted is selected via bits 2-1 of the instruction. 9.16 OR - BrrWIsE OR Mnemonic: OR 20 Opcode: 0001xxx, and liolxxx Usage: OR effective-address, or OR immediate-value The OR instruction performs a 32-bit bitwise OR operation on the Accumulator. The lolo1xxx form of the opcode follows the immediate addressing rules (see Section 9.2.1 on page 973). The loooixxx form of the opcode follows the indirect fixed addressing rules (see 25 Section 9.2.3 on page 975). The Z flag is also set during this operation, depending on whether the resultant 32-bit value (loaded into the Accumulator) is zero or not.
WO 2004/050369 PCT/AU2003/001616 981 9.17 RIA - ROTATE IN ADDRESS Mnemonic: RIA Opcode: llixxx Usage: RIAF AddressRegister # for flash addresses 5 RIAR AddressRegister # for ram addresses The RIA instruction transfers the lower 8 bits of the Accumulator into the designated address register (AO-A3), sets the memory mode bit for that address register, and rotates the Accumulator right by 8 bits. Bit 0 specifies whether the address is in flash or ram, as follows: 10 Table 364. Interpretation of memory mode for RIA bit 0 interpretion o Flash' i Ram The address register to be targetted is selected via bits 2-1 of the instruction. 9.18 ROR - ROTATE RIGHT 15 Mnemonic: ROR Opcode: 110 0xxxx Usage: ROR Value The ROR instruction provides a way of rotating the Accumulator right a set number of bits. The bit(s) coming in at the top of the Accumulator (to become bit 31) can either come from the previous lower 20 bits of the Accumulator, from the serial connection, or from external flags. The bit(s) rotated out can also be output from the serial connection, or combined with an external flag. The allowed operands are as follows: Table 365. Interpretation of operand for ROR bits 3-0 interpretion 0000 RB 0001 XRB 0010 WriteMask 0011 1 l00 - (reserved) 0101 3 0110 31 0111 24 WO 2004/050369 PCT/AU2003/001616 982 1000 C1 1001 C2 1010 - (reserved) 1011 -(reserved) 1100 8 1101 ID 1110 InByte 1111 OutByte The Z flag is also set during this operation, depending on whether resultant 32-bit value (loaded into the Accumulator) is zero or not. In its simplest form, the operand for the ROR instruction is one of 1, 3, 8, 24, 31, indicating how many 5 bit positions the Accumulator should be rotated. For these operands, there is no external input or output - the bits of the Accumulator are merely rotated right. Note that these values are the equivalent to rotating left 31, 29, 24, 8, 1 bit positions. With operand WriteMask, the lower 8 bits of the Accumulator are transferred to the WriteMask register, and the Accumulator is rotated right by 1 bit. This conveniently allows successive nybbles to be 10 masked during Flash writes if the Accumulator has been preloaded with an appropriate value (eg Ox01). With operands C1 and C2, the lower appropriate number of bits of the Accumulator (3 for C1, 6 for C2) are transferred to the C1 or C2 register and the lower 6 bits of the Accumulator are loaded with the previous value of the Cn register. The remaining upper bits of the Accumulator are set as follows: bit 15 31-24 are copied from previous bits 7-0, and bits 23-6 are copied from previous bits 31-14 (effectively junk). As a result, the Accumulator should be subsequently masked if the programmer wants to compare for specific values). With operand ID, the 7 low-order bits are transferred from the Accumulator to the Localld register, the low-order 8 bits of the Accumulator are copied to the Trim register if the Trim register has not already 20 been written to after power-on reset, and the Accumulator is rotated right by 8 bits. This means that the ROR ID instruction needs to be performed twice, typically during Global Active Mode - once to set Trim, and once to set Localld. Note there is no way to read the contents of the localld or Trim registers directly. However the Localld sent to the program for a command is available as bits 7-1 of the first byte obtained from InByte after program startup. 25 With operand InByte, the next serial input byte is transferred to the highest 8 bits of the Accumulator. The InByteValid bit is also cleared. If there is no input byte available from the client yet, execution is suspended until there is one. The remainder of the Accumulator is shifted right 8 bit positions (bit3l becomes bit 23 etc.), with lowest bits of the Accumulator shifted out.
WO 2004/050369 PCT/AU2003/001616 983 With operand OutByte, the Accumulator is shifted right 8 bit positions. The byte shifted out from bits 7-0 is stored in the OutByte register and the OutByteValid flag is set. It is therefore ready for a client to read. If the OutByteValid flag is already set, execution of the instruction stalls until the OutByteValid flag cleared (when the OutByte byte has been read by the client). The new data shifted in to the upper 8 5 bits of the Accumulator is what was transferred to the OutByte register (i.e. from the Accumulator). Finally, the RB and XRB operands allow the implementation of LFSRs and multiple precision shift registers. With RB, the bit shifted out (formally bit 0) is written to the RTMP register. The register currently in the RTMP register becomes the new bit 31 of the Accumulator. Performing multiple ROR RB commands over several 32-bit values implements a multiple precision rotate/shift right. The XRB 10 operates in the same way as RB, in that the current value in the RTMP register becomes the new bit 31 of the Accumulator. However with the XRB instruction, the bit formally known as bit 0 does not simply replace RTMP (as in the RB instruction). Instead, it is XORed with RTMP, and the result stored in RTMP. This allows the implementation of long LFSRs, as required by the authentication protocol. 9.19 RTS - RETURN FROM SUBROUTINE 15 Mnemonic: RTS Opcode: 01110100 Usage: RTS The RTS instruction pulls the saved PC from the stack, adds 1, and resumes execution at the resultant address. The effect is to cause execution to resume at the instruction after the most 20 recently executed JSR or JSI instruction. Although 12 levels of execution are provided for (11 subroutines), it is the responsibility of the programmer to balance each JSR and JSI instruction with an RTS. A RTS executed with no previous JSR will cause execution to begin at whatever address happens to be pulled from the stack. Of course this may be desired behaviour in specific circumstances. 25 9.20 SC - SET COUNTER Mnemonic: SC Opcode: olooxxxx Usage: SC Counter Value The SC instruction is used to transfer a 3-bit Value into the specified counter. The operand 30 determines which of counters C1 and C2 is to be loaded as well as the value to be loaded. Value is stored in bits 3-1 of the 8-bit opcode, and the counter is specified by bit 0 as follows: Table 366. Interpretation of counter for SC bit 0 interpretion D C1 I C2 WO 2004/050369 PCT/AU2003/001616 984 Since counter C1 is 3 bits, Value is copied directly into C1. For counter C2, C22.o are copied to C25-3, and Value is copied to C2 2 .o. Two SC C2 instructions are therefore required to load C2 with a given 6-bit value. For example, to load C2 with OxOC, we would have SC C2 1 followed by SC C2 4. 5 9.21 ST - STORE ACCUMULATOR Mnemonic: ST Opcode: 0101xxxx Usage: ST effective-address The ST instruction stores the 32-bit Accumulator at the effective address. The effective address is 10 determined as follows: Table 367. Interpretation of operand for ST (0101xxxx) bit 3 interpretion comment o (AO), offset indirect fixed addressing (see Section 9.2.3 on page 975) 1 (An), Cn indirect indexed addressing (see Section 9.2.4 on page 975) If the effective address in Flash memory, only those nybbles whose corresponding WriteMask bit is 15 set will be written to Flash. Programmers should be very aware of flash characteristics (write time, longevity, page size etc. when storing data in flash). There is always the possibility that power could be removed during a write to Flash. If this occurs, the flash will be in an indeterminate state. If the QA Chip is warned by the external system that power is about to be removed (via the master causing a transition to Idle Mode), the write will be 20 aborted cleanly at the nearest nybble boundary (writes occur in the order of least significant to most significant). 9.22 TBR - TEST AND BRANCH Mnemonic: TBR Opcode: OOloxxxx 25 Usage: TBR Value Offset The Test and Branch instruction tests the status of the Z flag (the zero-ness of the Accumulator), and then branches if a match ocurs. The zero-ness is selected from bit 0 of the opcode byte as follows: WO 2004/050369 PCT/AU2003/001616 985 Table 368. Interpretation of zero-ness for TBR bit 0 interpretion o true if Acc is zero (Z = 1) 1 true if Acc is non-zero (Z=0) If the specified zero-test matches, then the designated offset is added to the current instruction 5 address (PC for 1-byte instructions, PC+1 for 2-byte instructions). If the zero-test does not match, processing continues at the next instruction (PC+1 or PC+2). The instruction is either 1 or two bytes, as determined by bits 3-1 of the opcode byte: * If bits 3-1 = 000, the instruction consumes 2 bytes. The 8 bits at PC+1 are treated as a signed number and used as the offset amount to be added to PC+1. Thus OxFF is treated as -1, and 10 0x01 is treated as +1. * If bits 3-1 # 000, the instruction consumes 1 byte. Bits 3-1 are treated as a positive number (the sign bit is implied) and used as the offset amount to be added to PC. Thus 111 is treated as 7, and 001 is treated as 1. This is useful for skipping over a small number of instructions. The effect is that if the branch is forward 1-7 bytes (1 byte is not particularly useful), then the single 15 byte form of the instruction can be used. If the branch is backward, or forward more than 7 bytes, then the 2-byte instruction is required. 9.23 XOR - BITWISE EXCLUSIVE OR Mnemonic: XOR Opcode: looixxxx, and 11100xxx 20 Usage: XOR effective-address, or XOR immediate-value The XOR instruction performs a 32-bit bitwise XOR operation on the Accumulator. The 1110 oxxx form of the opcode follows the immediate addressing rules (see Section 9.2.1 on page 973). The 1oolxxxx form of the opcode has an effective address as follows: Table 369. Interpretation of operand for XOR (1001 xxxx) 25 bit 3 interpretion comment o (AO), offset indirect fixed addressing (see Section 9.2.3 on page 975) 1 (An), Cn indirect indexed addressing (see Section 9.2.4 on page 975) The Z flag is also set during this operation, depending on whether the result (loaded into the Accumulator) is zero or not.
WO 2004/050369 PCT/AU2003/001616 986 IMPLEMENTATION 10 Introduction This chapter provides the high-level definition of a CPU capable of implementing the functionality 5 required of an QA Chip. 10.1 PHYSICAL INTERFACE 10.1.1 Pin connections The pin connections are described in Table 370. Table 370. Pin connections to QA Chip 10 pin direction description Vdd In Nominal voltage. If the voltage deviates from this by more than a fixed amount, the chip will RESET. GND In SClk In Serial clock SDa In/Out Serial data The system operating clock SysClk is different to SCk. SysClk is derived from an internal ring oscillator based on the process technology. In the FPGA implementation SysClk is obtained via a 5th pin. 10.1.2 Size and cost 15 The QA Chip uses a 0.25 pm CMOS Flash process for an area of 1mm 2 yielding a 10 cent manufacturing cost in 2002. A breakdown of area is listed in Table 371. Table 371. Breakdown of Area for QA Chip approximate area description (mm 2 ) 0.49 8KByte flash memory TSMC: SFC0008_08B9_HE (8K x 8-bits, erase page size = 512 bytes) Area = 724.688ptm x 682.05 Im. 0.08 3072 bits of static RAM 0.38 General logic 0.05 Analog circuitry 1 TOTAL (approximate) 20 Note that there is no specific test circuitry (scan chains or BIST) within the QA Chip (see Section 10.3.10 on page 992), so the total transistor count is as shown in Table 371.
WO 2004/050369 PCT/AU2003/001616 987 10.1.3 Reset The chip performs a RESET upon power-up. In addition, tamper detection and prevention circuitry in the chip will cause the chip to either RESET or erase Flash memory (depending on the attack detected) if an attack is detected. 5 10.2 OPERATING SPEED The base operating system clock SysClk is generated internally from a ring oscillator (process dependant). Since the frequency varies with operating temperature and voltage, the clock is passed through a temperature-based clock filter before use (see Section 10.3.3 on page 988). The frequency is built into the chip during manufacture, and cannot be changed. The frequency is in the 10 range 7-14 MHz. 10.3 GENERAL MANUFACTURING COMMENTS Manufacturing comments are not normally made when normally describing the architecture of a chip. However, in the case of the QA Chip, the physical implementation of the chip is very much tied to the security of the key. Consequently a number of specialized circuits and components are 15 necessary for implementation of the QA Chip. They are listed here. * Flash process * Internal randomized clock * Temperature based clock filter = Noise generator 20 * Tamper Prevention and Detection circuitry * Protected memory with tamper detection * Boot-strap circuitry for loading program code * Data connections in polysilicon layers where possible * OverUnderPower Detection Unit 25 e No scan-chains or BIST 10.3.1 Flash process The QA Chip is implemented with a standard Flash manufacturing process. It is important that a Flash process be used to ensure that good endurance is achieved (parts of the Flash memory can be erased/written many times). 30 10.3.2 Internal randomized clock To prevent clock glitching and external clock-based attacks, the operating clock of the chip should be generated internally. This can be conveniently accomplished by an internal ring oscillator, The length of the ring depends on the process used for manufacturing the chip. Due to process and temperature variations, the clock needs to be trimmed to bring it into a range 35 usable for timing of Flash memory writes and erases. The internal clock should also contain a small amount of randomization to prevent attacks where light emissions from switching events are captured, as described below.
WO 2004/050369 PCT/AU2003/001616 988 Finally, the generated clock must be passed through a temperature-based clock filter before being used by the rest of the chip (see Section 10.3.3 on page 988). The normal situation for FET implementation for the case of a CMOS inverter (which involves a pMOS transistor combined with an nMOS transistor) as shown in Figure 353. 5 During the transition, there is a small period of time where both the nMOS transistor and the pMOS transistor have an intermediate resistance. The resultant power-ground short circuit causes a temporary increase in the current, and in fact accounts for around 20% of current consumed by a CMOS device. A small amount of infrared light is emitted during the short circuit, and can be viewed through the silicon substrate (silicon is transparent to infrared light). A small amount of light is also 10 emitted during the charging and discharging of the transistor gate capacitance and transmission line capacitance. For circuitry that manipulates secret key information, such information must be kept hidden. Fortunately, IBM's PICA system and LVP (laser voltage probe) both have a requirement for repeatability due to the fact that the photo emissions are extremely weak (one photon requires more 15 than 105 switching events). PICA requires around 109 pases to build a picture of the optical waveform. Similarly the LVP requires multiple passes to ensure an adequate SNR. Randomizing the clock stops repeatability (from the point of view of collecting information about the same position in time), and therefore reduces the possibility of this attack. 10.3.3 Temperature based clock filter 20 The QA Chip circuitry is designed to operate within a specific clock speed range. Although the clock is generated by an internal ring oscillator, the speed varies with temperature and power. Since the user supplies the temperature and power, it is possible for an attacker to attempt to introduce race conditions in the circuitry at specific times during processing. An example of this is where a low temperature causes a clock speed higher than the circuitry is designed for, and this may prevent an 25 XOR from working properly, and of the two inputs, the first may always be returned. These styles of transient fault attacks are documented further in [1]. The lesson to be learned from this is that the input power and operating temperature cannot be trusted. Since the chip contains a specific power filter, we must also filter the clock. This can be achieved with a temperature sensor that allows the clock pulses through only when the temperature range is 30 such that the chip can function correctly. The filtered clock signal would be further divided internally as required. 10.3.4 Noise Generator Each QA Chip should contain a noise generator that generates continuous circuit noise. The noise will interfere with other electromagnetic emissions from the chip's regular activities and add noise to 35 the ldd signal. Placement of the noise generator is not an issue on an QA Chip due to the length of the emission wavelengths.
WO 2004/050369 PCT/AU2003/001616 989 The noise generator is used to generate electronic noise, multiple state changes each clock cycle, and as a source of pseudo-random bits for the Tamper Prevention and Detection circuitry (see Section 10.3.5 on page 989). A simple implementation of a noise generator is a 64-bit maximal period LFSR seeded with a non 5 zero number. 10.3.5 Tamper Prevention and Detection circuitry A set of circuits is required to test for and prevent physical attacks on the QA Chip. However what is actually detected as an attack may not be an intentional physical attack. It is therefore important to distinguish between these two types of attacks in an QA Chip: 10 - where you can be certain that a physical attack has occurred. 0 where you cannot be certain that a physical attack has occurred. The two types of detection differ in what is performed as a result of the detection. In the first case, where the circuitry can be certain that a true physical attack has occurred, erasure of flash memory key information is a sensible action. In the second case, where the circuitry cannot be sure if an 15 attack has occurred, there is still certainly something wrong. Action must be taken, but the action should not be the erasure of secret key information. A suitable action to take in the second case is a chip RESET. If what was detected was an attack that has permanently damaged the chip, the same conditions will occur next time and the chip will RESET again. If, on the other hand, what was detected was part of the normal operating environment of the chip, a RESET will not harm the key. 20 A good example of an event that circuitry cannot have knowledge about, is a power glitch. The glitch may be an intentional attack, attempting to reveal information about the key. It may, however, be the result of a faulty connection, or simply the start of a power-down sequence. It is therefore best to only RESET the chip, and not erase the key. If the chip was powering down, nothing is lost. If the System is faulty, repeated RESETs will cause the consumer to get the System repaired. In 25 both cases the consumable is still intact. A good example of an event that circuitry can have knowledge about, is the cutting of a data line within the chip. If this attack is somehow detected, it could only be a result of a faulty chip (manufacturing defect) or an attack. In either case, the erasure of the secret information is a sensible step to take. 30 Consequently each QA Chip should have 2 Tamper Detection Lines - one for definite attacks, and one for possible attacks. Connected to these Tamper Detection Lines would be a number of Tamper Detection test units, each testing for different forms of tampering. In addition, we want to ensure that the Tamper Detection Lines and Circuits themselves cannot also be tampered with. At one end of the Tamper Detection Line is a source of pseudo-random bits (clocking at high speed 35 compared to the general operating circuitry). The Noise Generator circuit described above is an adequate source. The generated bits pass through two different paths - one carries the original data, and the other carries the inverse of the data. The wires carrying these bits are in the layer WO 2004/050369 PCT/AU2003/001616 990 above the general chip circuitry (for example, the memory, the key manipulation circuitry etc.). The wires must also cover the random bit generator. The bits are recombined at a number of places via an XOR gate. If the bits are different (they should be), a 1 is output, and used by the particular unit (for example, each output bit from a memory read should be ANDed with this bit value). The lines 5 finally come together at the Flash memory Erase circuit, where a complete erasure is triggered by a 0 from the XOR. Attached to the line is a number of triggers, each detecting a physical attack on the chip. Each trigger has an oversize nMOS transistor attached to GND. The Tamper Detection Line physically goes through this nMOS transistor. If the test fails, the trigger causes the Tamper Detect Line to become 0. The XOR test will therefore fail on either this clock cycle or the next one (on 10 average), thus RESETing or erasing the chip. Figure 349 illustrates the basic principle of a Tamper Detection Line in terms of tests and the XOR connected to either the Erase or RESET circuitry. The Tamper Detection Line must go through the drain of an output transistor for each test, as illustrated by Figure 350. 15 It is not possible to break the Tamper Detect Line since this would stop the flow of 1s and Os from the random source. The XOR tests would therefore fail. As the Tamper Detect Line physically passes through each test, it is not possible to eliminate any particular test without breaking the Tamper Detect Line. It is important that the XORs take values from a variety of places along the Tamper Detect Lines in 20 order to reduce the chances of an attack. Figure 351 illustrates the taking of multiple XORs from the Tamper Detect Line to be used in the different parts of the chip. Each of these XORs can be considered to be generating a ChipOK bit that can be used within each unit or sub-unit. A typical usage would be to have an OK bit in each unit that is ANDed with a given ChipOK bit each cycle. The OK bit is loaded with 1 on a RESET. If OK is 0, that unit will fail until the next RESET. If 25 the Tamper Detect Line is functioning correctly, the chip will either RESET or erase all key information. If the RESET or erase circuitry has been destroyed, then this unit will not function, thus thwarting an attacker. The destination of the RESET and Erase line and associated circuitry is very context sensitive. It needs to be protected in much the same way as the individual tamper tests. There is no point 30 generating a RESET pulse if the attacker can simply cut the wire leading to the RESET circuitry. The actual implementation will depend very much on what is to be cleared at RESET, and how those items are cleared. Finally, Figure 352 shows how the Tamper Lines cover the noise generator circuitry of the chip. The generator and NOT gate are on one level, while the Tamper Detect Lines run on a level above the 35 generator.
WO 2004/050369 PCT/AU2003/001616 991 10.3.6 Protected memory with tamper detection It is not enough to simply store secret information or program code in flash memory. The Flash memory and RAM must be protected from an attacker who would attempt to modify (or set) a particular bit of program code or key information. The mechanism used must conform to being used 5 in the Tamper Detection Circuitry (described above). The first part of the solution is to ensure that the Tamper Detection Line passes directly above each flash or RAM bit. This ensures that an attacker cannot probe the contents of flash or RAM. A breach of the covering wire is a break in the Tamper Detection Line. The breach causes the Erase signal to be set, thus deleting any contents of the memory. The high frequency noise on the Tamper 10 Detection Line also obscures passive observation. The second part of the solution for flash is to always store the data with its inverse. In each byte, 4 bits contains the data, and 4 bits (the shadow) contains the inverse of the data. If both are 0, this is a valid erase state, and the value is 0. Otherwise, the memory is only valid if the 4 bits of shadow are the inverse of the main 4 bits. The reasoning is that it is possible to add electrons to flash via a 15 FIB, but not take electrons away. If it is possible to change a 0 to 1 for example, it is not possible to do the same to its inverse, and therefore regardless of the sense of flash, an attack can be detected. The second part of the solution for RAM is to use a parity bit. The data part of the register can be checked against the parity bit (which will not match after an attack). 20 The bits coming from Flash and RAM can therefore be validated by a number of test units (one per bit) connected to the common Tamper Detection Line. The Tamper Detection circuitry would be the first circuitry the data passes through (thus stopping an attacker from cutting the data lines). In addition, the data and program code should be stored in different locations for each chip, so an attacker does not know where to launch an attack. Finally, XORing the data coming in and going to 25 Flash with a random number that varies for each chip means that the attacker cannot learn anything about the key by setting or clearing an individual bit that has a probability of being the key (the inverse of the key must also be stored somewhere in flash). Finally, each time the chip is called, every flash location is read before performing any program code. This allows the flash tamper detection to be activated in a common spot instead of when the 30 data is actually used or program code executed. This reduces the ability of an attacker to know exactly what was written to. 10.3.7 Boot-strap circuitry for loading program code Program code should be kept in protected flash instead of ROM, since ROM is subject to being altered in a non-testable way. A boot-strap mechanism is therefore required to load the program 35 code into flash memory (flash memory is in an indeterminate state after manufacture). The boot-strap circuitry must not be in a ROM -a small state-machine suffices. Otherwise the boot code could be trivially modified in an undetectable way.
WO 2004/050369 PCT/AU2003/001616 992 The boot-strap circuitry must erase all flash memory, check to ensure the erasure worked, and then load the program code. The program code should only be executed once the flash program memory has been validated via Program Mode. 5 Once the final program has been loaded, a fuse can be blown to prevent further programming of the chip. 10.3.8 Connections in polysilicon layers where possible Wherever possible, the connections along which the key or secret data flows, should be made in the polysilicon layers. Where necessary, they can be in metal 1, but must never be in the top metal 10 layer (containing the Tamper Detection Lines). 10.3.9 OverUnder Power Detection Unit Each QA Chip requires an OverUnder Power Detection Unit (PDU) to prevent Power Supply Attacks. A PDU detects power glitches and tests the power level against a Voltage Reference to ensure it is within a certain tolerance. The Unit contains a single Voltage Reference and two 15 comparators. The PDU would be connected into the RESET Tamper Detection Line, thus causing a RESET when triggered. A side effect of the PDU is that as the voltage drops during a power-down, a RESET is triggered, thus erasing any work registers. 10.3.10 No scan chains or BIST 20 Test hardware on an QA Chip could very easily introduce vulnerabilities. In addition, due to the small size of the QA Chip logic, test hardware such as scan paths and BIST units could in fact take a sizeable chunk of the final chip, lowering yield and causing a situation where an error in the test hardware causes the chip to be unusable. As a result, the QA Chip should not contain any BIST or scan paths. Instead, the program memory must first be validated via the Program Mode 25 mechanism, and then a series of program tests run to verify the remaining parts of the chip. 11 Architecture Figure 389 shows a high level block diagram of the QA Chip. Note that the tamper prevention and detection circuitry is not shown. 11.1 ANALOGUE UNIT 30 Figure 390 shows a block diagram of the Analogue Unit. Blocks shown in yellow provide additional protection against physical and electrical attack and, depending on the level of security required, may optionally be implemented. 11.1.1 Ring oscillator The operating clock of the chip (SysClk) is generated by an internal ring oscillator whose frequency 35 can be trimmed to reduce the variation from 4:1 (due to process and temperature) down to 2:1 (temperature variations only) in order to satisfy the timing requirements of the Flash memory.
WO 2004/050369 PCT/AU2003/001616 993 The length of the ring depends on the process used for manufacturing the chip. A nominal operating frequency range of 10 MHz is sufficient. This clock should contain a small amount of randomization to prevent attacks where light emissions from switching events are captured. Note that this is different to the input SCIk which is the serial clock for external communication. 5 The ring oscillator is covered by both Tamper Detection and Prevention lines so that if an attacker attempts to tamper with the unit, the chip will either RESET or erase all secret information. FPGA Note: the FPGA does not have an internal ring oscillator. An additional pin (SysCk) is used instead. This is replaced by an internal ring oscillator in the final ASIC. 11.1.2 Voltage reference 10 The voltage reference block maintains an output which is substantially independant of process, supply voltage and temperature. It provides a reference voltage which is used by the PDU and a reference current to stabilise the ring oscillator. It may also be used as part of the temperature based clock filter described in Section 10.3.3 on page 988. 11.1.3 OverUnder power detection unit 15 The OverUnder Power Detection Unit (PDU) is the same as that described in Section 10.3.9 on page 992. The Under Voltage Detection Unit provides the signal PwrFailing which, if asserted, indicates that the power supply may be turning off. This signal is used to rapidly terminate any Flash write that may be in progress to avoid accidentally writing to an indeterminate memory location. 20 Note that the PDU triggers the RESET Tamper Detection Line only. It does not trigger the Erase Tamper Detection Line. The PDU can be implemented with regular CMOS, since the key does not pass through this unit. It does not have to be implemented with non-flashing CMOS. The PDU is covered by both Tamper Detection and Prevention lines so that if an attacker attempts 25 to tamper with the unit, the chip will either RESET or erase all secret information. 11.1.4 Power-on Reset and Tamper Detect Unit The Power-on Reset unit (POR) detects a power-on condition and generates the PORstL signal that is fed to all the validation units, including the two inside the Tamper Detect Unit (TDU). All other logic is connected to RstL, which is the PORstL gated by the VAL unit attached to the Reset 30 tamper detection lines (see Section 10.3.5 on page 989) within the TDU. Therefore, if the Reset tamper line is asserted, the validation will drive RstL low, and can only be cleared by a power-down. If the tamper line is not asserted, then RstL = PORstL. The TDU contains a second VAL unit attached to the Erase tamper detection lines (see Section 10.3.5 on page 989) within the TDU. It produces a TamperEraseOK signal that is output to the MIU (1 35 = the tamper lines are all OK, 0 = force an erasure of Flash).
WO 2004/050369 PCT/AU2003/001616 994 11.1.5 Noise generator The Noise Generator (NG) is the same as that described in Section 10.3.4 on page 988. It is based on a 64-bit maximal period LFSR loaded with a set non-zero bit pattern on RESET. The NG must be protected by both Tamper Detection and Prevention lines so that if an attacker 5 attempts to tamper with the unit, the chip will either RESET or erase all secret information. In addition, the bits in the LFSR must be validated to ensure they have not been tampered with (i.e. a parity check). If the parity check fails, the Erase Tamper Detection Line is triggered. Finally, all 64 bits of the NG are ORed into a single bit. If this bit is 0, the Erase Tamper Detection Line is triggered. This is because 0 is an invalid state for an LFSR. 10 11.2 TRIM UNIT The 8-bit Trim register within the Trim Unit has a reset value of OxOO (to enable the flash reads to succeed even in the fastest process corners), and is written to either by the PMU during Trim Mode or by the CPU in Active Mode. Note that the CPU is only able to write once to the Trim register between power-on-reset due to the TrimDone flag which provides overloading of LocalldWE. 15 The reset value of Trim (0) means that the chip has a nominal frequency of 2.7MHz - 10MHz. The upper of the range is when we cannot trim it lower than this (or we could allow some spread on the acceptable trimmed frequency but this will reduce our tolerance to ageing, voltage and temperature which is the range 7MHz to 14MHz). The 2.7MHz value is determined by a chip whose oscillator runs at 10MHz when the trim register is set to its maximum value, so then it must run at 2.7MHz 20 when trim = 0. This is based on the non-linear frequency-current characteristic of the oscillator. Chips found outside of these limits will be rejected. The frequency of the ring oscillator is measured by counting cycles, in the PMU, over the byte period of the serial interface. The frequency of the serial clock, SCIk, and therefore the byte period will be accurately controlled during the measurement. The cycle count (Fmeas) at the end of the 25 period is read over the serial bus and the Trim register updated (Trimval) from its power on default (POD) value. The steps are shown in Figure 391. Multiple measure - read - trim cycles are possible to improve the accuracy of the trim procedure. A single byte for both Fmeas and Trimval provide sufficient accuracy for measurement and trimming of the frequency. If the bus operates at 400kHz, a byte (8 bits) can be sent in 20p1s. By dividing the 30 maximum oscillator frequency, expected to be 20MHz, by 2 results in a cycle count of 200 and 50 for the minimum frequency of 5MHz resulting in a worst case accuracy of 2%. Figure 392 shows a block diagram of the Trim Unit: 6Note that the PMU counts using 12-bits, saturates at OxFFF, and returns the cycle count divided by 2 as an 8 bit value. This means that multiple measure-read-trim cycles may be necessary to resolve any amibguity. In any case, multiple cycles are necessary to test the correctness of the trim circuitry during manufacture test.
WO 2004/050369 PCT/AU2003/001616 995 The 8-bit Trim value is used in the analog Trim Block to adjust the frequency of the ring oscillator by controlling its bias current. The two Isbs are used as a voltage trim, and the 6 msbs are used as a frequency trim. The analog Trim Clock circuit also contains a Temperature filter as described in Section 10.3.3 on 5 page 988. 11.3 10 UNIT The QA Chip acts as a slave device, accepting serial data from an external master via the 10 Unit (IOU). Although the IOU actually transmits data over a 1-bit line, the data is always transmitted and received in 1-byte chunks. 10 The IOU receives commands from the master to place it in a specific operating mode, which is one of: " Idle Mode: is the startup mode for the IOU if the fuse has not yet been blown. Idle Mode is the mode where the QA Chip is waiting for the next command from the master. Input signals from the CPU are ignored. 15 e Program Mode: is where the QA Chip erases all currently stored data in the Flash memory (program and secret key information) and then allows new data to be written to the Flash. The IOU stays in Program Mode until told to enter another mode. * Active Mode: is the startup mode for the IOU if the fuse has been blown (the program is safe to run). Active Mode is where the QA Chip allows the program code to be executed to 20 process the master's specific command. The IOU returns to Idle Mode automatically when the command has been processed, or if the time taken between consuming input bytes (while the master is writing the data) or generating output bytes (while the master is reading the results) is too great. * Trim Mode: is where the QA Chip allows the generation and setting of a trim value to be used 25 on the internal ring oscillator clock value. This must be done for safety reasons before a program can be stored in the Flash memory. See Section 12 on page 997 for detailed information about the IOU. 11.4 CENTRAL PROCESSING UNIT The Central Processing Unit (CPU) block provides the majority of the circuitry of the 4-bit 30 microprocessor. Figure 393 shows a high level view of the block. 11.5 MEMORY INTERFACE UNIT The Memory Interface Unit (MIU) provides the interface to flash and RAM. The MIU contains a Program Mode Unit that allows flash memory to be loaded via the IOU, a Memory Request Unit that maps 8-bit and 32-bit requests into multiple byte based requests, and a Memory Access Unit that 35 generates read/write strobes for individual accesses to the memory. Figure 394 shows a high level view of the MIU block.
WO 2004/050369 PCT/AU2003/001616 996 11.6 MEMORY COMPONENT S The Memory Components block isolates the memory implementation from the rest of the QA Chip. The entire contents of the Memory Components block must be protected from tampering. Therefore the logic must be covered by both Tamper Detection Lines. This is to ensure that program code, 5 keys, and intermediate data values cannot be changed by an attacker. The 8-bit wide RAM also needs to be parity-checked. Figure 395 shows a high level view of the Memory Components block. It consists of 8KBytes of flash memory and 3072 bits of parity checked RAM. 11.6.1 RAM 10 The RAM block is shown here as a simple 96 x 32-bit RAM (plus parity included for verification). The parity bit is generated during the write. The RAM is in an unknown state after RESET, so program code cannot rely on RAM being 0 at startup. The initial version of the ASIC has the RAM implemented by Artisan component RAiSH (96 x 32-bit 15 RAM without parity). Note that the RAMOutEn port is active low i.e. when 0, the RAM is enabled, and when 1, the RAM is disabled. 11.6.2 Flash memory A single Flash memory block is used to hold all non-volatile data. This includes program code and variables. The Flash memory block is implemented by TSMC component SFC0008_08B9_HE [4], 20 which has the following characteristics: * 8K x 8-bit main memory, plus 128 x 8-bit information memory * 512 byte page erase * Endurance of 20,000 cycles (min) * Greater than 100 years data retention at room temperature 25 * Access time: 20 ns (max) * Byte write time: 20ps (min) * Page erase time: 20ms (min) * Device erase time: 200 ms (min) * Area of 0.494mm 2 (724.66pm x 682.05pm) 30 The FlashCtrl line are the various inputs on the SFC0008_08B9_HE required to read and write bytes, erase pages and erase the device. A total of 9 bits are required (see [4] for more information). Flash values are unchanged by a RESET. After manufacture, the Flash contents must be considered to be garbage. After an erasure, the Flash contents in the SFC0008_08B9_HE is all 1s. 11.6.3 VAL blocks 35 The two VAL units are validation units connected to the Tamper Prevention and Detection circuitry (described in Section 10.3.5 on page 989), each with an OK bit. The OK bit is set to I on PORstL, and WO 2004/050369 PCT/AU2003/001616 997 ORed with the ChipOK values from both Tamper Detection Lines each cycle. The OK bit is ANDed with each data bit that passes through the unit. In the case of VAL1, the effective byte output from the flash will always be 0 if the chip has been tampered with. This will cause shadow tests to fail, program code will not execute, and the chip will 5 hang. In the case of VAL2, the effective byte from RAM will always be 0 if the chip has been tampered with, thus resulting in no temporary storage for use by an attacker. 12 1/O Unit The I/O Unit (IOU) is responsible for providing the physical implementation of the logical interface 10 described in Section 5.1 on page 960, moving between the various modes (Idle, Program, Trim and Active) according to commands sent by the master. The IOU therefore contains the circuitry for communicating externally with the external world via the SClk and SDa pins. The IOU sends and receives data in 8-bit chunks. Data is sent serially, most significant bit (bit 7) first through to least significant bit (bit 0) last. When a master sends a command 15 to an QA Chip, the command commences with a single byte containing an id in bits 7-1, and a read/write sense in bit 0, as shown in Figure 396. The IOU recognizes a global id of 0x00 and a local id of Localld (set after the CPU has executed program code at reset or due to a global id / ActiveMode command on the serial bus). Subsequent bytes contain modal information in the case of global id, and command/data bytes in the case of a 20 match with the local id. If the master sends data too fast, then the IOU will miss data, since the IOU never holds the bus. The meaning of too fast depends on what is running. In Program Mode, the master must send data a little slower than the time it takes to write the byte to flash (actually written as 2 x 8-bit writes, or 40ps). In ActiveMode, the master is permitted to send and request data at rates up to 500 KHz. 25 None of the latches in the IOU need to be parity checked since there is no advantage for an attacker to destroy or modify them. The lOU outputs Os and inputs Os if either of the Tamper Detection Lines is broken. This will only come into effect if an attacker has disabled the RESET and/or erase circuitry, since breaking either Tamper Detection Lines should result in a RESET or the erasure of all Flash memory. 30 The IOU's InByte, InByteValid, OutByte, and OutByteValid registers are used for communication between the master and the QA Chip. InByte and InByteValid provide the means for clients to pass commands and data to the QA Chip. OutByte and OutByteValid provide the means for the master to read data from the QA Chip. a Reads from InByte should wait until InByteValid is set. InByteValid will remain clear until the 35 master has written the next input byte to the QA Chip. When the IOU is told (by the FEU or MU) that InByte has been read, the IOU clears the InByteValid bit to allow the next byte to be read from the client.
WO 2004/050369 PCT/AU2003/001616 998 e Writes to OutByte should wait until OutByteValid is clear, Writing OutByte sets the OutByteValid bit to signify that data is available to be transmitted to the master. OutByteValid will then remain set until the master has read the data from OutByte. If the master requests a byte but OutByteValid is clear, the IOU sends a NAck to indicate the data is not yet ready. 5 When the chip is reset via RstL, the IOU enters ActiveMode to allow the PMU to run to load the fuse. Once the fuse has been loaded (when MlUAvail transitions from 0 to 1) the IOU checks to see if the program is known to be safe. If it is not safe, the IOU reverts to IdleMode. If it is safe (FuseBlown = 1), the IOU stays in ActiveMode to allow the program to load up the localld and do any other reset initialization, and will not process any further serial commands until the CPU has written a byte to 10 the OutByte register (which may be read or not at the discretion of the master using a localid read). In both cases the master is then able to send commands to the QA Chip as described in Section 5.1 on page 960. Figure 397 shows a block diagram of the IOU. With regards to InByteValid inputs, set has priority over reset, although both set and reset in correct 15 operation should never be asserted at the same time. With regards to IOSetinByte and lOLoadinByte, if IOSetlnByte is asserted, it will set InByte to be OxFF regardless of the setting of IOLoadinByte. The two VAL units are validation units connected to the Tamper Prevention and Detection circuitry (described in Section 10,3.5 of the Architecture Overview chapter), each with an OK bit. The OK bit is set to I on PORstL, and ORed with the ChipOK values from both Tamper Detection Lines each 20 cycle. The OK bit is ANDed with each data bit that passes through the unit. In the case of VAL1, the effective byte output from the chip will always be 0 if the chip has been tampered with. Thus no useful output can be generated by an attacker. In the case of VAL2, the effective byte input to the chip will always be 0 if the chip has been tampered with. Thus no useful input can be chosen by an attacker. 25 There is no need to verify the registers in the IOU since an attacker does not gain anything by destroying or modifying them. The current mode of the IOU is output as a 2-bit IOMode to allow the other units within the QA Chip to take correct action. IOMode is defined as shown in Table 372: Table 372. IOMode values 30 Value Interpretation 00 Idle Mode 01 Program Mode 10 Active Mode 11 Trim Mode WO 2004/050369 PCT/AU2003/001616 999 The Logic blocks generate a I if the current IOMode is in Program Mode, Active Mode or Trim Mode respectively. The logic blocks are: Logic 1 IOMode = 01 (Program) Logic 2 lOMode = 10 (Active) Logic 3 IOMode = 11 (Trim) 5 12.1 STATE MACHINE There are two state machines in the IOU running in parallel. The first is a byte-oriented state machine, the second is a bit-oriented state machine. The byte-oriented state machine keeps track of the operating mode of the QA Chip while the bit-oriented state machine keeps track of the low level bit Rx/Tx protocol. 10 The SDa and SCIk lines are connected to the respective pads on the QA Chip. The IOU passes each of the signals from the pads through 2 D-types to compensate for metastability on input, and then a further latch and comparitor to ensure that signals are only used if stable for 2 consecutive internal clock cycles. The circuit is shown in Section 12.1.1 below. 12.1.1 Start/Stop control signals 15 The StartDetected and StopDetected control signals are generated based upon monitoring SDa synchronized to SCIk. The StartDetected condition is asserted on the falling edge of SDa synchronized to SClk, and the StopDetected condition is asserted on the rising edge of SDa synchronized to SCIk. In addition we generate feSCIk which is asserted on the falling edge of SClk, and reSCIk which is asserted on the rising edge of SCIk. Finally, feSclkPrev is the value of feSCIk delayed by a single cycle. 20 Figure 398 shows the relationship of inputs and the generation of SDaReg, reSClk, feSClk, feSclkPrev, StartDetected and StopDetected. The SDaRegSelect logic compensates for the 2:1 variation in clock frequency. It uses the length of the high period of the SCIk (from the saturating counter) to select between sda5, sda6 and sda7 as the valid data from 300ns before the falling edge of SCIk as follows. 25 The minimum time for the high period of SCIk is 600ns. If the counter <= 4 (i.e. 5 or fewer cycles with SCIk = 1) then SDaReg output = sda5 (sample point is equidistant from rising and falling edges). If the counter = 5 or 6 (i.e. 6 or 7 samples where SCIk = 1) , then SDaReg output = sda6. If the counter = 7 (the counter saturates when there are 8 samples of SClk = 1), then SDaReg output = sda7. This is shown in pseducode below: 30 If ((counter 2 = 0) v (counter = 4)) SDaReg = sda5 ElseIf (counter = 7) SDaReg = sda7 Else
Claims (15)
1. A method of compensating for an inoperative nozzle in a printhead, the method comprising the step of: 5 (a) mapping dot data intended for the inoperative nozzle into one or more operative nozzles of the printhead.
2. A method according to claim 1, wherein step (a) includes the substep of mapping the dot data intended for the inoperative nozzle into a nozzle that will print a dot on print media close to a position at 10 which the inoperative nozzle would have printed a dot had it been operative.
3. A method according to claim 1, wherein step (a) includes the substep of mapping the dot data intended for the inoperative nozzle into a nozzle that will print a dot on print media immediately adjacent a position at which the inoperative nozzle would have printed a dot had it been operative. 15
4. A method according to 1, wherein step (a) includes the substeps of: (i) determining one or more operative nozzles capable of printing a dot on print media close to a position at which the inoperative nozzle would have printed a dot had it been operative; and (ii) mapping the dot data from the inoperative nozzle to an operative nozzle determined in substep (i). 20
5. A method according to claim 4, wherein, in the event more than one operative nozzle is determined in substep (i), the dot data is remapped to one of the operative nozzles that will print a dot on print media closest to that which would have been printed by the inoperative nozzle. 25
6. A method according to claim 5, wherein, during successive firings of the printhead, the dot data is remapped alternately to operative nozzles that will print a dot on print media either side of that which would have been printed by the inoperative nozzle.
7. A method according to claim 5, wherein, during successive firings of the printhead, the dot data is 30 remapped randomly, pseudo-randomly, or arbitrarily to operative nozzles that will print a dot on print media either side of that which would have been printed by the inoperative nozzle.
8. A method according to claim 1, the printhead including a plurality of sets of the nozzles for printing a corresponding plurality of channels of dot data, wherein step (a) includes the substep of mapping the dot 35 data intended for the inoperative nozzle into one or more operative nozzles from the same set.
9. A method according to claim 8, wherein step (a) includes the substep of mapping the dot data into one or more operative nozzles that will print a dot on print media close to a position at which the inoperative nozzle would have printed a dot had it been operative. 40 WO 2004/050369 PCT/AU2003/001616 1096
10. A method according to claim 8, wherein step (a) includes the substep of mapping the dot data intended for the inoperative nozzle into one or more operative nozzles including at least one nozzle from a different one of the sets. 5
11. A method according to claim 8, wherein step (a) includes the substeps of: determining which combination of one or more available operative nozzles near the inoperative nozzle will minimise perceived error in an image that the dot data forms part of, the determination being performed on the basis of a color model; and mapping the dot data intended for the inoperative nozzle to that combination of one or more 10 operative nozzles.
12. A method according to claim 11, wherein the inoperative nozzle is associated with a black print channel, and wherein step (a) includes remapping the dot data intended for the inoperative nozzle into a plurality of operative nozzles in other color channels to produce a process black output at or adjacent a 15 location on print media where the inoperative nozzle would have deposited a droplet of a black printing substance in accordance with the dot data.
13. A method according to claim 1, wherein a plurality of dot data intended for a corresponding plurality of inoperative nozzles are mapped to operative nozzles. 20
14. A printer controller configured to implement the method of claim 1.
15. A printer controller configured to implement the method of claim I to a printhead comprising a plurality of the nozzles. 25
Priority Applications (1)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
AU2003302611A AU2003302611B2 (en) | 2002-12-02 | 2003-12-02 | Dead nozzle compensation |
Applications Claiming Priority (6)
Application Number | Priority Date | Filing Date | Title |
---|---|---|---|
AU2002953134A AU2002953134A0 (en) | 2002-12-02 | 2002-12-02 | Method and apparatus (auth16) |
AU2002953135 | 2002-12-02 | ||
AU2002953134 | 2002-12-02 | ||
AU2002953135A AU2002953135A0 (en) | 2002-12-02 | 2002-12-02 | Method and apparatus (pec10) |
AU2003302611A AU2003302611B2 (en) | 2002-12-02 | 2003-12-02 | Dead nozzle compensation |
PCT/AU2003/001616 WO2004050369A1 (en) | 2002-12-02 | 2003-12-02 | Dead nozzle compensation |
Publications (2)
Publication Number | Publication Date |
---|---|
AU2003302611A1 true AU2003302611A1 (en) | 2004-06-23 |
AU2003302611B2 AU2003302611B2 (en) | 2007-04-19 |
Family
ID=34381479
Family Applications (1)
Application Number | Title | Priority Date | Filing Date |
---|---|---|---|
AU2003302611A Ceased AU2003302611B2 (en) | 2002-12-02 | 2003-12-02 | Dead nozzle compensation |
Country Status (1)
Country | Link |
---|---|
AU (1) | AU2003302611B2 (en) |
Cited By (1)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN110976235A (en) * | 2019-12-31 | 2020-04-10 | 太仓顺鑫涂装机械有限公司 | Electrostatic powder spraying treatment method and system |
Family Cites Families (8)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
US6283572B1 (en) * | 1997-03-04 | 2001-09-04 | Hewlett-Packard Company | Dynamic multi-pass print mode corrections to compensate for malfunctioning inkjet nozzles |
US6010205A (en) * | 1997-03-12 | 2000-01-04 | Raster Graphics Inc. | Method and apparatus for improved printing |
EP0999935B1 (en) * | 1997-08-01 | 2003-11-05 | Encad, Inc. | Ink jet printer, method and system compensating for nonfunctional print elements |
US20020008723A1 (en) * | 1998-07-21 | 2002-01-24 | Xin Wen | Printer and method of compensating for malperforming and inoperative ink nozzles in a print head |
EP0983855A3 (en) * | 1998-08-31 | 2000-08-02 | Hewlett-Packard Company | Dot substitution to compensate for failed ink jet nozzles |
US6354689B1 (en) * | 1998-12-22 | 2002-03-12 | Eastman Kodak Company | Method of compensating for malperforming nozzles in a multitone inkjet printer |
TW487639B (en) * | 2000-02-15 | 2002-05-21 | Acer Comm & Multimedia Inc | Ink-jet printer having abnormal compensation function of nozzle |
AUPQ766300A0 (en) * | 2000-05-22 | 2000-06-15 | Canon Kabushiki Kaisha | Defective nozzle compensation |
-
2003
- 2003-12-02 AU AU2003302611A patent/AU2003302611B2/en not_active Ceased
Cited By (2)
Publication number | Priority date | Publication date | Assignee | Title |
---|---|---|---|---|
CN110976235A (en) * | 2019-12-31 | 2020-04-10 | 太仓顺鑫涂装机械有限公司 | Electrostatic powder spraying treatment method and system |
CN110976235B (en) * | 2019-12-31 | 2022-04-26 | 苏州智勃凯科技有限公司 | Electrostatic powder spraying treatment method and system |
Also Published As
Publication number | Publication date |
---|---|
AU2003302611B2 (en) | 2007-04-19 |
Similar Documents
Publication | Publication Date | Title |
---|---|---|
US7171323B2 (en) | Integrated circuit having clock trim circuitry | |
US20050210179A1 (en) | Integrated circuit having random clock or random delay | |
US20040174570A1 (en) | Variable size dither matrix usage | |
AU2003302611A1 (en) | Dead nozzle compensation |
Legal Events
Date | Code | Title | Description |
---|---|---|---|
FGA | Letters patent sealed or granted (standard patent) | ||
PC | Assignment registered |
Owner name: ZAMTEC LIMITED Free format text: FORMER OWNER WAS: SILVERBROOK RESEARCH PTY LTD |
|
MK14 | Patent ceased section 143(a) (annual fees not paid) or expired |