ISSI31FL3733 driver (#3679)

* ISSI31FL3733 driver

- Addapted IS31 driver for the above driver

* fix my branch

* ISSI31FL3733 driver

- Inclusion of above ISSI led driver

* IS31fl3733 driver

- Added correct function for control registers

* Finalized support for ISSI31fl3733 led driver

- Finalized and tested driver.
- Modified i2c_master for arm due to declaration mistake.
- Fixed spaces/tabs in quantum.h file.
- Fixed spaces/tabs in common_features.mk file.
- Removed unnecessary includes from rgb_matrix.c file.
- Added local definitions for MIN and MAX macros in rgb_matrix.c file.
- Adjusted chevron effect.
- Added necessary define (RGB_3733_MATRIX_ENABLE) for makefile.
- Added necessary C define (ISSI3733) to aid with inclusion of the correct header file.
- Added documentation for the new driver.

* Driver structure update

- Changed rule includes to be more condensed (RGB_MATRIX_ENABLE = IS31FL3731) and (RGB_MATRIX_ENABLE = IS31FL3733)
- Updated documentation
- Reverted to the use of differently named functions for each driver and selecting the needed ones within rgb_matrix.c

* ISSI Drivers refractoring

- Moved issi drivers in a dedicated folder
- Updated documentation

* I2C library fix

I released the special pins incorrectly before. It is now fixed.

3 files changed, 80 insertions, 36 deletions

diff --git a/quantum/quantum.h b/quantum/quantum.h
index 1db9846f04..b4e4de1743 100644
--- a/quantum/quantum.h
+++ b/quantum/quantum.h
@@ -28,7 +28,7 @@
     #include "backlight.h"
 #endif
 #if !defined(RGBLIGHT_ENABLE) && !defined(RGB_MATRIX_ENABLE)
-	#include "rgb.h"
+    #include "rgb.h"
 #endif
 #ifdef RGBLIGHT_ENABLE
   #include "rgblight.h"
@@ -39,7 +39,7 @@
 #endif
 
 #ifdef RGB_MATRIX_ENABLE
-	#include "rgb_matrix.h"
+    #include "rgb_matrix.h"
 #endif
 
 #include "action_layer.h"
@@ -58,78 +58,78 @@
 extern uint32_t default_layer_state;
 
 #ifndef NO_ACTION_LAYER
-	extern uint32_t layer_state;
+    extern uint32_t layer_state;
 #endif
 
 #ifdef MIDI_ENABLE
 #ifdef MIDI_ADVANCED
-	#include "process_midi.h"
+    #include "process_midi.h"
 #endif
 #endif // MIDI_ENABLE
 
 #ifdef AUDIO_ENABLE
-	#include "audio.h"
- 	#include "process_audio.h"
+    #include "audio.h"
+    #include "process_audio.h"
   #ifdef AUDIO_CLICKY
     #include "process_clicky.h"
   #endif // AUDIO_CLICKY
 #endif
 
 #ifdef STENO_ENABLE
-	#include "process_steno.h"
+    #include "process_steno.h"
 #endif
 
 #if defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
-	#include "process_music.h"
+    #include "process_music.h"
 #endif
 
 #ifndef DISABLE_LEADER
-	#include "process_leader.h"
+    #include "process_leader.h"
 #endif
 
 #define DISABLE_CHORDING
 #ifndef DISABLE_CHORDING
-	#include "process_chording.h"
+    #include "process_chording.h"
 #endif
 
 #ifdef UNICODE_ENABLE
-	#include "process_unicode.h"
+    #include "process_unicode.h"
 #endif
 
 #ifdef UCIS_ENABLE
-	#include "process_ucis.h"
+    #include "process_ucis.h"
 #endif
 
 #ifdef UNICODEMAP_ENABLE
-	#include "process_unicodemap.h"
+    #include "process_unicodemap.h"
 #endif
 
 #include "process_tap_dance.h"
 
 #ifdef PRINTING_ENABLE
-	#include "process_printer.h"
+    #include "process_printer.h"
 #endif
 
 #ifdef AUTO_SHIFT_ENABLE
-	#include "process_auto_shift.h"
+    #include "process_auto_shift.h"
 #endif
 
 #ifdef COMBO_ENABLE
-	#include "process_combo.h"
+    #include "process_combo.h"
 #endif
 
 #ifdef KEY_LOCK_ENABLE
-	#include "process_key_lock.h"
+    #include "process_key_lock.h"
 #endif
 
 #ifdef TERMINAL_ENABLE
-	#include "process_terminal.h"
+    #include "process_terminal.h"
 #else
-	#include "process_terminal_nop.h"
+    #include "process_terminal_nop.h"
 #endif
 
 #ifdef HD44780_ENABLE
-	#include "hd44780.h"
+    #include "hd44780.h"
 #endif
 
 #define STRINGIZE(z) #z
diff --git a/quantum/rgb_matrix.c b/quantum/rgb_matrix.c
index 70ad1a1783..197bc1ac5e 100644
--- a/quantum/rgb_matrix.c
+++ b/quantum/rgb_matrix.c
@@ -1,5 +1,6 @@
 /* Copyright 2017 Jason Williams
  * Copyright 2017 Jack Humbert
+ * Copyright 2018 Yiancar
  *
  * 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
@@ -17,18 +18,22 @@
 
 
 #include "rgb_matrix.h"
-#include <avr/io.h>
 #include "i2c_master.h"
-#include <util/delay.h>
-#include <avr/interrupt.h>
 #include "progmem.h"
 #include "config.h"
 #include "eeprom.h"
-#include "lufa.h"
 #include <math.h>
 
 rgb_config_t rgb_matrix_config;
 
+#ifndef MAX
+    #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
+#endif
+
+#ifndef MIN
+    #define MIN(a,b) ((a) < (b)? (a): (b))
+#endif
+
 #ifndef RGB_DISABLE_AFTER_TIMEOUT
     #define RGB_DISABLE_AFTER_TIMEOUT 0
 #endif
@@ -106,16 +111,29 @@ void map_row_column_to_led( uint8_t row, uint8_t column, uint8_t *led_i, uint8_t
 }
 
 void rgb_matrix_update_pwm_buffers(void) {
-    IS31_update_pwm_buffers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
-    IS31_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+#ifdef IS31FL3731
+    IS31FL3731_update_pwm_buffers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+    IS31FL3731_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+#elif defined(IS31FL3733)
+    IS31FL3733_update_pwm_buffers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+    IS31FL3733_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+#endif
 }
 
 void rgb_matrix_set_color( int index, uint8_t red, uint8_t green, uint8_t blue ) {
-    IS31_set_color( index, red, green, blue );
+#ifdef IS31FL3731
+    IS31FL3731_set_color( index, red, green, blue );
+#elif defined(IS31FL3733)
+    IS31FL3733_set_color( index, red, green, blue );
+#endif
 }
 
 void rgb_matrix_set_color_all( uint8_t red, uint8_t green, uint8_t blue ) {
-    IS31_set_color_all( red, green, blue );
+#ifdef IS31FL3731
+    IS31FL3731_set_color_all( red, green, blue );
+#elif defined(IS31FL3733)
+    IS31FL3733_set_color_all( red, green, blue );
+#endif
 }
 
 bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record) {
@@ -460,7 +478,7 @@ void rgb_matrix_rainbow_moving_chevron(void) {
     for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
         led = g_rgb_leds[i];
         // uint8_t r = g_tick;
-        uint8_t r = 32;
+        uint8_t r = 128;
         hsv.h = (1.5 * (rgb_matrix_config.speed == 0 ? 1 : rgb_matrix_config.speed)) * abs(led.point.y - 32.0)* sin(r * PI / 128) + (1.5 * (rgb_matrix_config.speed == 0 ? 1 : rgb_matrix_config.speed)) * (led.point.x - (g_tick / 256.0 * 224)) * cos(r * PI / 128) + rgb_matrix_config.hue;
         rgb = hsv_to_rgb( hsv );
         rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
@@ -752,16 +770,28 @@ void rgb_matrix_init(void) {
 void rgb_matrix_setup_drivers(void) {
   // Initialize TWI
   i2c_init();
-  IS31_init( DRIVER_ADDR_1 );
-  IS31_init( DRIVER_ADDR_2 );
+#ifdef IS31FL3731
+  IS31FL3731_init( DRIVER_ADDR_1 );
+  IS31FL3731_init( DRIVER_ADDR_2 );
+#elif defined (IS31FL3733)
+  IS31FL3733_init( DRIVER_ADDR_1 );
+#endif
 
   for ( int index = 0; index < DRIVER_LED_TOTAL; index++ ) {
     bool enabled = true;
     // This only caches it for later
-    IS31_set_led_control_register( index, enabled, enabled, enabled );
+#ifdef IS31FL3731
+    IS31FL3731_set_led_control_register( index, enabled, enabled, enabled );
+#elif defined (IS31FL3733)
+    IS31FL3733_set_led_control_register( index, enabled, enabled, enabled );
+#endif
   }
   // This actually updates the LED drivers
-  IS31_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+#ifdef IS31FL3731
+  IS31FL3731_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+#elif defined (IS31FL3733)
+  IS31FL3733_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
+#endif
 }
 
 // Deals with the messy details of incrementing an integer
@@ -811,11 +841,19 @@ void rgb_matrix_test_led( uint8_t index, bool red, bool green, bool blue ) {
     {
         if ( i == index )
         {
-            IS31_set_led_control_register( i, red, green, blue );
+#ifdef IS31FL3731
+            IS31FL3731_set_led_control_register( i, red, green, blue );
+#elif defined (IS31FL3733)
+            IS31FL3733_set_led_control_register( i, red, green, blue );
+#endif
         }
         else
         {
-            IS31_set_led_control_register( i, false, false, false );
+#ifdef IS31FL3731
+            IS31FL3731_set_led_control_register( i, false, false, false );
+#elif defined (IS31FL3733)
+            IS31FL3733_set_led_control_register( i, false, false, false );
+#endif
         }
     }
 }
diff --git a/quantum/rgb_matrix.h b/quantum/rgb_matrix.h
index 5769314002..b91c9fba59 100644
--- a/quantum/rgb_matrix.h
+++ b/quantum/rgb_matrix.h
@@ -1,5 +1,6 @@
 /* Copyright 2017 Jason Williams
  * Copyright 2017 Jack Humbert
+ * Copyright 2018 Yiancar
  *
  * 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
@@ -21,9 +22,14 @@
 #include <stdint.h>
 #include <stdbool.h>
 #include "color.h"
-#include "is31fl3731.h"
 #include "quantum.h"
 
+#ifdef IS31FL3731
+    #include "is31fl3731.h"
+#elif defined (IS31FL3733)
+    #include "is31fl3733.h"
+#endif
+
 typedef struct Point {
 	uint8_t x;
 	uint8_t y;