diff options
author | James Young <18669334+noroadsleft@users.noreply.github.com> | 2020-03-15 20:29:11 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-15 20:29:11 -0700 |
commit | b272c035ba7fa8555a88c922b3e94c3f3817c4ff (patch) | |
tree | a5c9a1f6e4a1d9c02b72a12e33b2f9e69b5bf85b /docs/feature_ps2_mouse.md | |
parent | 5f1f370463d818a5283a17001ad832073efc45a4 (diff) |
[Docs] Random Fixes (#8340)
* fix CLI section links in the Summary
* fix heading in Pointing Device doc
* fix headings in PS/2 Mouse Support doc
* add explicit section ids to I2C Master Driver doc
* reformat GPIO Controls table
Much like the I2C Master Driver doc, I found this a bit less than ideal to read. (The table was actually wider than the space available for it.)
Reformatted so each GPIO function is an H3 heading, followed by a paragraph and a table of each architecture's old-style function.
* migrate changes from I2C Master Driver doc to Japanese translation
* add explicit anchors to I2C Master Driver docs
* fix code block language markers
The language markers are case-sensitive; using the wrong case means the syntax highlighting doesn't work.
Good: ```c
Bad: ```C
* restore Japanese I2C Master Driver doc to current master
Can't update the internal tracking references accurately until the changes to the English doc are committed to master.
* add explicit anchors to edited files
* change ChibiOS/ARM to ARM/ChibiOS
Because ARM/ATSAM is also a thing that exists.
* fix code block language markers again
Used the wrong markers in a few spots. Also these are apparently always supposed to be lowercase.
* add section anchors to cli.md
* restore table formatting on GPIO Control doc
* remove changes to _summary.md
Diffstat (limited to 'docs/feature_ps2_mouse.md')
-rw-r--r-- | docs/feature_ps2_mouse.md | 59 |
1 files changed, 30 insertions, 29 deletions
diff --git a/docs/feature_ps2_mouse.md b/docs/feature_ps2_mouse.md index d138967991..ce072fbe93 100644 --- a/docs/feature_ps2_mouse.md +++ b/docs/feature_ps2_mouse.md @@ -1,4 +1,4 @@ -## PS/2 Mouse Support +# PS/2 Mouse Support :id=ps2-mouse-support Its possible to hook up a PS/2 mouse (for example touchpads or trackpoints) to your keyboard as a composite device. @@ -6,7 +6,7 @@ To hook up a Trackpoint, you need to obtain a Trackpoint module (i.e. harvest fr There are three available modes for hooking up PS/2 devices: USART (best), interrupts (better) or busywait (not recommended). -### The Cirtuitry between Trackpoint and Controller +## The Circuitry between Trackpoint and Controller :id=the-circuitry-between-trackpoint-and-controller To get the things working, a 4.7K drag is needed between the two lines DATA and CLK and the line 5+. @@ -24,20 +24,20 @@ MODULE 5+ --------+--+--------- PWR CONTROLLER ``` -### Busywait Version +## Busywait Version :id=busywait-version Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible. In rules.mk: -``` +```makefile PS2_MOUSE_ENABLE = yes PS2_USE_BUSYWAIT = yes ``` In your keyboard config.h: -``` +```c #ifdef PS2_USE_BUSYWAIT # define PS2_CLOCK_PORT PORTD # define PS2_CLOCK_PIN PIND @@ -50,20 +50,20 @@ In your keyboard config.h: #endif ``` -### Interrupt Version +## Interrupt Version :id=interrupt-version The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data. In rules.mk: -``` +```makefile PS2_MOUSE_ENABLE = yes PS2_USE_INT = yes ``` In your keyboard config.h: -``` +```c #ifdef PS2_USE_INT #define PS2_CLOCK_PORT PORTD #define PS2_CLOCK_PIN PIND @@ -88,20 +88,20 @@ In your keyboard config.h: #endif ``` -### USART Version +## USART Version :id=usart-version To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version. In rules.mk: -``` +```makefile PS2_MOUSE_ENABLE = yes PS2_USE_USART = yes ``` In your keyboard config.h: -``` +```c #ifdef PS2_USE_USART #define PS2_CLOCK_PORT PORTD #define PS2_CLOCK_PIN PIND @@ -145,13 +145,13 @@ In your keyboard config.h: #endif ``` -### Additional Settings +## Additional Settings :id=additional-settings -#### PS/2 Mouse Features +### PS/2 Mouse Features :id=ps2-mouse-features These enable settings supported by the PS/2 mouse protocol. -``` +```c /* Use remote mode instead of the default stream mode (see link) */ #define PS2_MOUSE_USE_REMOTE_MODE @@ -170,7 +170,7 @@ These enable settings supported by the PS/2 mouse protocol. You can also call the following functions from ps2_mouse.h -``` +```c void ps2_mouse_disable_data_reporting(void); void ps2_mouse_enable_data_reporting(void); @@ -188,36 +188,36 @@ void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution); void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate); ``` -#### Fine Control +### Fine Control :id=fine-control Use the following defines to change the sensitivity and speed of the mouse. Note: you can also use `ps2_mouse_set_resolution` for the same effect (not supported on most touchpads). -``` +```c #define PS2_MOUSE_X_MULTIPLIER 3 #define PS2_MOUSE_Y_MULTIPLIER 3 #define PS2_MOUSE_V_MULTIPLIER 1 ``` -#### Scroll Button +### Scroll Button :id=scroll-button If you're using a trackpoint, you will likely want to be able to use it for scrolling. It's possible to enable a "scroll button/s" that when pressed will cause the mouse to scroll instead of moving. To enable the feature, you must set a scroll button mask as follows: -``` +```c #define PS2_MOUSE_SCROLL_BTN_MASK (1<<PS2_MOUSE_BUTTON_MIDDLE) /* Default */ ``` To disable the scroll button feature: -``` +```c #define PS2_MOUSE_SCROLL_BTN_MASK 0 ``` The available buttons are: -``` +```c #define PS2_MOUSE_BTN_LEFT 0 #define PS2_MOUSE_BTN_RIGHT 1 #define PS2_MOUSE_BTN_MIDDLE 2 @@ -229,27 +229,28 @@ Once you've configured your scroll button mask, you must configure the scroll bu This is the interval before which if the scroll buttons were released they would be sent to the host. After this interval, they will cause the mouse to scroll and will not be sent. -``` +```c #define PS2_MOUSE_SCROLL_BTN_SEND 300 /* Default */ ``` To disable sending the scroll buttons: -``` + +```c #define PS2_MOUSE_SCROLL_BTN_SEND 0 ``` Fine control over the scrolling is supported with the following defines: -``` +```c #define PS2_MOUSE_SCROLL_DIVISOR_H 2 #define PS2_MOUSE_SCROLL_DIVISOR_V 2 ``` -#### Invert Mouse and Scroll Axes +### Invert Mouse and Scroll Axes :id=invert-mouse-and-scroll-axes To invert the X and Y axes you can put: -``` +```c #define PS2_MOUSE_INVERT_X #define PS2_MOUSE_INVERT_Y ``` @@ -258,18 +259,18 @@ into config.h. To reverse the scroll axes you can put: -``` +```c #define PS2_MOUSE_INVERT_H #define PS2_MOUSE_INVERT_V ``` into config.h. -#### Debug Settings +### Debug Settings :id=debug-settings To debug the mouse, add `debug_mouse = true` or enable via bootmagic. -``` +```c /* To debug the mouse reports */ #define PS2_MOUSE_DEBUG_HID #define PS2_MOUSE_DEBUG_RAW |