├── LICENSE
├── NESPlusPlus.ino
└── README.md
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/NESPlusPlus.ino:
--------------------------------------------------------------------------------
1 | /*
2 | * (S)NES Protocol Information:
3 | * - http://www.gamesx.com/controldata/snesdat.htm
4 | * - http://www.gamefaqs.com/snes/916396-super-nintendo/faqs/5395
5 | * - https://kalshagar.wikispaces.com/Around+a+SNES
6 | */
7 |
8 | /*******************************************************************************
9 | * PLATFORM SELECTION
10 | ******************************************************************************/
11 |
12 | /* In all diagrams below, outer numbers are physical pins, inner numbers
13 | * are Arduino pins, using the ATtiny core by DrAzzy:
14 | * https://github.com/SpenceKonde/ATTinyCore
15 | */
16 | #if defined __AVR_ATmega328__ || defined __AVR_ATmega328P__ || defined __AVR_ATmega168__
17 | /*
18 | * Arduino Uno/Nano/Micro/Whatever, use a convenience #define
19 | */
20 | #define ARDUINO328
21 |
22 | /*
23 | * On a full Arduino board all features are supported.
24 | *
25 | * ,-----_-----.
26 | * |1 A5 28|
27 | * |2 0 A4 27|
28 | * |3 1 A3 26|
29 | * |4 2 A2 25| NESRGB Pad 3
30 | * LED Red |5 3 A1 24| NESRGB Pad 2
31 | * CIC Pin 4 |6 4 A0 23| NESRGB Pad 1
32 | * +5V |7 22| GND
33 | * GND |8 21| +5V
34 | * |9 20| +5V
35 | * |10 13 19| Controller Clock
36 | * LED Green |11 5 12 18| Reset In
37 | * LED Blue |12 6 11 17| Controller Data
38 | * Single Led |13 7 10 16| GND (Very important!)
39 | * Reset Out |14 8 9 15| Pad Led (Optional)
40 | * `-----------'
41 | */
42 |
43 | #define PIN_CIC 4
44 | #define PIN_RESET_IN 12 // Since we don't need this as MISO, we can use it as an input
45 | #define PIN_RESET_OUT 8
46 |
47 | #define PIN_NESRGB_PALETTE_1 A0
48 | #define PIN_NESRGB_PALETTE_2 A1
49 | #define PIN_NESRGB_PALETTE_3 A2
50 |
51 | #define PIN_LED_R 3 // PWM
52 | #define PIN_LED_G 5 // PWM
53 | #define PIN_LED_B 6 // PWM
54 | #define PIN_LED_SINGLE 7
55 | #define PIN_LED_PAD 9
56 |
57 | #define ENABLE_SERIAL_DEBUG
58 |
59 | #elif defined __AVR_ATtinyX4__
60 | /*
61 | * On ATtinyX4 we support all features.
62 | *
63 | * Note that ATtiny24A doesn't have enough flash for all features, so
64 | * either use a bigger chip or trim down some features.
65 | *
66 | * ,-----_-----.
67 | * +5V |1 14| GND
68 | * CIC Pin 4 |2 0 10 13| NESRGB Pad 3
69 | * LED Red |3 1 9 12| NESRGB Pad 2
70 | * |4 8 11| NESRGB Pad 1
71 | * LED Green |5 2 7 10| Reset Out
72 | * LED Blue |6 3 6 9| Controller Clock
73 | * Controller Data |7 4 5 8| Reset In
74 | * `-----------'
75 | */
76 | #define PIN_LED_R 1
77 | #define PIN_LED_G 2 // PWM
78 | #define PIN_LED_B 3 // PWM
79 | #define PIN_CIC 0
80 | #define PIN_RESET_IN 5 // This is MISO but is unused as such
81 | #define PIN_RESET_OUT 7
82 | #define PIN_NESRGB_PALETTE_1 8
83 | #define PIN_NESRGB_PALETTE_2 9
84 | #define PIN_NESRGB_PALETTE_3 10
85 |
86 | #elif defined __AVR_ATtinyX5__
87 | /*
88 | * On ATtinyX5 we support Reset-From-Pad and CIC management, both from
89 | * pad and reset button.
90 | *
91 | * ,-----_-----.
92 | * |1 8| +5V
93 | * CIC Pin 4 |2 3 2 7| Controller Clock
94 | * Reset Out |3 4 1 6| Reset In
95 | * GND |4 0 5| Controller Data
96 | * `-----------'
97 | */
98 | #define PIN_CIC 3
99 | #define PIN_RESET_IN 1 // This is MISO but is unused as such
100 | #define PIN_RESET_OUT 4
101 |
102 | #else
103 | #error "Unsupported platform!"
104 | #endif
105 |
106 |
107 | /*******************************************************************************
108 | * BUTTON COMBO SETTINGS
109 | ******************************************************************************/
110 |
111 | // DON'T TOUCH THIS! Just look at it for the button names you can use below!
112 | enum {
113 | BTN_A = 1 << 7,
114 | BTN_B = 1 << 6,
115 | BTN_SELECT = 1 << 5,
116 | BTN_START = 1 << 4,
117 | BTN_UP = 1 << 3,
118 | BTN_DOWN = 1 << 2,
119 | BTN_LEFT = 1 << 1,
120 | BTN_RIGHT = 1 << 0
121 | };
122 |
123 | /* Button combo that enables the other combos
124 | *
125 | * Note: That vertical bar ("pipe") means that the buttons must be pressed
126 | * together.
127 | */
128 | #define COMBO_TRIGGER (BTN_START | BTN_SELECT)
129 |
130 |
131 | /* Button combos to perform other actions. These are to be considered in
132 | * addition to COMBO_TRIGGER.
133 | *
134 | * If you don't need them, just don't #define them.
135 | */
136 | #define COMBO_RESET (BTN_A | BTN_B)
137 | #define COMBO_NEXT_PALETTE BTN_RIGHT
138 | #define COMBO_PREV_PALETTE BTN_LEFT
139 | #define COMBO_NESRGB_OFF BTN_DOWN
140 | #define COMBO_TOGGLE_CIC BTN_UP
141 |
142 |
143 | /*******************************************************************************
144 | * ADVANCED SETTINGS
145 | ******************************************************************************/
146 |
147 | /*******************************************************************************
148 | * WARNING - ACHTUNG - ATTENZIONE - ATTENTION - ATENCION - WAARSCHUWING - UWAGA!
149 | *******************************************************************************
150 | *
151 | * Please BE CAREFUL here, as you risk DESTROYING YOUR NESRGB!
152 | *
153 | * Only proceed if you understand what you are doing!
154 | *
155 | * Our chip works at 5V, while the Altera FPGA on the NESRGB uses 3.3V, so
156 | * we must do some kind of level shifting.
157 | *
158 | * Experience suggests that the NESRGB has internal pull-ups on the palette
159 | * pins, so emulating an open-collector output should allow us to interface
160 | * directly. Basically, to set a pin to 1 we switch the pin to INPUT mode,
161 | * it will go to high impedance mode and the FPGA will see 3.3V because of
162 | * its internal pull-up. To set a pin to 0 we switch the pin to OUTPUT mode.
163 | * The AVR architecture guarantees that the pin will be at the LOW level. If
164 | * you want to use this strategy, leave the following #define COMMENTED.
165 | *
166 | * See http://forum.arduino.cc/index.php?topic=335689.0
167 | *
168 | * Alternatively, proper level shifting can be put in place. Some possibilities:
169 | * - 74LVX125 buffer with 5V-tolerant inputs
170 | * - CD4504BE CMOS-to-CMOS level shifter
171 | * - SparkFun Logic Level Converter: https://www.sparkfun.com/products/12009
172 | * - 2 MOSFETs: http://www.hobbytronics.co.uk/mosfet-voltage-level-converter
173 | * - 2-3 series diodes
174 | * - 3.3V Zener (BZX55C3V3) + series resistor (220 ohm should be fine)
175 | *
176 | * If you have used one of these solutions, UNCOMMENT the following #define, but
177 | * please please please MAKE SURE THAT NO MORE THAN 3.3V ARE PUT ON THE NESRGB
178 | * PALETTE INPUTS!
179 | */
180 | //~ #define USE_LEVEL_SHIFTER
181 |
182 | /* The reset line must be released some time after power is applied, since there
183 | * is a capacitor on it that needs to be charged (milliseconds)
184 | */
185 | //~ #define INITIAL_DELAY 50
186 |
187 | /* Offset in the EEPROM at which the CIC toggle status should be saved. Undefine
188 | * to disable CIC status saving
189 | */
190 | #define CIC_ROM_OFFSET 24
191 |
192 | /* Offset in the EEPROM at which the current mode should be saved. Undefine to
193 | * disable palette saving.
194 | */
195 | #define PALETTE_ROM_OFFSET 42
196 |
197 | // Time to wait before saving changed settings to EEPROM (milliseconds)
198 | #define EEPROM_SAVE_DELAY 5000
199 |
200 |
201 | /* Colors to use to indicate the video mode, in 8-bit RGB componentes. You can
202 | * use any value here if your led is connected to PWM-capable pins, otherwise
203 | * values specified here will be interpreted as either fully off (if 0) or fully
204 | * on (if anything else).
205 | */
206 | //~ #define PALETTE_LED_OFF_COLOR {0xFF, 0xFF, 0xFF} // White
207 | //~ #define PALETTE_LED_NATURAL_COLOR {0xFF, 0xFF, 0x00} // Yellow
208 | //~ #define PALETTE_LED_GARISH_COLOR {0x00, 0xFF, 0xFF} // Light blue
209 | //~ #define PALETTE_LED_IMPROVED_COLOR {0xFF, 0x00, 0xFF} // Purple
210 | #define PALETTE_LED_OFF_COLOR {0x00, 0x00, 0x00}
211 | #define PALETTE_LED_NATURAL_COLOR {0xFF, 0x00, 0x00}
212 | #define PALETTE_LED_GARISH_COLOR {0xFF, 0x00, 0xFF}
213 | #define PALETTE_LED_IMPROVED_COLOR {0x00, 0x00, 0xFF}
214 |
215 | // Define this if your led is common-anode, comment out for common-cathode
216 | //~ #define RGB_LED_COMMON_ANODE
217 |
218 | /* Use a single led to indicate the video mode. This is blinked 1-3 times
219 | * according to which palette is set. This does NOT disable the
220 | * multi-colored led and can be used together with it, provided that you
221 | * have enough pins. Otherwise please disable it manually.
222 | */
223 | //~ #define PIN_LED_SINGLE 3
224 |
225 | /* Debounce duration for the reset button. This might need increasing,
226 | * since NES's and their buttons are old and boooouncy. Note that if you
227 | * do so, you might need to increase DBLCLICK_TIMEOUT as well, for
228 | * double clicks to be detected properly.
229 | */
230 | #define DEBOUNCE_MS 70
231 |
232 | /* Two consecutive presses of the reset button within this amount of
233 | * milliseconds will toggle the CIC chip status.
234 | */
235 | #define DBLCLICK_TIMEOUT 250
236 |
237 | /* Keeping the reset button pressed longer than this amount of
238 | * milliseconds will switch to the next palette, shorter (single)
239 | * presses will reset the console.
240 | */
241 | #define LONGPRESS_LEN 700
242 |
243 | // Duration of the reset pulse (milliseconds)
244 | #define RESET_LEN 250
245 |
246 |
247 | /*******************************************************************************
248 | * FEATURE MACROS
249 | ******************************************************************************/
250 |
251 | /* Feature macros: these get enabled automatically if the pins and other macros
252 | * they depend on are defined above, but can be freely undefined if the feature
253 | * is not desired.
254 | *
255 | * Note that PAD snooping also depends implicitly on hardware SPI, which we
256 | * assume to always be available.
257 | */
258 |
259 | #if defined PIN_RESET_IN && defined PIN_RESET_OUT && \
260 | defined COMBO_TRIGGER && defined COMBO_RESET
261 | #define ENABLE_RESET_FROM_PAD
262 | #endif
263 |
264 | #if defined PIN_NESRGB_PALETTE_1 && defined PIN_NESRGB_PALETTE_2 && \
265 | defined PIN_NESRGB_PALETTE_3 && defined COMBO_TRIGGER && \
266 | (defined COMBO_NEXT_PALETTE || defined COMBO_PREV_PALETTE || \
267 | defined COMBO_NESRGB_OFF)
268 | #define ENABLE_PALETTE_FROM_PAD
269 | #endif
270 |
271 | #if defined COMBO_TRIGGER && defined COMBO_TOGGLE_CIC && defined PIN_CIC
272 | #define ENABLE_CIC_FROM_PAD
273 | #endif
274 |
275 | #if (defined PIN_LED_PAD)
276 | #define ENABLE_PAD_LED
277 | #else
278 | #warning Pad led disabled
279 | #endif
280 |
281 | #if defined PIN_RESET_IN && defined PIN_RESET_OUT && \
282 | defined PIN_NESRGB_PALETTE_1 && defined PIN_NESRGB_PALETTE_2 && \
283 | defined PIN_NESRGB_PALETTE_3
284 | #define ENABLE_PALETTE_FROM_RESET
285 | #endif
286 |
287 | #if defined PIN_RESET_IN && defined PIN_RESET_OUT && defined PIN_CIC
288 | #define ENABLE_CIC_FROM_RESET
289 | #endif
290 |
291 | #if (defined PIN_LED_R || defined PIN_LED_G || defined PIN_LED_B)
292 | #define ENABLE_RGB_LED
293 | #else
294 | #warning RGB led disabled
295 | #endif
296 |
297 | #if (defined PIN_LED_SINGLE)
298 | #define ENABLE_SINGLE_LED
299 | #else
300 | #warning Single led disabled
301 | #endif
302 |
303 | // The following are automagic commodity defines that should not be touched
304 |
305 | // Defined if we need to eavesdrop for gamepad data
306 | #if (defined ENABLE_RESET_FROM_PAD || \
307 | defined ENABLE_PALETTE_FROM_PAD || defined ENABLE_CIC_FROM_PAD)
308 | #define ENABLE_PAD
309 | #else
310 | #warning Pad snooping disabled
311 | #endif
312 |
313 | // Defined if we need to manage the reset line (both IN and OUT)
314 | #if (defined ENABLE_PALETTE_FROM_RESET || \
315 | defined ENABLE_CIC_FROM_RESET || defined ENABLE_RESET_FROM_PAD)
316 | #define ENABLE_RESET
317 | #else
318 | #warning Reset button management disabled
319 | #endif
320 |
321 | // Defined if we need to set the NESRGB palette
322 | #if defined ENABLE_PALETTE_FROM_PAD || defined ENABLE_PALETTE_FROM_RESET
323 | #define ENABLE_PALETTE
324 | #else
325 | #warning Palette control disabled
326 | #endif
327 |
328 | // Defined if we need to control the CIC chip
329 | #if (defined ENABLE_CIC_FROM_PAD || defined ENABLE_CIC_FROM_RESET)
330 | #define ENABLE_CIC
331 | #else
332 | #warning CIC control disabled
333 | #endif
334 |
335 | /*******************************************************************************
336 | * END OF SETTINGS
337 | ******************************************************************************/
338 |
339 |
340 | #ifdef ENABLE_SERIAL_DEBUG
341 | #define debug(...) Serial.print (__VA_ARGS__)
342 | #define debugln(...) Serial.println (__VA_ARGS__)
343 | #warning DEBUG ENABLED
344 | #else
345 | #define debug(...)
346 | #define debugln(...)
347 | #endif
348 |
349 | #if defined CIC_ROM_OFFSET || defined PALETTE_ROM_OFFSET
350 | #include
351 | #endif
352 |
353 | #ifdef ENABLE_PALETTE
354 |
355 | #define PALETTE_POSITIONS 4
356 |
357 | byte palette_led_colors[][PALETTE_POSITIONS] = {
358 | PALETTE_LED_OFF_COLOR,
359 | PALETTE_LED_NATURAL_COLOR,
360 | PALETTE_LED_GARISH_COLOR,
361 | PALETTE_LED_IMPROVED_COLOR
362 | };
363 |
364 | /*
365 | * Palette-Switch Info
366 | * Taken from NESRGB-IGR by Peter Bartmann
367 | * 0 = shorted to ground. 1 = unconnected.
368 | *
369 | * V1.0,1.3
370 | * 123 - PALETTE
371 | * 000 - off <- used by this code
372 | * 001 - off
373 | * 010 - off
374 | * 011 - garish <- used by this code
375 | * 100 - off
376 | * 101 - improved <- used by this code
377 | * 110 - natural <- used by this code
378 | * 111 - off
379 | *
380 | * NESRGB V1.4+
381 | * 123 - PALETTE
382 | * 000 - off <- used by this code
383 | * 001 - off
384 | * 010 - garish
385 | * 011 - garish <- used by this code
386 | * 100 - improved
387 | * 101 - improved <- used by this code
388 | * 110 - natural <- used by this code
389 | * 111 - off
390 | */
391 | byte palette_nesrgb_map[][PALETTE_POSITIONS] = {
392 | {0, 0, 0}, // NESRGB Off
393 | {1, 1, 0}, // Natural
394 | {1, 0, 1}, // Improved
395 | {0, 1, 1} // Garish
396 | };
397 |
398 |
399 | byte palette;
400 | unsigned long palette_last_changed_time;
401 |
402 | // Palette that was is use before NESRGB was turned off
403 | byte palette_before_off;
404 |
405 |
406 | void set_palette_pin (byte pin, byte val) {
407 | #ifdef USE_LEVEL_SHIFTER
408 | /* Proper level shifting is in place (Right???), just switch the pin
409 | * HIGH/LOW as necessary
410 | */
411 | digitalWrite (pin, val);
412 | #else
413 | // Emulate open-collector output
414 | if (val) {
415 | // Make pin hi-Z, pull-up internal to the FPGA will do the rest
416 | pinMode (pin, INPUT);
417 | } else {
418 | // Short pin to ground
419 | pinMode (pin, OUTPUT);
420 | }
421 | #endif
422 | }
423 |
424 | void set_palette (int new_palette, boolean flash = true) {
425 | if (new_palette > PALETTE_POSITIONS)
426 | new_palette = 0;
427 |
428 | debug ("Setting new palette: ");
429 | debugln (new_palette);
430 |
431 | byte *p = palette_nesrgb_map[new_palette];
432 | set_palette_pin (PIN_NESRGB_PALETTE_1, p[0]);
433 | set_palette_pin (PIN_NESRGB_PALETTE_2, p[1]);
434 | set_palette_pin (PIN_NESRGB_PALETTE_3, p[2]);
435 |
436 | palette = new_palette;
437 | led_on ();
438 |
439 | /* Flash single led
440 | * WARNING: This loop must be reasonably shorter than LONGPRESS_LEN
441 | * in the worst case!
442 | */
443 | if (flash) {
444 | #ifdef ENABLE_SINGLE_LED
445 | for (int i = 0; i < palette; ++i) {
446 | digitalWrite (PIN_LED_SINGLE, LOW);
447 | delay (40);
448 | digitalWrite (PIN_LED_SINGLE, HIGH);
449 | delay (80);
450 | }
451 | #endif
452 | }
453 |
454 | palette_last_changed_time = millis ();
455 | }
456 |
457 | void change_palette (int increment) {
458 | // This also loops in [0, PALETTE_POSITIONS) backwards
459 | int new_palette = (palette + increment + PALETTE_POSITIONS) % PALETTE_POSITIONS;
460 | palette_last_changed_time = millis ();
461 | set_palette (new_palette);
462 | }
463 |
464 | void next_palette () {
465 | if (palette == 0) {
466 | // Turn back on with same palette
467 | nesrgb_on_off ();
468 | } else if (palette == PALETTE_POSITIONS - 1) {
469 | // Don't turn off
470 | change_palette (+2);
471 | } else {
472 | change_palette (+1);
473 | }
474 | }
475 |
476 | void prev_palette () {
477 | if (palette == 0) {
478 | nesrgb_on_off ();
479 | } else if (palette == 1) {
480 | change_palette (-2);
481 | } else {
482 | change_palette (-1);
483 | }
484 | }
485 |
486 | void save_palette () {
487 | #ifdef PALETTE_ROM_OFFSET
488 | if (palette_last_changed_time > 0 && millis () - palette_last_changed_time >= EEPROM_SAVE_DELAY) {
489 | debugln ("Saving palette to EEPROM");
490 | byte saved_palette = EEPROM.read (PALETTE_ROM_OFFSET);
491 | if (palette != saved_palette) {
492 | EEPROM.write (PALETTE_ROM_OFFSET, palette);
493 | } else {
494 | debugln ("Palette unchanged, not saving");
495 | }
496 | palette_last_changed_time = 0; // Don't save again
497 |
498 | // Blink led to tell the user that mode was saved
499 | led_off ();
500 | delay (500);
501 | led_on ();
502 | }
503 | #endif
504 | }
505 |
506 | void nesrgb_on_off () {
507 | if (palette == 0) {
508 | // Turn back on, making sure we don't stay off
509 | change_palette (palette_before_off != 0 ? palette_before_off : 1);
510 | palette_before_off = 0;
511 | } else {
512 | // Turn off
513 | palette_before_off = palette;
514 | change_palette (-palette);
515 | }
516 | }
517 |
518 | #endif // ENABLE_PALETTE
519 |
520 |
521 | /* LED legend:
522 | *
523 | * RGB led:
524 | * - Color is set as specified above
525 | * - 1 long flash: Current palette has been saved
526 | * - 6 rapid flashes: CIC disabled
527 | * - 10 rapid flashes: CIC enabled
528 | *
529 | * Single led:
530 | * - All of the above
531 | * - 1 rapid flash: Natural palette selected
532 | * - 2 rapid flashes: Garish palette selected
533 | * - 3 rapid flashes: Improved palette selected
534 | */
535 | void led_off () {
536 | #ifdef ENABLE_RGB_LED
537 | byte c = 0;
538 |
539 | #ifdef RGB_LED_COMMON_ANODE
540 | c = 255 - c;
541 | #endif
542 |
543 | #ifdef PIN_LED_R
544 | analogWrite (PIN_LED_R, c);
545 | #endif
546 |
547 | #ifdef PIN_LED_G
548 | analogWrite (PIN_LED_G, c);
549 | #endif
550 |
551 | #ifdef PIN_LED_B
552 | analogWrite (PIN_LED_B, c);
553 | #endif
554 |
555 | #endif // ENABLE_RGB_LED
556 |
557 | #ifdef ENABLE_SINGLE_LED
558 | digitalWrite (PIN_LED_SINGLE, LOW);
559 | #endif
560 | }
561 |
562 | void led_on () {
563 | #ifdef ENABLE_RGB_LED
564 | byte *colors = palette_led_colors[palette];
565 | byte c;
566 |
567 | #ifdef PIN_LED_R
568 | c = colors[0];
569 | #ifdef RGB_LED_COMMON_ANODE
570 | c = 255 - c;
571 | #endif
572 | analogWrite (PIN_LED_R, c);
573 | #endif
574 |
575 | #ifdef PIN_LED_G
576 | c = colors[1];
577 | #ifdef RGB_LED_COMMON_ANODE
578 | c = 255 - c;
579 | #endif
580 | analogWrite (PIN_LED_G, c);
581 | #endif
582 |
583 | #ifdef PIN_LED_B
584 | c = colors[2];
585 | #ifdef RGB_LED_COMMON_ANODE
586 | c = 255 - c;
587 | #endif
588 | analogWrite (PIN_LED_B, c);
589 | #endif
590 |
591 | #endif // ENABLE_RGB_LED
592 |
593 | #ifdef ENABLE_SINGLE_LED
594 | digitalWrite (PIN_LED_SINGLE, HIGH);
595 | #endif
596 | }
597 |
598 |
599 | #ifdef ENABLE_CIC
600 |
601 | #ifdef CIC_ROM_OFFSET
602 | boolean cic_enabled;
603 | unsigned long cic_last_toggled_time = 0;
604 | #endif
605 |
606 | void save_cic_status () {
607 | #ifdef CIC_ROM_OFFSET
608 | if (cic_last_toggled_time > 0 && millis () - cic_last_toggled_time >= EEPROM_SAVE_DELAY) {
609 | debugln ("Saving CIC status to EEPROM");
610 | byte saved_cicst = EEPROM.read (CIC_ROM_OFFSET);
611 | if (cic_enabled != saved_cicst) {
612 | EEPROM.write (CIC_ROM_OFFSET, cic_enabled);
613 | } else {
614 | debugln ("CIC status unchanged, not saving");
615 | }
616 | cic_last_toggled_time = 0; // Don't save again
617 | }
618 | #endif
619 | }
620 |
621 | void set_cic (boolean enabled, boolean flash = true) {
622 | debug ("Setting CIC status: ");
623 | debugln (enabled ? "ENABLED" : "DISABLED");
624 |
625 | digitalWrite (PIN_CIC, enabled);
626 |
627 | cic_enabled = enabled;
628 |
629 | // Flash leds to signal CIC status: 6 flashes = OFF, 10 = ON
630 | if (flash) {
631 | for (int i = 0; i < (enabled ? 10 : 6); i++) {
632 | led_off ();
633 | delay (40);
634 | led_on ();
635 | delay (80);
636 | }
637 | }
638 |
639 | cic_last_toggled_time = millis ();
640 | }
641 |
642 | void toggle_cic () {
643 | set_cic (!cic_enabled);
644 | }
645 |
646 | #endif // ENABLE_CIC
647 |
648 | #ifdef ENABLE_RESET
649 | enum ResetButtonState {
650 | RST_IDLE, // Button not pressed
651 | RST_1ST_PRESS, // Button pressed first time
652 | RST_WAIT_2ND, // Button released after first press
653 | RST_LONGPRESS, // Button kept pressed at first press
654 | RST_2ND_PRESS, // Button pressed second time
655 | RST_LONG_2ND_PRESS // Button kept pressed at second press
656 | };
657 |
658 | void handle_reset_button () {
659 | static byte pressed_before = LOW, debounce_state = HIGH;
660 | static long last_int = 0, last_pressed = 0, last_released;
661 | static unsigned int hold_cycles = 0;
662 | static ResetButtonState state = RST_IDLE;
663 |
664 | byte reset_pressed_now = digitalRead (PIN_RESET_IN);
665 | if (reset_pressed_now != debounce_state) {
666 | // Reset debouncing timer
667 | last_int = millis ();
668 | debounce_state = reset_pressed_now;
669 | } else if (millis () - last_int > DEBOUNCE_MS) {
670 | // OK, button is stable, see if it has changed
671 | bool just_pressed = reset_pressed_now && !pressed_before;
672 | bool just_released = !reset_pressed_now && pressed_before;
673 |
674 | switch (state) {
675 | case RST_IDLE:
676 | if (just_pressed) {
677 | // Button was just pressed
678 | last_pressed = millis ();
679 | state = RST_1ST_PRESS;
680 | }
681 | break;
682 | case RST_1ST_PRESS:
683 | if (just_released) {
684 | // Button was just released after 1st click
685 | state = RST_WAIT_2ND;
686 | last_released = millis ();
687 | } else if (millis () - last_pressed >= LONGPRESS_LEN) {
688 | /* First long press hit. No need to trigger action
689 | * here, it will be called immediately at the next
690 | * iteration in case RST_LONGPRESS.
691 | */
692 | state = RST_LONGPRESS;
693 | }
694 | break;
695 | case RST_WAIT_2ND:
696 | if (reset_pressed_now) {
697 | // Button quickly pressed twice
698 | last_pressed = millis ();
699 |
700 | state = RST_2ND_PRESS;
701 | } else if (millis () - last_released >= DBLCLICK_TIMEOUT) {
702 | // Double click timeout expired, so this was a single click
703 | debugln ("Reset button clicked");
704 | reset_console ();
705 |
706 | state = RST_IDLE;
707 | }
708 | break;
709 | case RST_LONGPRESS:
710 | if (!reset_pressed_now) {
711 | // Button finally released
712 | state = RST_IDLE;
713 | } else {
714 | // Reset has been held for a while
715 | debugln ("Reset button held");
716 | reset_console_adlibitum ();
717 |
718 | // Remain in this state
719 | }
720 | break;
721 | case RST_2ND_PRESS:
722 | if (just_released) {
723 | // Button released again, so this was a double click
724 | debugln ("Reset button double-clicked");
725 |
726 | #ifdef ENABLE_CIC_FROM_RESET
727 | toggle_cic ();
728 | #endif
729 |
730 | state = RST_IDLE;
731 | } else if (millis () - last_pressed >= LONGPRESS_LEN) {
732 | /* First "long double press" hit. No need to trigger action
733 | * here, it will be called immediately at the next
734 | * iteration in case RST_LONG_2ND_PRESS.
735 | */
736 | hold_cycles = 0;
737 |
738 | state = RST_LONG_2ND_PRESS;
739 | }
740 | break;
741 | case RST_LONG_2ND_PRESS:
742 | if (!reset_pressed_now) {
743 | // Button finally released
744 | state = RST_IDLE;
745 | } else if ((millis () - last_pressed) / LONGPRESS_LEN >= (hold_cycles + 1)) {
746 | // This is a "Long double click"
747 | debugln ("Reset button double-held");
748 | ++hold_cycles;
749 |
750 | #ifdef ENABLE_PALETTE_FROM_RESET
751 | next_palette ();
752 | #endif
753 | // Remain in this state
754 | }
755 | break;
756 | }
757 |
758 | pressed_before = reset_pressed_now;
759 | }
760 | }
761 |
762 | // Resets the console as long as the reset button is pressed
763 | void reset_console_adlibitum () {
764 | debugln ("Resetting console ad libitum");
765 |
766 | disable_pad ();
767 |
768 | digitalWrite (PIN_RESET_OUT, HIGH);
769 | while (digitalRead (PIN_RESET_IN))
770 | ;
771 | digitalWrite (PIN_RESET_OUT, LOW);
772 |
773 | init_pad ();
774 | }
775 |
776 | void reset_console () {
777 | debugln ("Resetting console");
778 |
779 | disable_pad ();
780 |
781 | digitalWrite (PIN_RESET_OUT, HIGH);
782 | delay (RESET_LEN);
783 | digitalWrite (PIN_RESET_OUT, LOW);
784 |
785 | init_pad ();
786 | }
787 | #endif // ENABLE_RESET
788 |
789 |
790 | #ifdef ENABLE_PAD
791 |
792 | #define COMBO_IGNORE_MS LONGPRESS_LEN
793 |
794 | void handle_pad () {
795 | static unsigned long last_combo_time = 0;
796 |
797 | byte pad_status = read_pad ();
798 |
799 | #if 0
800 | debug ("Pad status = ");
801 | debugln (pad_status);
802 | #endif
803 |
804 | #ifdef ENABLE_PAD_LED
805 | digitalWrite (PIN_LED_PAD, pad_status);
806 | #endif
807 |
808 | if ((pad_status & COMBO_TRIGGER) == COMBO_TRIGGER && millis () - last_combo_time > COMBO_IGNORE_MS) {
809 | if (0) {
810 | // Just a code gimmick to allow the #ifdef stuff
811 | #ifdef ENABLE_RESET_FROM_PAD
812 | } else if ((pad_status & COMBO_RESET) == COMBO_RESET) {
813 | debugln ("Reset combo detected");
814 | reset_console ();
815 | pad_status = 0; // Avoid continuous reset (pad_status will keep the last value during reset!)
816 | last_combo_time = millis ();
817 | #endif
818 | #if defined ENABLE_PALETTE_FROM_PAD && defined COMBO_NEXT_PALETTE
819 | } else if ((pad_status & COMBO_NEXT_PALETTE) == COMBO_NEXT_PALETTE) {
820 | debugln ("Next palette combo detected");
821 | next_palette ();
822 | last_combo_time = millis ();
823 | #endif
824 | #if defined ENABLE_PALETTE_FROM_PAD && defined COMBO_PREV_PALETTE
825 | } else if ((pad_status & COMBO_PREV_PALETTE) == COMBO_PREV_PALETTE) {
826 | debugln ("Previous palette combo detected");
827 | prev_palette ();
828 | last_combo_time = millis ();
829 | #endif
830 | #if defined ENABLE_PALETTE_FROM_PAD && defined COMBO_NESRGB_OFF
831 | } else if ((pad_status & COMBO_NESRGB_OFF) == COMBO_NESRGB_OFF) {
832 | debugln ("NESRGB OFF combo detected");
833 | nesrgb_on_off ();
834 | last_combo_time = millis ();
835 | #endif
836 | #ifdef ENABLE_CIC_FROM_PAD
837 | } else if ((pad_status & COMBO_TOGGLE_CIC) == COMBO_TOGGLE_CIC) {
838 | debugln ("CIC toggle combo detected");
839 | toggle_cic ();
840 | last_combo_time = millis ();
841 | #endif
842 | }
843 | }
844 | }
845 |
846 | #endif // ENABLE_PAD
847 |
848 | void setup () {
849 | #ifdef ENABLE_SERIAL_DEBUG
850 | Serial.begin (9600);
851 | #endif
852 |
853 | debugln ("Starting up...");
854 |
855 | // Enable reset
856 | #ifdef ENABLE_RESET
857 | pinMode (PIN_RESET_OUT, OUTPUT);
858 | digitalWrite (PIN_RESET_OUT, HIGH);
859 | pinMode (PIN_RESET_IN, INPUT);
860 | #endif
861 |
862 | // Setup leds
863 | #ifdef PIN_LED_R
864 | pinMode (PIN_LED_R, OUTPUT);
865 | #endif
866 |
867 | #ifdef PIN_LED_G
868 | pinMode (PIN_LED_G, OUTPUT);
869 | #endif
870 |
871 | #ifdef PIN_LED_B
872 | pinMode (PIN_LED_B, OUTPUT);
873 | #endif
874 |
875 | #ifdef ENABLE_SINGLE_LED
876 | pinMode (PIN_LED_SINGLE, OUTPUT);
877 | #endif
878 |
879 | #ifdef ENABLE_PAD_LED
880 | pinMode (PIN_LED_PAD, OUTPUT);
881 | #endif
882 |
883 | // Init palette
884 | #ifdef ENABLE_PALETTE
885 | // Initialize output pins
886 | #ifdef USE_LEVEL_SHIFTER
887 | pinMode (PIN_NESRGB_PALETTE_1, OUTPUT);
888 | pinMode (PIN_NESRGB_PALETTE_2, OUTPUT);
889 | pinMode (PIN_NESRGB_PALETTE_3, OUTPUT);
890 | #else
891 | /* Pins are in input (i.e. high Z) mode by default, so this isn't strictly
892 | * necessary. It's here mainly in case some Arduino core goes crazy and
893 | * changes the initial pin status.
894 | */
895 | pinMode (PIN_NESRGB_PALETTE_1, INPUT);
896 | digitalWrite (PIN_NESRGB_PALETTE_1, LOW); // Even less necessary
897 |
898 | pinMode (PIN_NESRGB_PALETTE_2, INPUT);
899 | digitalWrite (PIN_NESRGB_PALETTE_2, LOW);
900 |
901 | pinMode (PIN_NESRGB_PALETTE_3, INPUT);
902 | digitalWrite (PIN_NESRGB_PALETTE_3, LOW);
903 | #endif
904 |
905 | // NESRGB OFF by default
906 | palette = 0;
907 | palette_before_off = 0;
908 | #ifdef PALETTE_ROM_OFFSET
909 | palette = EEPROM.read (PALETTE_ROM_OFFSET);
910 | debug ("Loaded palette from EEPROM: ");
911 | debugln (palette);
912 | if (palette >= PALETTE_POSITIONS) {
913 | // Palette EEPROM value is out of range
914 | palette = 0;
915 | }
916 | #endif
917 | set_palette (palette, false); // Don't flash at startup
918 | palette_last_changed_time = 0; // No need to save what we just loaded
919 | #endif
920 |
921 | #ifdef ENABLE_CIC
922 | pinMode (PIN_CIC, OUTPUT);
923 |
924 | #ifdef CIC_ROM_OFFSET
925 | cic_enabled = EEPROM.read (CIC_ROM_OFFSET);
926 | debug ("Loaded CIC status from EEPROM: ");
927 | debugln (cic_enabled ? "ENABLED" : "DISABLED");
928 | set_cic (cic_enabled, false);
929 | cic_last_toggled_time = 0;
930 | #endif
931 |
932 | #endif // ENABLE_CIC
933 |
934 | // Prepare to read pad
935 | init_pad ();
936 |
937 | #ifdef ENABLE_RESET
938 | // Finally release the reset line
939 | #ifdef INITIAL_DELAY
940 | delay (INITIAL_DELAY);
941 | #endif
942 | digitalWrite (PIN_RESET_OUT, LOW);
943 | #endif
944 | }
945 |
946 | void loop () {
947 | #ifdef ENABLE_RESET
948 | handle_reset_button ();
949 | #endif
950 |
951 | #ifdef ENABLE_PAD
952 | handle_pad ();
953 | #endif
954 |
955 | #ifdef ENABLE_PALETTE
956 | save_palette ();
957 | #endif
958 |
959 | #ifdef ENABLE_CIC
960 | save_cic_status ();
961 | #endif
962 | }
963 |
964 |
965 | void init_pad () {
966 | #ifdef ARDUINO328
967 | SPDR = 0;
968 |
969 | // Turn on SPI in slave mode, SPI Mode 2
970 | SPCR |= (1 << SPE) | (1 << CPOL);
971 | #elif defined _AVR_ATtinyX4__
972 | // Only setup MOSI pin, no need for MISO
973 | DDRA &= ~((1 << PA6) | (1 << PA4));
974 | #elif defined __AVR_ATtinyX5__
975 | // Ditto
976 | DDRB &= ~((1 << PB2) | (1 << PB0));
977 | #endif
978 |
979 | #if defined __AVR_ATtinyX4__ || defined __AVR_ATtinyX5__
980 | // This is common for all ATtiny's with USI
981 | USIDR = 0;
982 |
983 | USICR = (1 << USIWM0) // USIWM1, USIWM0: Wire Mode
984 | | (1 << USICS1) // USICS1, USICS0: Clock Source Select
985 | | (0 << USICS0) // SPI mode
986 | ;
987 | #endif
988 | }
989 |
990 | byte read_pad () {
991 | static byte pad_status = 0;
992 |
993 | #ifdef ARDUINO328
994 | if (SPSR & (1 << SPIF)) {
995 | pad_status = ~SPDR;
996 | }
997 | #elif defined __AVR_ATtinyX4__ || defined __AVR_ATtinyX5__
998 | if (USISR & (1 << USIOIF)) {
999 | pad_status = ~USIBR; // Use buffer register
1000 |
1001 | // Clear flag
1002 | USISR |= (1 << USIOIF);
1003 | }
1004 | #endif
1005 |
1006 | return pad_status;
1007 | }
1008 |
1009 | void disable_pad () {
1010 | #ifdef ARDUINO328
1011 | SPCR &= ~(1 << SPE);
1012 | SPDR = 0;
1013 | #elif defined __AVR_ATtinyX4__ || defined __AVR_ATtinyX5__
1014 | //~ USICR &= ~((1 << USIWM1) | (1 << USIWM0));
1015 | USICR = 0;
1016 | USISR = (1 << USIOIF);
1017 | #endif
1018 | }
1019 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # NES++
2 |
3 | #### WORK IS IN PROGRESS at the moment, docs will be available soon, please check back...
4 |
5 | **NES++** is a modchip for the **Nintendo Entertainment System** (AKA **NES**). It has the following features:
6 |
7 | - **Reset-From-Pad** (AKA **In-Game-Reset** AKA **IGR**): Press **Select + Start + A + B**.
8 | - **NESRGB on/off toggling and palette switching**:
9 | - Control your NESRGB add-on board: turn it on or off and set your palette of choice from the Player 1 controller pad: Press **Select + Start + Down** to turn it on/off or **Select + Start + Left/Right** to cycle through palettes.
10 | - Alternatively, palettes can be switched through the **Reset button: Keep pushed**.
11 | - The mod is **switchless**, so you don't need to modify the aesthetics of your console installing ugly switches.
12 | - The last used palette is automatically saved and reused at power up.
13 | - Supports a single led, common-anode or common-cathode dual or RGB LEDs to indicate the current mode (Almost any color can be used when PWM pins are available).
14 | - **CIC on/off toggling**: So you want to **play games from a different region**, but you already feel nostalgic for that blinking power led? No problem, just turn your NES's CIC chip on or off at will through the **Reset button**, just quickly **press it twice** or through the Player 1 controller: Press **Select + Start + Up**.
15 | - Uses **cheap *Atmel AVR* microcontrollers**.
16 | - Can be **flashed on different chips** (ATtiny's, ATmega's, or **even a full Arduino** board).
17 | - Even though default settings are recommended, **everything can be customized** to taste.
18 | - Uses the popular **Arduino environment**, allowing for easy development, testing and modifications.
19 | - Last but not least, it is **Open Source and Free Software**!
20 |
21 | *Note that there is also a [NES emulator named nes++](https://sourceforge.net/projects/nespp/), but it is a different project. I chose to use that name in analogy with [my MegaDrive++ project](https://github.com/SukkoPera/MegaDrivePlusPlus), and since the emulator hasn't been update in a while, no confusion should arise.*
22 |
--------------------------------------------------------------------------------