mouse.h File Reference

Mouse protocol implementation. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
union	_mouse_movt
	Mouse movement packet as sent in streaming mode. 3 bytes. More...
struct	_decoded_movt
	Decoded mouse movement: signed dx and dy, buttons state. More...
Defines
#define	_MOUSE_H
#define	YOVERFLOW   7
	These are the bits in 1st byte of 3-byte position packet.
#define	XOVERFLOW   6
	X counter overflow.
#define	YSIGN   5
	Y counter sign.
#define	XSIGN   4
	X counter sign.
#define	BUTTON3   2
	middle button
#define	BUTTON2   1
	right button
#define	BUTTON1   0
	left button
Typedefs
typedef union _mouse_movt	MouseMovt
	Mouse movement packet as sent in streaming mode. 3 bytes.
typedef struct _decoded_movt	DecodedMovt
	Decoded mouse movement: signed dx and dy, buttons state.
Enumerations
enum	_mouse_commands {   MOUSE_RESET = 0xff, MOUSE_RESEND = 0xfe, MOUSE_SETDEFAULTS = 0xf6, MOUSE_DDR = 0xf5,   MOUSE_EDR = 0xf4, MOUSE_SSR = 0xf3, MOUSE_GETID = 0xf2, MOUSE_SETREMOTE = 0xf0,   MOUSE_SETWRAP = 0xee, MOUSE_RESETWRAP = 0xec, MOUSE_READDATA = 0xeb, MOUSE_SETSTREAM = 0xea,   MOUSE_STATUSRQ = 0xe9, MOUSE_SETRES = 0xe8, MOUSE_SETSCALE21 = 0xe7, MOUSE_SETSCALE11 = 0xe6 }
	Mouse command codes. More...
enum	_mouse_response { MOUSE_ACK = 0xfa, MOUSE_NAK = 0xfe, MOUSE_ERROR = 0xfc, MOUSE_RESETOK = 0xaa }
	Mouse response codes. More...
Functions
uint8_t	mouse_boot ()
	Boot mouse, check and return initial button state.
void	mouse_setres (uint8_t res)
	Set mouse resolution.

---

Detailed Description

Mouse protocol implementation.

---

Define Documentation

#define _MOUSE_H

#define BUTTON1   0

left button

#define BUTTON2   1

right button

#define BUTTON3   2

middle button

#define XOVERFLOW   6

X counter overflow.

#define XSIGN   4

X counter sign.

#define YOVERFLOW   7

These are the bits in 1st byte of 3-byte position packet.

Y counter overflow

#define YSIGN   5

Y counter sign.

---

Typedef Documentation

typedef struct _decoded_movt DecodedMovt

Decoded mouse movement: signed dx and dy, buttons state.

typedef union _mouse_movt MouseMovt

Mouse movement packet as sent in streaming mode. 3 bytes.

---

Enumeration Type Documentation

enum _mouse_commands

Mouse command codes.

Enumerator:

MOUSE_RESET	reset mouse
MOUSE_RESEND	mouse, wtf?
MOUSE_SETDEFAULTS	set defaults
MOUSE_DDR	disable data reporting
MOUSE_EDR	enable data reporting
MOUSE_SSR	set sample rate: mouse responds ACK, then reads one byte arg
MOUSE_GETID	get device id
MOUSE_SETREMOTE	set remote mode
MOUSE_SETWRAP	set wrap mode
MOUSE_RESETWRAP	switch back to previous (remote or stream) mode
MOUSE_READDATA	request data in remote mode
MOUSE_SETSTREAM	set stream mode (continuous reporting)
MOUSE_STATUSRQ	status request
MOUSE_SETRES	set resolution
MOUSE_SETSCALE21	set scaling 2:1
MOUSE_SETSCALE11	set scaling 1:1

                     {
    MOUSE_RESET = 0xff,             
    MOUSE_RESEND = 0xfe,            
    MOUSE_SETDEFAULTS = 0xf6,       
    MOUSE_DDR = 0xf5,               
    MOUSE_EDR = 0xf4,               
    MOUSE_SSR = 0xf3,               
    MOUSE_GETID = 0xf2,             
    MOUSE_SETREMOTE = 0xf0,         
    MOUSE_SETWRAP = 0xee,           
    MOUSE_RESETWRAP = 0xec,         
    MOUSE_READDATA = 0xeb,          
    MOUSE_SETSTREAM = 0xea,         
    MOUSE_STATUSRQ = 0xe9,          
    MOUSE_SETRES = 0xe8,            
    MOUSE_SETSCALE21 = 0xe7,        
    MOUSE_SETSCALE11 = 0xe6,        
};

enum _mouse_response

Mouse response codes.

Enumerator:

MOUSE_ACK	agreeable mouse
MOUSE_NAK	disagreeable mouse
MOUSE_ERROR	mouse error
MOUSE_RESETOK	post-reset self test passed

                     {
    MOUSE_ACK = 0xfa,               
    MOUSE_NAK = 0xfe,               
    MOUSE_ERROR = 0xfc,             
    MOUSE_RESETOK = 0xaa,           
};

---

Function Documentation

uint8_t mouse_boot

(

)

Boot mouse, check and return initial button state.

Returns:

initial button status (bits 2,1,0 == left,middle,right)

                     {
    uint8_t buttons = 0;
    
    ps2_enable_recv(1);

    for(;;) {
        printf_P(PSTR("\nRESET: "));
        if (mouse_reset() == 0) {
            puts_P(PSTR_OK);
            break;
        } else {
            puts_P(PSTR_ERROR);
        }
    }

    mouse_command(MOUSE_DDR, 1);
    mouse_command(MOUSE_SETSCALE21, 1);
    
    mouse_command(MOUSE_SETRES, 1);
    mouse_command(1,1);             // 0 = 1, 1 = 2, 2 = 4, 3 = 8 counts/mm

    mouse_command(MOUSE_STATUSRQ, 1);
    tdelay(22);
    if (ps2_avail()) buttons = ps2_getbyte() & 7;
    
    mouse_flush(22);
    
    printf_P(PSTR("B:%x\n"), buttons);

    mouse_command(MOUSE_EDR, 1);

    mouse_flush(100);

    printf_P(PSTR("\n"));
    
    return buttons;    
}

Here is the call graph for this function:

void mouse_setres

(

uint8_t

res

)

Set mouse resolution.

Parameters:

res

resolution code 0: 1 count per mm 1: 2 counts per mm 2: 4 counts per mm 3: 8 counts per mm

                               {
    mouse_command(MOUSE_DDR,1);
    
    mouse_command(MOUSE_SETRES, 1);
    mouse_command(res, 1);             // 0 = 1, 1 = 2, 2 = 4, 3 = 8 counts/mm
    
    mouse_command(MOUSE_EDR,1);
}

Here is the call graph for this function: