From 0b39db0b8ec3f7e76bce0d9ca6103dd0ea7441e2 Mon Sep 17 00:00:00 2001 From: Alexey 'Cluster' Avdyukhin Date: Mon, 6 Feb 2017 16:55:46 +0300 Subject: Added clovercon module source code --- clovercon/LICENSE | 339 ++++++++++++++++ clovercon/Makefile | 27 ++ clovercon/clovercon.c | 1030 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 1396 insertions(+) create mode 100644 clovercon/LICENSE create mode 100644 clovercon/Makefile create mode 100644 clovercon/clovercon.c (limited to 'clovercon') diff --git a/clovercon/LICENSE b/clovercon/LICENSE new file mode 100644 index 00000000..d159169d --- /dev/null +++ b/clovercon/LICENSE @@ -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. + + + Copyright (C) + + 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. + + , 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. diff --git a/clovercon/Makefile b/clovercon/Makefile new file mode 100644 index 00000000..ad69f539 --- /dev/null +++ b/clovercon/Makefile @@ -0,0 +1,27 @@ +CURRENT = $(shell uname -r) +TARGET = clovercon +OBJS = clovercon.o +KDIR = linux-nesmini +#KDIR = ~/linux +PWD = $(shell pwd) +DEST = . + +obj-m := $(TARGET).o + +default: + make -C $(KDIR) SUBDIRS=$(PWD) ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- + modinfo $(TARGET).ko + arm-linux-gnueabihf-strip --strip-unneeded $(TARGET).ko + +$(TARGET).o: $(OBJS) + $(LD) $(LD_RFLAG) ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- -r -o $@ $(OBJS) + +install: + su -c "cp -v $(TARGET).ko $(DEST) && /sbin/depmod -a" + +clean: + $(MAKE) -C $(KDIR) SUBDIRS=$(PWD) clean + +.PHONY: modules clean + +-include $(KDIR)/Rules.make diff --git a/clovercon/clovercon.c b/clovercon/clovercon.c new file mode 100644 index 00000000..043b2b9c --- /dev/null +++ b/clovercon/clovercon.c @@ -0,0 +1,1030 @@ +/* -------------------------------------------------------------------------- + * @license_begin + * + * Controllers I2C driver + * Copyright (C) 2016 Nintendo Co. Ltd + * + * 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 + * + * 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. + * + * @license_end + * ----------------------------------------------------------------------- */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +volatile char MAGIC_BUTTONS[] = "MAGIC_BUTTONS:00100100"; +volatile char MAGIC_AUTOFIRE[] = "MAGIC_AUTOFIRE:0"; +volatile char MAGIC_FC_START[] = "MAGIC_FC_START:0"; + +MODULE_AUTHOR("Christophe Aguettaz "); +MODULE_DESCRIPTION("Nintendo Clover/Wii Classic/Wii Pro controllers on I2C"); + +MODULE_LICENSE("GPL"); + +#define DRV_NAME "clovercon" + +#define CLASSIC_ID 0 +#define CONTROLLER_I2C_ADDRESS 0x52 +//Rounded up to multiple of 1/HZ +#define POLL_INTERVAL 5 + +/* HOME button is to be reported only after these many successful polling + * positives. + * Keep it at ~0.1s, adapt whenever POLL_INTERVAL is changed */ +#define HOME_BUTTON_THRESHOLD 15 +#define RESET_COMBINATION_THRESHOLD 50 +#define AUTOFIRE_COMBINATION_THRESHOLD 150 +#define START_COMBINATION_THRESHOLD 150 + +// Need to do some tests to calculate minimal interval +#define AUTOFIRE_INTERVAL 8 + +//Delay expressed in polling intervals +#define RETRY_BASE_DELAY 512 + +#define DATA_FORMAT 3 + +#define DF3_BTN_R 1 +#define DF3_BTN_START 2 +#define DF3_BTN_HOME 3 +#define DF3_BTN_SELECT 4 +#define DF3_BTN_L 5 +#define DF3_BTN_DOWN 6 +#define DF3_BTN_RIGHT 7 + +#define DF3_BTN_UP 0 +#define DF3_BTN_LEFT 1 +#define DF3_BTN_ZR 2 +#define DF3_BTN_X 3 +#define DF3_BTN_A 4 +#define DF3_BTN_Y 5 +#define DF3_BTN_B 6 +#define DF3_BTN_ZL 7 + +#define DEAD_ZONE 20 +#define DIAG_MAX 40 +#define STICK_MAX 72 +#define STICK_FUZZ 4 + +#define TRIGGER_MIN 0 +#define TRIGGER_MAX 0xff +#define TRIGGER_FUZZ 4 + +#define MAX_CON_COUNT 4 + +#define MIN(X, Y) ((X) < (Y) ? (X) : (Y)) +#define MAX(X, Y) ((X) > (Y) ? (X) : (Y)) + +#define CLOVERCON_DETECT_USE_IRQ 0 + +#if CLOVERCON_DETECT_USE_IRQ +#define INVAL_IRQ -1 +#define DETECT_DELAY (HZ / 10) +#else +#define DETECT_DELAY (HZ / 5) +#endif + +#define DEBOUNCE_VALUE 0x71 + +static struct delayed_work detect_work; + +static DEFINE_MUTEX(con_state_lock); +static DEFINE_MUTEX(detect_task_lock); + +#define VERBOSITY 0 + +#if VERBOSITY > 0 + #define ERR(m, ...) printk(KERN_ERR "Clovercon error: " m "\n", ##__VA_ARGS__) + #define INF(m, ...) printk(KERN_INFO "Clovercon info: " m "\n", ##__VA_ARGS__) +#else + #define ERR(m, ...) + #define INF(m, ...) +#endif + +#if VERBOSITY > 1 + #define DBG(m, ...) printk(KERN_DEBUG "Clovercon: " m "\n", ##__VA_ARGS__) + #if VERBOSITY > 2 + #define FAST_ERR(m, ...) ERR(m, ##__VA_ARGS__) + #define FAST_DBG(m, ...) DBG(m, ##__VA_ARGS__) + #else + #define FAST_ERR(m, ...) trace_printk(KERN_ERR "Clovercon error: " m "\n", ##__VA_ARGS__) + #define FAST_DBG(m, ...) trace_printk(KERN_DEBUG "Clovercon: " m "\n", ##__VA_ARGS__) + #endif +#else + #define DBG(m, ...) + #define FAST_ERR(m, ...) + #define FAST_DBG(m, ...) +#endif + +enum ControllerState { + CS_OK, + CS_RETRY_1, + CS_RETRY_2, + CS_ERR +}; + +static bool get_bit(u8 data, int bitnum) { + return (data & (1 << bitnum)) >> bitnum; +} + +static const struct i2c_device_id clovercon_idtable[] = { + { "classic", CLASSIC_ID }, + {} +}; + +MODULE_DEVICE_TABLE(i2c, clovercon_idtable); + +struct clovercon_info { + struct input_polled_dev *dev; + struct i2c_client *client; + struct i2c_adapter *adapter; +#if CLOVERCON_DETECT_USE_IRQ + int irq; +#endif + int detection_active; + int gpio; + int id; + enum ControllerState state; + u16 retry_counter; + int home_counter; + int reset_counter; + int autofire_timer; + int autofire_counter_a; + int autofire_counter_b; + bool autofire_a; + bool autofire_b; + int start_counter; +}; + +static struct clovercon_info con_info_list[MAX_CON_COUNT]; +static int module_params[2 * MAX_CON_COUNT]; +static int arr_argc = 0; + +#define CON_NAME_PREFIX "Nintendo Clovercon - controller" +const char *controller_names[] = {CON_NAME_PREFIX"1", CON_NAME_PREFIX"2", + CON_NAME_PREFIX"3", CON_NAME_PREFIX"4"}; + +module_param_array(module_params, int, &arr_argc, 0000); +MODULE_PARM_DESC(module_params, "Input info in the form con0_i2c_bus, con0_detect_gpio, " + "form con1_i2c_bus, con1_detect_gpio, ... gpio < 0 means no detection"); + +#if CLOVERCON_DETECT_USE_IRQ +struct clovercon_info * clovercon_info_from_irq(int irq) { + int i; + for (i = 0; i < MAX_CON_COUNT; i++) { + if (con_info_list[i].irq == irq) { + return &con_info_list[i]; + } + } + return NULL; +} +#endif + +struct clovercon_info * clovercon_info_from_adapter(struct i2c_adapter *adapter) { + int i; + for (i = 0; i < MAX_CON_COUNT; i++) { + if (con_info_list[i].adapter == adapter) { + return &con_info_list[i]; + } + } + return NULL; +} + +static int clovercon_write(struct i2c_client *client, u8 *data, size_t count) { + struct i2c_msg msg = { + .addr = client->addr, + .len = count, + .buf = data + }; + int ret; + + ret = i2c_transfer(client->adapter, &msg, 1); + if (ret < 0) { + //read and write errors are DBG only to account for normal + //errors coming from disconnects + DBG("write failed with error %i", ret); + return ret; + } else if (ret != 1) { + DBG("incomplete write, return value: %i", ret); + return -EIO; + } + + return 0; +} + +static int clovercon_prepare_read(struct i2c_client *client, u8 address) { + int ret; + + ret = clovercon_write(client, &address, 1); + if (ret) { + DBG("prepare_read failed"); + return ret; + } + + return 0; +} + +static int clovercon_read(struct i2c_client *client, u8 address, u8 *values, size_t count) { + struct i2c_msg data_msg = { + .addr = client->addr, + .flags = I2C_M_RD, + .len = count, + .buf = values + }; + int ret; + + ret = clovercon_prepare_read(client, address); + if (ret) + return ret; + + // Wait > 150µs before prepare_read and actual read + usleep_range(150, 200); + + ret = i2c_transfer(client->adapter, &data_msg, 1); + if (ret < 0) { + DBG("read failed with error %i", ret); + return ret; + } else if (ret != 1) { + DBG("incomplete read, return value: %i", ret); + return -EIO; + } + + return 0; +} + +static int clovercon_read_controller_info(struct i2c_client *client, u8 *data, size_t len) { + int ret; + + len = MIN(len, 0xff -0xfa + 1); + ret = clovercon_read(client, 0xfa, data, len); + if (ret) + return ret; + + return len; + // print_hex_dump(KERN_DEBUG, "Controller info data: " , DUMP_PREFIX_NONE, 16, 256, data, len, false); +} + +static int clovercon_setup(struct i2c_client *client) { + u8 init_data[] = { 0xf0, 0x55, 0xfb, 0x00, 0xfe, DATA_FORMAT }; + static const int CON_INFO_LEN = 6; + u8 con_info_data[CON_INFO_LEN]; + int ret; + + DBG("Clovercon setup"); + + ret = clovercon_write(client, &init_data[0], 2); + if (ret) + goto err; + ret = clovercon_write(client, &init_data[2], 2); + if (ret) + goto err; + ret = clovercon_write(client, &init_data[4], 2); + if (ret) + goto err; + + ret = clovercon_read_controller_info(client, con_info_data, CON_INFO_LEN); + if (ret < 0) { + ERR("error reading controller info"); + goto err; + } else if (ret != CON_INFO_LEN) { + ERR("wrong read length %i reading controller info", ret); + ret = -EIO; + goto err; + } + if (con_info_data[4] != DATA_FORMAT) { + ERR("failed to set data format, value is %i", (int)con_info_data[4]); + ret = -EIO; + goto err; + } + if (con_info_data[5] != 1) { + ERR("unsupported controller id %i", (int)con_info_data[5]); + ret = -EIO; + goto err; + } + + return 0; + +err: + ERR("controller setup failed with error %i", -ret); + return ret; +} + +static void clamp_stick(int *px, int *py) { + int x_sign = 1; + int y_sign = 1; + int x = *px; + int y = *py; + int norm; + + if (x < 0) { + x_sign = -1; + x = -x; + } + if (y < 0) { + y_sign = -1; + y = -y; + } + + x = MAX(0, x - DEAD_ZONE); + y = MAX(0, y - DEAD_ZONE); + + if (x == 0 && y == 0) { + goto clamp_end; + } + + norm = (y <= x) ? (DIAG_MAX * x + (STICK_MAX - DIAG_MAX) * y) : + (DIAG_MAX * y + (STICK_MAX - DIAG_MAX) * x); + + if (DIAG_MAX * STICK_MAX < norm) { + x = DIAG_MAX * STICK_MAX * x / norm; + y = DIAG_MAX * STICK_MAX * y / norm; + } + +clamp_end: + *px = x * x_sign; + *py = y * y_sign; +} + +static void clovercon_poll(struct input_polled_dev *polled_dev) { + struct clovercon_info *info = polled_dev->private; + static const int READ_LEN = 21; + u8 data[READ_LEN]; + int jx, jy, rx, ry, tl, tr; + bool left, right, up, down, a, b, x, y, select, start, home, l, r, zl, zr, reset; + u16 retry_delay = RETRY_BASE_DELAY; + int ret; + bool turbo; + + switch (info->state) { + case CS_OK: + ret = clovercon_read(info->client, 0, data, READ_LEN); + if (ret) { + DBG("read failed for active controller - possible controller disconnect"); + INF("moving controller %i to error state", info->id); + info->state = CS_RETRY_1; + break; + } + + //print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET, 16, 256, data, READ_LEN, false); + + /* The Wii could trust the payload 100% because the Wii Remote + * controller is powered with AA batteries. In the case of + * CLOVER high voltage on DC power supply has shown very noisy + * payloads coming out of the I²C bus. But we don't have any + * checksum or parity bits to discard such corrupted payloads. + * + * However the payload zero padding should be impacted by the + * DC noise and some high bits should pop up there too. + * + * Use that as last resort discarding criteria */ + jy = 0; + for (jx=8; jx<21; jx++) { + jy += data[jx]; + } + if (jy) { + /* noise, discard payload */ + break; + } + + jx = data[0] - 0x80; + rx = data[1] - 0x80; + jy = 0x7fl - data[2]; + ry = 0x7fl - data[3]; + tl = data[4]; + tr = data[5]; + + clamp_stick(&jx, &jy); + clamp_stick(&rx, &ry); + + input_report_abs(polled_dev->input, ABS_X, jx); + input_report_abs(polled_dev->input, ABS_Y, jy); + input_report_abs(polled_dev->input, ABS_RX, rx); + input_report_abs(polled_dev->input, ABS_RY, ry); + input_report_abs(polled_dev->input, ABS_Z, tl); + input_report_abs(polled_dev->input, ABS_RZ, tr); + + r = !get_bit(data[6], DF3_BTN_R); + start = !get_bit(data[6], DF3_BTN_START); + home = !get_bit(data[6], DF3_BTN_HOME); + select = !get_bit(data[6], DF3_BTN_SELECT); + l = !get_bit(data[6], DF3_BTN_L); + down = !get_bit(data[6], DF3_BTN_DOWN); + right = !get_bit(data[6], DF3_BTN_RIGHT); + + up = !get_bit(data[7], DF3_BTN_UP); + left = !get_bit(data[7], DF3_BTN_LEFT); + zr = !get_bit(data[7], DF3_BTN_ZR); + x = !get_bit(data[7], DF3_BTN_X); + y = !get_bit(data[7], DF3_BTN_Y); + a = !get_bit(data[7], DF3_BTN_A); + b = !get_bit(data[7], DF3_BTN_B); + zl = !get_bit(data[7], DF3_BTN_ZL); + + // Reset combination + reset = + ((MAGIC_BUTTONS[14] == '1') ^ !a) && + ((MAGIC_BUTTONS[15] == '1') ^ !b) && + ((MAGIC_BUTTONS[16] == '1') ^ !select) && + ((MAGIC_BUTTONS[17] == '1') ^ !start) && + ((MAGIC_BUTTONS[18] == '1') ^ !up) && + ((MAGIC_BUTTONS[19] == '1') ^ !down) && + ((MAGIC_BUTTONS[20] == '1') ^ !left) && + ((MAGIC_BUTTONS[21] == '1') ^ !right); + + // Start button workaroud for second controller on Famicom + if (MAGIC_FC_START[15] == '1' && info->id == 2) + { + if (a && !select && b && !start && up && !down && !left && !right) + info->start_counter++; + else + info->start_counter = 0; + if (info->start_counter >= START_COMBINATION_THRESHOLD) + start = 1; + } + + // Autofire + if (MAGIC_AUTOFIRE[15] == '1') + { + info->autofire_timer++; + if (info->autofire_timer >= AUTOFIRE_INTERVAL*2) + info->autofire_timer = 0; + turbo = info->autofire_timer / AUTOFIRE_INTERVAL; + + if (a && select && !b && !start && !up && !down && !left && !right) + info->autofire_counter_a++; + else + info->autofire_counter_a = 0; + if (!a && select && b && !start && !up && !down && !left && !right) + info->autofire_counter_b++; + else + info->autofire_counter_b = 0; + + if (info->autofire_counter_a == AUTOFIRE_COMBINATION_THRESHOLD) + info->autofire_a = !info->autofire_a; + if (info->autofire_counter_b == AUTOFIRE_COMBINATION_THRESHOLD) + info->autofire_b = !info->autofire_b; + + if (info->autofire_a && !turbo) a = 0; + if (info->autofire_b && !turbo) b = 0; + + // X and Y on classic controller now are autofire A and B + if (x && turbo) a = 1; + if (y && turbo) b = 1; + x = y = 0; + } + + /* When DC noise is kicking in, we want to avoid the emulator + * switching to the menu supriously because of noisy home button + * events. + * + * Note that even the Mini NES controller can report the event + * even though no physical button is present. The MCU is the + * same as the classic/pro controller. */ + if (home) { + info->home_counter++; + if (info->home_counter>HOME_BUTTON_THRESHOLD) { + info->home_counter = HOME_BUTTON_THRESHOLD; + } + } else { + info->home_counter = 0; + } + if (reset) { + info->reset_counter++; + if (info->reset_counter>RESET_COMBINATION_THRESHOLD) { + info->reset_counter = RESET_COMBINATION_THRESHOLD; + } + } else { + info->reset_counter = 0; + } + + input_report_key(polled_dev->input, BTN_TR, r); + input_report_key(polled_dev->input, BTN_START, start); + input_report_key(polled_dev->input, BTN_MODE, (info->home_counter>=HOME_BUTTON_THRESHOLD) || (info->reset_counter>=RESET_COMBINATION_THRESHOLD)); + input_report_key(polled_dev->input, BTN_SELECT, select); + input_report_key(polled_dev->input, BTN_TL, l); + input_report_key(polled_dev->input, BTN_TRIGGER_HAPPY4, down); + input_report_key(polled_dev->input, BTN_TRIGGER_HAPPY2, right); + input_report_key(polled_dev->input, BTN_TRIGGER_HAPPY3, up); + input_report_key(polled_dev->input, BTN_TRIGGER_HAPPY1, left); + input_report_key(polled_dev->input, BTN_TR2, zr); + input_report_key(polled_dev->input, BTN_X, x); + input_report_key(polled_dev->input, BTN_A, a); + input_report_key(polled_dev->input, BTN_Y, y); + input_report_key(polled_dev->input, BTN_B, b); + input_report_key(polled_dev->input, BTN_TL2, zl); + + input_sync(polled_dev->input); + + break; + case CS_RETRY_1: + retry_delay /= 2; + //fall-through + case CS_RETRY_2: + retry_delay /= 2; + //fall-through + case CS_ERR: + info->retry_counter++; + if (info->retry_counter == retry_delay) { + DBG("retrying controller setup"); + ret = clovercon_setup(info->client); + if (ret) { + info->state = MIN(CS_ERR, info->state + 1); + } else { + info->state = CS_OK; + INF("setup succeeded for controller %i, moving to OK state", info->id); + } + info->retry_counter = 0; + } + break; + default: + info->state = CS_ERR; + } +} + +static void clovercon_open(struct input_polled_dev *polled_dev) { + struct clovercon_info *info = polled_dev->private; + if (clovercon_setup(info->client)) { + info->retry_counter = 0; + info->state = CS_RETRY_1; + INF("opened controller %i, controller in error state after failed setup", info->id); + } else { + info->state = CS_OK; + info->home_counter = 0; + info->reset_counter = 0; + INF("opened controller %i, controller in OK state", info->id); + } +} + +static int clovercon_probe(struct i2c_client *client, const struct i2c_device_id *id) { + struct clovercon_info *info; + struct input_polled_dev *polled_dev; + struct input_dev *input_dev; + int ret = 0; + + switch (id->driver_data) { + case CLASSIC_ID: + DBG("probing classic controller"); + break; + default: + ERR("unknown id: %lu\n", id->driver_data); + return -EINVAL; + } + + mutex_lock(&con_state_lock); + info = clovercon_info_from_adapter(client->adapter); + if (!info) { + ERR("unkonwn client passed to probe"); + mutex_unlock(&con_state_lock); + return -EINVAL; + } + info->client = client; + i2c_set_clientdata(client, info); + mutex_unlock(&con_state_lock); + + polled_dev = input_allocate_polled_device(); + if (!polled_dev) { + ERR("error allocating polled device"); + return -ENOMEM; + } + + info->dev = polled_dev; + + polled_dev->poll_interval = POLL_INTERVAL; + polled_dev->poll = clovercon_poll; + polled_dev->open = clovercon_open; + polled_dev->private = info; + + input_dev = polled_dev->input; + + //change controller_names initializer when changing MAX_CON_COUNT + BUILD_BUG_ON(MAX_CON_COUNT != ARRAY_SIZE(controller_names)); + input_dev->name = controller_names[info->id - 1]; + input_dev->phys = DRV_NAME"/clovercon"; + input_dev->id.bustype = BUS_I2C; + input_dev->dev.parent = &client->dev; + + set_bit(EV_ABS, input_dev->evbit); + set_bit(ABS_X, input_dev->absbit); + set_bit(ABS_Y, input_dev->absbit); + set_bit(ABS_RX, input_dev->absbit); + set_bit(ABS_RY, input_dev->absbit); + /* + L/R are analog on the classic controller, digital + on the pro with values 0 - 0xf8 + */ + set_bit(ABS_Z, input_dev->absbit); + set_bit(ABS_RZ, input_dev->absbit); + + set_bit(EV_KEY, input_dev->evbit); + set_bit(BTN_X, input_dev->keybit); + set_bit(BTN_B, input_dev->keybit); + set_bit(BTN_A, input_dev->keybit); + set_bit(BTN_Y, input_dev->keybit); + set_bit(BTN_TRIGGER_HAPPY3, input_dev->keybit); // up + set_bit(BTN_TRIGGER_HAPPY4, input_dev->keybit); // down + set_bit(BTN_TRIGGER_HAPPY2, input_dev->keybit); // right + set_bit(BTN_TRIGGER_HAPPY1, input_dev->keybit); // left + set_bit(BTN_TR, input_dev->keybit); + set_bit(BTN_TL, input_dev->keybit); + set_bit(BTN_TR2, input_dev->keybit); + set_bit(BTN_TL2, input_dev->keybit); + set_bit(BTN_SELECT, input_dev->keybit); + set_bit(BTN_START, input_dev->keybit); + set_bit(BTN_MODE, input_dev->keybit); + + input_set_abs_params(input_dev, ABS_X, -STICK_MAX, STICK_MAX, STICK_FUZZ, 0); + input_set_abs_params(input_dev, ABS_Y, -STICK_MAX, STICK_MAX, STICK_FUZZ, 0); + input_set_abs_params(input_dev, ABS_RX, -STICK_MAX, STICK_MAX, STICK_FUZZ, 0); + input_set_abs_params(input_dev, ABS_RY, -STICK_MAX, STICK_MAX, STICK_FUZZ, 0); + input_set_abs_params(input_dev, ABS_Z, TRIGGER_MIN, TRIGGER_MAX, TRIGGER_FUZZ, 0); + input_set_abs_params(input_dev, ABS_RZ, TRIGGER_MIN, TRIGGER_MAX, TRIGGER_FUZZ, 0); + + ret = input_register_polled_device(polled_dev); + if (ret) { + ERR("registering polled device failed"); + goto err_register_polled_dev; + } + + INF("probed controller %i", info->id); + + return 0; + +err_register_polled_dev: + input_free_polled_device(polled_dev); + + return ret; +} + +static int clovercon_remove(struct i2c_client *client) { + struct clovercon_info *info; + struct input_polled_dev *polled_dev; + + mutex_lock(&con_state_lock); + info = i2c_get_clientdata(client); + polled_dev = info->dev; + info->dev = NULL; + mutex_unlock(&con_state_lock); + + input_unregister_polled_device(polled_dev); + input_free_polled_device(polled_dev); + + INF("removed controller %i", info->id); + + return 0; +} + +static struct i2c_driver clovercon_driver = { + .driver = { + .name = "clovercon", + .owner = THIS_MODULE, + }, + + .id_table = clovercon_idtable, + .probe = clovercon_probe, + .remove = clovercon_remove, +}; + +static struct i2c_board_info clovercon_i2c_board_info = { + I2C_BOARD_INFO("classic", CONTROLLER_I2C_ADDRESS), +}; + +/* Must be holding con_state_lock */ +int clovercon_add_controller(struct clovercon_info *info) { + struct i2c_client *client; + + mutex_unlock(&con_state_lock); + client = i2c_new_device(info->adapter, &clovercon_i2c_board_info); + mutex_lock(&con_state_lock); + if (!client) { + ERR("could not create i2c device"); + return -ENOMEM; + } + + INF("added device for controller %i", info->id); + return 0; +} + +/* Must be holding con_state_lock */ +void clovercon_remove_controller(struct clovercon_info *info) { + struct i2c_client *client = info->client; + + mutex_unlock(&con_state_lock); + i2c_unregister_device(client); + mutex_lock(&con_state_lock); + info->client = NULL; + + INF("removed device for controller %i", info->id); +} + +static void clovercon_remove_controllers(void) { + int i; + + mutex_lock(&con_state_lock); + for (i = 0; i < arr_argc / 2; i++) { + if (!con_info_list[i].client) { + continue; + } + clovercon_remove_controller(&con_info_list[i]); + } + mutex_unlock(&con_state_lock); +} + +static void clovercon_detect_task(struct work_struct *dummy) { + struct clovercon_info *info; + int i; + int val; + + mutex_lock(&detect_task_lock); + DBG("detect task running"); + mutex_lock(&con_state_lock); + for (i = 0; i < MAX_CON_COUNT; i++) { + info = &con_info_list[i]; + if (!info->detection_active) { + continue; + } + val = gpio_get_value(info->gpio); + DBG("detect pin value: %i", val); + if (val && !info->client) { + DBG("detect task adding controller %i", i); + clovercon_add_controller(info); + } else if (!val && info->client) { + DBG("detect task removing controller %i", i); + clovercon_remove_controller(info); + } + } + mutex_unlock(&con_state_lock); + mutex_unlock(&detect_task_lock); + DBG("detect task done"); +} + +#if CLOVERCON_DETECT_USE_IRQ + +static irqreturn_t clovercon_detect_interrupt(int irq, void* dummy) { + struct clovercon_info *info = clovercon_info_from_irq(irq); + static int initialized = 0; + + if (info == NULL) { + FAST_ERR("could not find controller info associated with irq %i", irq); + return IRQ_HANDLED; + } + + if (initialized == 0) { + INIT_DELAYED_WORK(&detect_work, clovercon_detect_task); + initialized = 1; + } else { + PREPARE_DELAYED_WORK(&detect_work, clovercon_detect_task); + } + + schedule_delayed_work(&detect_work, DETECT_DELAY); + + FAST_DBG("interrupt handler on int %i", irq); + return IRQ_HANDLED; +} + +static int clovercon_setup_irq_detect(struct clovercon_info *info) { + int irq; + int ret; + + ret = gpio_to_irq(info->gpio); + if (ret < 0) { + ERR("gpio to irq failed"); + return ret; + } else { + irq = ret; + DBG("irq for gpio %i: %i", info->gpio, irq); + } + + mutex_lock(&con_state_lock); + info->irq = irq; + info->detection_active = 1; + mutex_unlock(&con_state_lock); + + ret = request_irq(ret, clovercon_detect_interrupt, IRQ_TYPE_EDGE_BOTH, "clovercon", NULL); + if (ret) { + ERR("failed to request irq"); + return ret; + } + + return 0; +} + +static void clovercon_teardown_irq_detect(struct clovercon_info *info) { + free_irq(info->irq, NULL); + mutex_lock(&con_state_lock); + info->detection_active = 0; + info->irq = INVAL_IRQ; + mutex_unlock(&con_state_lock); +} + +#else //CLOVERCON_DETECT_USE_IRQ + +static void clovercon_detect_timer_task(struct work_struct *dummy) { + static int initialized = 0; + + if (initialized == 0) { + INIT_DELAYED_WORK(&detect_work, clovercon_detect_timer_task); + initialized = 1; + } else { + PREPARE_DELAYED_WORK(&detect_work, clovercon_detect_timer_task); + } + + clovercon_detect_task(NULL); + schedule_delayed_work(&detect_work, DETECT_DELAY); +} + +static int clovercon_setup_timer_detect(struct clovercon_info *info) { + static int task_running = 0; + + mutex_lock(&con_state_lock); + info->detection_active = 1; + mutex_unlock(&con_state_lock); + + if (task_running) + return 0; + + task_running = 1; + clovercon_detect_timer_task(NULL); + + return 0; +} + +static void clovercon_teardown_timer_detect(struct clovercon_info *info) { + mutex_lock(&con_state_lock); + info->detection_active = 0; + mutex_unlock(&con_state_lock); +} + +#endif //CLOVERCON_DETECT_USE_IRQ + +static int clovercon_setup_i2c(struct clovercon_info *info, int i2c_bus) { + struct i2c_adapter *adapter; + + adapter = i2c_get_adapter(i2c_bus); + if (!adapter) { + ERR("could not access i2c bus %i", i2c_bus); + return -EINVAL; + } + + info->adapter = adapter; + + return 0; +} + +static int clovercon_setup_detection(struct clovercon_info *info, int gpio_pin) { + int ret; + + ret = gpio_request(gpio_pin, "clovercon_detect"); + if (ret) { + ERR("gpio request failed for pin %i", gpio_pin); + return ret; + } + + ret = gpio_direction_input(gpio_pin); + if (ret) { + ERR("gpio input direction failed"); + goto err_gpio_cleanup; + } + + info->gpio = gpio_pin; + + ret = gpio_set_debounce(gpio_pin, DEBOUNCE_VALUE); + if (ret) { + ERR("failed to debounce gpio %i", gpio_pin); + goto err_gpio_cleanup; + } + +#if CLOVERCON_DETECT_USE_IRQ + info->irq = INVAL_IRQ; + ret = clovercon_setup_irq_detect(info); +#else + ret = clovercon_setup_timer_detect(info); +#endif + + if (ret) { + ERR("controller detection setup failed"); + goto err_detect_cleanup; + } + + return 0; + +err_detect_cleanup: +#if CLOVERCON_DETECT_USE_IRQ + clovercon_teardown_irq_detect(info); +#else + clovercon_teardown_timer_detect(info); +#endif + +err_gpio_cleanup: + gpio_free(gpio_pin); + return ret; +} + +static void clovercon_teardown_detection(void) { + int i; + int gpio; + + cancel_delayed_work_sync(&detect_work); + + for (i = 0; i < MAX_CON_COUNT; i++) { + if (!con_info_list[i].detection_active) { + continue; + } +#if CLOVERCON_DETECT_USE_IRQ + clovercon_teardown_irq_detect(&con_info_list[i]); +#else + clovercon_teardown_timer_detect(&con_info_list[i]); +#endif + mutex_lock(&con_state_lock); + con_info_list[i].adapter = NULL; + gpio = con_info_list[i].gpio; + mutex_unlock(&con_state_lock); + + DBG("Freeing gpio %i", gpio); + gpio_free(gpio); + } +} + +static int __init clovercon_init(void) { + int i2c_bus; + int gpio_pin; + int ret; + int i; + + for (i = 0; i < MAX_CON_COUNT; i++) { + con_info_list[i].detection_active = 0; + con_info_list[i].id = i + 1; + } + + for (i = 0; i < arr_argc / 2; i++) { + i2c_bus = module_params[2 * i]; + gpio_pin = module_params[2 * i + 1]; + + DBG("initializing controller %i on bus %i, gpio %i", i, i2c_bus, gpio_pin); + + ret = clovercon_setup_i2c(&con_info_list[i], i2c_bus); + if (ret) { + ERR("failed to init controller %i", i); + goto err_controller_cleanup; + } + + if (gpio_pin < 0) { + mutex_lock(&con_state_lock); + ret = clovercon_add_controller(&con_info_list[i]); + mutex_unlock(&con_state_lock); + } else { + ret = clovercon_setup_detection(&con_info_list[i], gpio_pin); + if (ret) { + ERR("failed to init controller %i", i); + goto err_controller_cleanup; + } + } + } + + ret = i2c_add_driver(&clovercon_driver); + if (ret) { + ERR("failed to add driver"); + goto err_controller_cleanup; + } + + return 0; + +err_controller_cleanup: + clovercon_teardown_detection(); + clovercon_remove_controllers(); + return ret; +} + +module_init(clovercon_init); + +static void __exit clovercon_exit(void) { + DBG("exit"); + + clovercon_teardown_detection(); + clovercon_remove_controllers(); + i2c_del_driver(&clovercon_driver); +} + +module_exit(clovercon_exit); -- cgit v1.2.3