Add missing docs

packages/supercic/supercic/COPYING

@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

packages/supercic/supercic/supercic-key.asm

@@ -0,0 +1,728 @@
+    #include <p12f629.inc>
+processor p12f629
+
+; ---------------------------------------------------------------------
+;   feature enhanced SNES CIC clone for PIC Microcontroller (key mode only)
+;
+;   Copyright (C) 2010 by Maximilian Rehkopf (ikari_01) <otakon@gmx.net>
+;   This software is part of the sd2snes project.
+;
+;   This program is free software; you can redistribute it and/or modify
+;   it under the terms of the GNU General Public License as published by
+;   the Free Software Foundation; version 2 of the License only.
+;
+;   This program is distributed in the hope that it will be useful,
+;   but WITHOUT ANY WARRANTY; without even the implied warranty of
+;   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;   GNU General Public License for more details.
+;
+;   You should have received a copy of the GNU General Public License
+;   along with this program; if not, write to the Free Software
+;   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+;
+; ---------------------------------------------------------------------
+;
+;   pin configuration: (cartridge pin) [key CIC pin]
+;
+;                       ,---_---.
+;      +5V (27,58) [16] |1     8| GND (5,36) [8]
+;      CIC clk (56) [6] |2     7| CIC data i/o 0 (55) [2]
+;            status out |3     6| CIC data i/o 1 (24) [1]
+;                 /PAIR |4     5| CIC slave reset (25) [7]
+;                       `-------'
+;
+;
+;   Status out can be connected to a LED. It indicates:
+;
+;   state                   | output
+;  -------------------------+----------------------------
+;   OK or no lock CIC       | high
+;   error                   | low
+;   SuperCIC pair mode      | 148.75kHz / 50% duty cycle
+;
+;   In case lockout fails, the region is switched automatically and
+;   will be used after the next reset.
+;
+;   The /PAIR pin can be used to enable or disable SuperCIC pair mode.
+;   It can be tied low or high to statically enable or disable pair mode
+;   detection, or connected to a switch or MCU to dynamically enable pair
+;   mode detection (it should then be connected to a pull-up resistor to
+;   Vcc). Pair mode detection can be enabled during operation,
+;   but pair mode cannot be left until the next power cycle.
+;   See SuperCIC lock documentation for a more detailed description of
+;   pair mode.
+;
+;   memory usage:
+;
+;   0x20		buffer for seed calc and transfer
+;   0x21 - 0x2f		seed area (lock seed)
+;   0x30		buffer for seed calc
+;   0x31 - 0x3f		seed area (key seed; 0x31 filled in by lock)
+;   0x40 - 0x41		buffer for seed calc
+;   0x4d		buffer for eeprom access
+;   0x4e		loop variable for longwait
+;   0x4f		loop variable for wait
+;   0x5e                SuperCIC pair mode detect (phase 1)
+;   0x5f                SuperCIC pair mode detect (phase 2)
+; ---------------------------------------------------------------------
+
+
+; -----------------------------------------------------------------------
+    __CONFIG _EC_OSC & _WDT_OFF & _PWRTE_OFF & _MCLRE_OFF & _CP_OFF & _CPD_OFF
+
+; -----------------------------------------------------------------------
+; code memory
+	org	0x0000
+	nop
+	nop
+	nop
+	goto	init
+isr
+	org	0x0004
+	bcf	INTCON, 1	; clear interrupt cause
+	bcf	GPIO, 0
+	bcf	GPIO, 1
+	bsf	GPIO, 4		; LED on
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	bsf	INTCON, 7	; re-enable interrupts (ISR will continue as main)
+	goto	main
+init
+	org 0x0010
+	banksel GPIO
+	clrf	GPIO
+	movlw	0x07	; GPIO2..0 are digital I/O (not connected to comparator)
+	movwf	CMCON
+	movlw	0x90	; global enable interrupts + enable external interrupt
+	movwf	INTCON
+	banksel	TRISIO
+	movlw	0x2d	; in out in in out in
+	movwf	TRISIO
+	movlw	0x24	; pullups for reset+clk to avoid errors when no CIC in host 
+	movwf	WPU
+	movlw	0x00	; 0x80 for global pullup disable
+	movwf	OPTION_REG
+	
+	banksel GPIO
+	bsf 	GPIO, 4	; LED on
+idle
+	goto	idle	; wait for interrupt from lock
+
+main
+	banksel	TRISIO
+	bsf	TRISIO, 0
+	bcf	TRISIO, 1
+	banksel	GPIO
+; --------INIT LOCK SEED (what the lock sends)--------
+	movlw	0xb
+	movwf	0x21
+	movlw	0x1
+	movwf	0x22
+	movlw	0x4
+	movwf	0x23
+	movlw	0xf
+	movwf	0x24
+	movlw	0x4
+	movwf 	0x25
+	movlw	0xb
+	movwf 	0x26
+	movlw	0x5
+	movwf 	0x27
+	movlw	0x7
+	movwf 	0x28
+	movlw	0xf
+	movwf 	0x29
+	movlw	0xd
+	movwf 	0x2a
+	movlw	0x6
+	movwf 	0x2b
+	movlw	0x1
+	movwf 	0x2c
+	movlw	0xe
+	movwf 	0x2d
+	movlw	0x9
+	movwf 	0x2e
+	movlw	0x8
+	movwf 	0x2f
+	
+; --------INIT KEY SEED (what we must send)--------
+	banksel	EEADR		; D/F411 and D/F413
+	clrf	EEADR		; differ in 2nd seed nibble
+	bsf	EECON1, RD	; of key stream,
+	movf	EEDAT, w	; restore saved nibble from EEPROM
+	banksel GPIO
+	movwf	0x32
+	movlw	0xa
+	movwf	0x33
+	movlw	0x1
+	movwf	0x34
+	movlw	0x8
+	movwf 	0x35
+	movlw	0x5
+	movwf 	0x36
+	movlw	0xf
+	movwf 	0x37
+	movlw	0x1
+	movwf 	0x38
+	movwf 	0x39
+	movlw	0xe
+	movwf 	0x3a
+	movlw	0x1
+	movwf 	0x3b
+	movlw	0x0
+	movwf 	0x3c
+	movlw	0xd
+	movwf 	0x3d
+	movlw	0xe
+	movwf 	0x3e
+	movlw	0xc
+	movwf 	0x3f
+	
+; --------wait for stream ID--------
+	movlw	0xb5
+	call	wait
+	clrf	0x31		; clear lock stream ID
+
+; --------lock sends stream ID. 15 cycles per bit--------
+;	bsf	GPIO, 0		; (debug marker)
+;	bcf	GPIO, 0		; 
+	btfsc	GPIO, 0		; check stream ID bit
+	bsf	0x31, 3		; copy to lock seed
+	movlw	0x2		; wait=3*W+5
+	call	wait		; burn 11 cycles
+	nop
+	nop
+
+;	bsf	GPIO, 0
+;	bcf	GPIO, 0
+	btfsc	GPIO, 0		; check stream ID bit
+	bsf	0x31, 0		; copy to lock seed
+	movlw	0x2		;
+	call	wait		; burn 11 cycles
+	nop
+	nop
+
+;	bsf	GPIO, 0
+;	bcf	GPIO, 0
+	btfsc	GPIO, 0		; check stream ID bit
+	bsf	0x31, 1		; copy to lock seed
+	movlw	0x2		;
+	call	wait		; burn 11 cycles
+	nop
+	nop
+
+;	bsf	GPIO, 0
+;	bcf	GPIO, 0
+	btfsc	GPIO, 0		; check stream ID bit
+	bsf	0x31, 2		; copy to lock seed
+	banksel	TRISIO
+	bcf	TRISIO, 0
+	bsf	TRISIO, 1
+	banksel	GPIO
+	nop
+	movlw	0x27		; "wait" 1
+	call	wait		; wait 121
+; --------main loop--------
+loop	
+	movlw	0x1
+loop0
+	addlw	0x30	; key stream
+	movwf	FSR	; store in index reg
+loop1
+	nop
+	nop
+	movf	INDF, w ; load seed value
+	movwf	0x20
+	bcf	0x20, 1	; clear bit 1 
+	btfsc	0x20, 0 ; copy from bit 0
+	bsf	0x20, 1 ; (if set)
+	bsf	0x20, 4 ; LED on
+	movf	0x20, w
+	movwf	GPIO
+	nop
+	movlw	0x10
+	movwf	GPIO	; reset GPIO
+	movlw	0x14
+	call	wait
+	nop
+	nop
+	nop
+	nop
+	nop
+	btfsc	GPIO, 0 ; both pins must be low...
+	goto	die
+	btfsc	GPIO, 1 ; ...when no bit transfer takes place
+	goto	die	; if not -> lock cic error state -> die
+	incf	FSR, f	; next one
+	movlw	0xf
+	andwf	FSR, w
+	btfss	STATUS, Z	
+	goto	loop1
+	call	mangle
+	call	mangle
+	call	mangle
+	movlw	0x2	; wait 10
+	call	wait	;
+	nop
+	nop
+	btfsc	0x37, 0
+	goto	swap
+	banksel	TRISIO
+	bcf	TRISIO, 0
+	bsf	TRISIO, 1
+	goto	swapskip
+swap
+	banksel	TRISIO
+	bsf	TRISIO, 0
+	bcf	TRISIO, 1
+	nop
+swapskip
+	banksel GPIO
+	movf	0x37, w
+	andlw	0xf
+	btfss	STATUS, Z
+	goto	loop0
+	goto	loop
+
+; --------calculate new seeds--------
+; had to be unrolled because PIC has an inefficient way of handling
+; indirect access, no post increment, etc.
+mangle
+	call	mangle_lock
+	nop
+	nop
+mangle_key
+	movf	0x2f, w
+	movwf	0x20	
+mangle_key_loop
+	addlw	0x1
+	addwf	0x21, f
+	movf	0x22, w
+	movwf	0x40
+	movf	0x21, w
+	addwf	0x22, f
+	incf	0x22, f
+	comf	0x22, f
+	movf	0x23, w
+	movwf	0x41	; store 23 to 41
+	movlw	0xf
+	andwf	0x23, f
+	movf	0x40, w ; add 40(22 old)+23+#1 and skip if carry
+	andlw	0xf
+	addwf	0x23, f
+	incf	0x23, f
+	btfsc	0x23, 4
+	goto	mangle_key_withskip
+mangle_key_withoutskip
+	movf	0x41, w ; restore 23
+	addwf	0x24, f ; add to 24
+	movf	0x25, w
+	movwf	0x40	; save 25 to 40
+	movf	0x24, w
+	addwf	0x25, f
+	movf	0x26, w
+	movwf	0x41	; save 26 to 41
+	movf	0x40, w ; restore 25
+	andlw	0xf	; mask nibble
+	addlw	0x8	; add #8 to HIGH nibble
+	movwf	0x40
+	btfss	0x40, 4 ; skip if carry to 5th bit
+	addwf	0x26, w
+	movwf	0x26
+
+	movf	0x41, w ; restore 26
+	addlw	0x1	; inc
+	addwf	0x27, f	; add to 27
+
+	movf	0x27, w ;
+	addlw	0x1	; inc
+	addwf	0x28, f ; add to 28
+
+	movf	0x28, w ;
+	addlw	0x1	; inc
+	addwf	0x29, f ; add to 29
+
+	movf	0x29, w ;
+	addlw	0x1	; inc
+	addwf	0x2a, f ; add to 2a
+
+	movf	0x2a, w ;
+	addlw	0x1	; inc
+	addwf	0x2b, f ; add to 2b
+
+	movf	0x2b, w ;
+	addlw	0x1	; inc
+	addwf	0x2c, f ; add to 2c
+
+	movf	0x2c, w ;
+	addlw	0x1	; inc
+	addwf	0x2d, f ; add to 2d
+
+	movf	0x2d, w ;
+	addlw	0x1	; inc
+	addwf	0x2e, f ; add to 2e
+
+	movf	0x2e, w ;
+	addlw	0x1	; inc
+	addwf	0x2f, f ; add to 2f
+
+	movf	0x20, w ; restore original 0xf
+	andlw	0xf
+	addlw	0xf
+	movwf	0x20
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	btfss	0x20, 4 ; skip if half-byte carry
+	goto mangle_return ; +2 cycles in return
+	nop
+	goto mangle_key_loop
+; 69 when goto, 69 when return
+; CIC has 78 -> 9 nops
+
+mangle_key_withskip
+	movf	0x41, w ; restore 23
+	addwf	0x23, f ; add to 23
+	movf	0x24, w
+	movwf	0x40	; save 24 to 40
+	movf	0x23, w
+	addwf	0x24, f
+	movf	0x25, w
+	movwf	0x41	; save 25 to 41
+	movf	0x40, w ; restore 24
+	andlw	0xf	; mask nibble
+	addlw	0x8	; add #8 to HIGH nibble
+	movwf	0x40
+	btfss	0x40, 4 ; skip if carry to 5th bit
+	addwf	0x25, w
+	movwf	0x25
+
+	movf	0x41, w ; restore 25
+	addlw	0x1	; inc
+	addwf	0x26, f	; add to 26
+
+	movf	0x26, w ;
+	addlw	0x1	; inc
+	addwf	0x27, f ; add to 27
+
+	movf	0x27, w ;
+	addlw	0x1	; inc
+	addwf	0x28, f ; add to 28
+
+	movf	0x28, w ;
+	addlw	0x1	; inc
+	addwf	0x29, f ; add to 29
+
+	movf	0x29, w ;
+	addlw	0x1	; inc
+	addwf	0x2a, f ; add to 2a
+
+	movf	0x2a, w ;
+	addlw	0x1	; inc
+	addwf	0x2b, f ; add to 2b
+
+	movf	0x2b, w ;
+	addlw	0x1	; inc
+	addwf	0x2c, f ; add to 2c
+
+	movf	0x2c, w ;
+	addlw	0x1	; inc
+	addwf	0x2d, f ; add to 2d
+
+	movf	0x2d, w ;
+	addlw	0x1	; inc
+	addwf	0x2e, f ; add to 2e
+
+	movf	0x2e, w ;
+	addlw	0x1	; inc
+	addwf	0x2f, f ; add to 2f
+
+	movf	0x20, w ; restore original 0xf
+	andlw	0xf
+	addlw	0xf
+	movwf	0x20
+	bcf	GPIO, 0
+	movf	GPIO, w
+	movwf	0x5e
+	btfss	GPIO, 3
+	bsf	GPIO, 0
+	movf	GPIO, w
+	movwf	0x5f
+	bcf	GPIO, 0
+	btfsc	GPIO, 3
+	clrf	0x5e
+	nop
+	btfss	0x20, 4 ; skip if half-byte carry
+	goto mangle_return ; +2 cycles in return
+	movf	0x20, w		; restore w (previously destroyed)
+	goto mangle_key_loop
+mangle_return
+	return
+; 73 when goto, 73 when return
+; CIC has 84 -> 11 nops
+
+mangle_lock
+	movf	0x3f, w
+	movwf	0x30	
+mangle_lock_loop
+	addlw	0x1
+	addwf	0x31, f
+	movf	0x32, w
+	movwf	0x40
+	movf	0x31, w
+	addwf	0x32, f
+	incf	0x32, f
+	comf	0x32, f
+	movf	0x33, w
+	movwf	0x41	; store 33 to 41
+	movlw	0xf
+	andwf	0x33, f
+	movf	0x40, w ; add 40(32 old)+33+#1 and skip if carry
+	andlw	0xf
+	addwf	0x33, f
+	incf	0x33, f
+	btfsc	0x33, 4
+	goto	mangle_lock_withskip
+mangle_lock_withoutskip
+	movf	0x41, w ; restore 33
+	addwf	0x34, f ; add to 34
+	movf	0x35, w
+	movwf	0x40	; save 35 to 40
+	movf	0x34, w
+	addwf	0x35, f
+	movf	0x36, w
+	movwf	0x41	; save 36 to 41
+	movf	0x40, w ; restore 35
+	andlw	0xf	; mask nibble
+	addlw	0x8	; add #8 to HIGH nibble
+	movwf	0x40
+	btfss	0x40, 4 ; skip if carry to 5th bit
+	addwf	0x36, w
+	movwf	0x36
+
+	movf	0x41, w ; restore 36
+	addlw	0x1	; inc
+	addwf	0x37, f	; add to 37
+
+	movf	0x37, w ;
+	addlw	0x1	; inc
+	addwf	0x38, f ; add to 38
+
+	movf	0x38, w ;
+	addlw	0x1	; inc
+	addwf	0x39, f ; add to 39
+
+	movf	0x39, w ;
+	addlw	0x1	; inc
+	addwf	0x3a, f ; add to 3a
+
+	movf	0x3a, w ;
+	addlw	0x1	; inc
+	addwf	0x3b, f ; add to 3b
+
+	movf	0x3b, w ;
+	addlw	0x1	; inc
+	addwf	0x3c, f ; add to 3c
+
+	movf	0x3c, w ;
+	addlw	0x1	; inc
+	addwf	0x3d, f ; add to 3d
+
+	movf	0x3d, w ;
+	addlw	0x1	; inc
+	addwf	0x3e, f ; add to 3e
+
+	movf	0x3e, w ;
+	addlw	0x1	; inc
+	addwf	0x3f, f ; add to 3f
+
+	movf	0x30, w ; restore original 0xf
+	andlw	0xf
+	addlw	0xf
+	movwf	0x30
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	nop
+	btfss	0x30, 4 ; skip if half-byte carry
+	goto mangle_return
+	nop
+	goto mangle_lock_loop
+; 69 when goto, 69 when return
+; CIC has 78 -> 9 nops
+	
+mangle_lock_withskip
+	movf	0x41, w ; restore 33
+	addwf	0x33, f ; add to 33
+	movf	0x34, w
+	movwf	0x40	; save 34 to 40
+	movf	0x33, w
+	addwf	0x34, f
+	movf	0x35, w
+	movwf	0x41	; save 35 to 41
+	movf	0x40, w ; restore 34
+	andlw	0xf	; mask nibble
+	addlw	0x8	; add #8 to HIGH nibble
+	movwf	0x40
+	btfss	0x40, 4 ; skip if carry to 5th bit
+	addwf	0x35, w
+	movwf	0x35
+
+	movf	0x41, w ; restore 35
+	addlw	0x1	; inc
+	addwf	0x36, f	; add to 36
+
+	movf	0x36, w ;
+	addlw	0x1	; inc
+	addwf	0x37, f ; add to 37
+
+	movf	0x37, w ;
+	addlw	0x1	; inc
+	addwf	0x38, f ; add to 38
+
+	movf	0x38, w ;
+	addlw	0x1	; inc
+	addwf	0x39, f ; add to 39
+
+	movf	0x39, w ;
+	addlw	0x1	; inc
+	addwf	0x3a, f ; add to 3a
+
+	movf	0x3a, w ;
+	addlw	0x1	; inc
+	addwf	0x3b, f ; add to 3b
+
+	movf	0x3b, w ;
+	addlw	0x1	; inc
+	addwf	0x3c, f ; add to 3c
+
+	movf	0x3c, w ;
+	addlw	0x1	; inc
+	addwf	0x3d, f ; add to 3d
+
+	movf	0x3d, w ;
+	addlw	0x1	; inc
+	addwf	0x3e, f ; add to 3e
+
+	movf	0x3e, w ;
+	addlw	0x1	; inc
+	addwf	0x3f, f ; add to 3f
+
+	movf	0x30, w ; restore original 0xf
+	andlw	0xf
+	addlw	0xf
+	movwf	0x30
+
+	btfss	0x5e, 1
+	goto	scic_pair_skip1
+	btfsc	0x5f, 1
+	goto	scic_pair_skip2
+	btfsc	GPIO, 3
+	goto	scic_pair_skip3
+	goto	supercic_pairmode
+scic_pair_skip1
+	nop
+	nop
+scic_pair_skip2
+	nop
+	nop
+scic_pair_skip3	
+	nop
+	nop
+	nop
+	nop
+
+	btfss	0x30, 4 ; skip if half-byte carry
+	goto mangle_return
+	nop
+	goto mangle_lock_loop
+; 73 when goto, 73 when return
+; CIC has 84 -> 11 nops
+
+; --------wait: 3*(W-1)+7 cycles (including call+return). W=0 -> 256!--------
+wait	
+	movwf	0x4f
+wait0	decfsz	0x4f, f
+	goto	wait0
+	return	
+
+; --------wait long: 8+(3*(w-1))+(772*w). W=0 -> 256!--------
+longwait
+	movwf	0x4e
+	clrw
+longwait0
+	call	wait
+	decfsz	0x4e, f
+	goto	longwait0
+	return
+
+; --------change region in eeprom and die--------
+die
+	banksel	EEADR
+	clrw
+	movwf	EEADR
+	bsf	EECON1, RD
+	movf	EEDAT, w
+	banksel	GPIO
+	movwf	0x4d
+	btfsc	0x4d, 0
+	goto	die_reg_6
+die_reg_9
+	movlw	0x9	; died with PAL, fall back to NTSC
+	goto	die_reg_cont
+die_reg_6
+	movlw	0x6	; died with NTSC, fall back to PAL
+die_reg_cont
+	banksel	EEADR
+	movwf	EEDAT
+	bsf	EECON1, WREN
+
+die_intloop
+	bcf	INTCON, GIE
+	btfsc	INTCON, GIE
+	goto	die_intloop
+	
+	movlw	0x55
+	movwf	EECON2
+	movlw	0xaa
+	movwf	EECON2
+	bsf	EECON1, WR
+	bsf	INTCON, GIE
+
+	banksel	GPIO
+	bcf	GPIO, 4
+; --------get caught up--------
+die_trap
+	goto	die_trap
+; -----------------------------------------------------------------------
+supercic_pairmode
+	banksel	TRISIO
+	bsf	TRISIO, 0
+	bsf	TRISIO, 1
+	banksel	GPIO
+supercic_pairmode_loop
+	bsf	GPIO, 4
+	nop
+	nop
+	bcf	GPIO, 4
+	goto	supercic_pairmode_loop
+
+; eeprom memory
+DEEPROM	CODE
+	de      0x09	; D411 (NTSC)
+end