generic PSP IR Keyboard library now in SVN

monsti · Post by **monsti** » Sun Mar 04, 2007 3:37 am

Hi everybody,

the generic PSP IR Keyboard library hosted at http://pspirkeyb.podzone.net is now in PSP svn.

svn://svn.pspdev.org/psp/trunk/pspirkeyb

Please add support to your IR keyboards if you have one :)

Bye.
Monsti

harleyg · Post by **harleyg** » Sun Mar 04, 2007 3:45 am

Nice, will be using this soon. :)

monsti · Post by **monsti** » Sun Mar 04, 2007 3:59 am

harleyg wrote:Nice, will be using this soon. :)

I think we'll need a prx version to allow applications adding new keyboards without recompiling.

harleyg · Post by **harleyg** » Sun Mar 04, 2007 4:58 am

Why not read keymaps etc from files?

monsti · Post by **monsti** » Sun Mar 04, 2007 5:58 am

harleyg wrote:Why not read keymaps etc from files?

Keymaps are already read by files. I am speaking of creating a PRX based api - a kind of "driver" concept. New pspirkeyb.prx versions can support more keyboards.

IR Keyboards are no linear "IR byte" to "key" mapping. Every keyboard has it's own protocol :(

So it might be a good idea to make a prx and let the user replace the prx without the need of recompiling the application.

Monsti

monsti · Post by **monsti** » Tue Mar 06, 2007 12:34 am

Hi!

I added a PRX version for pspirkeyb. My intension is to create a prx frontent to the static lib in order to allow a dynamic change for applications using PSP IrKeyb.

But... I can't load the prx. Can somebody please have a look at the sources?

danzel · Post by **danzel** » Tue Mar 13, 2007 5:02 pm

I'm looking at integrating this into an app.

How do you set the files up on your memory stick? It looks like it should be as follows:

Code: Select all

ms0&#58;/seplugins/pspirkeyb.ini
ms0&#58;/seplugins/keymap/default.ini
ms0&#58;/seplugins/keymap/azert-include.ini
<repeat for other keymaps>

Just asking as it isn't documented anywhere from what I've seen.

Also, I take it that the list of keyboards in pspirkeyb/libpspirkeyb/config/pspirkeyb.ini is correct and up to date? Will go get a keyboard tomorrow if I can find one.

harleyg · Post by **harleyg** » Tue Mar 13, 2007 5:54 pm

They should be customizable danzel, look at the defines.

danzel · Post by **danzel** » Tue Mar 13, 2007 6:14 pm

It would be better to have a standard, then other apps using it don't need to duplicate files around the place.

futaris · Post by **futaris** » Fri Mar 23, 2007 6:01 pm

I've got a Thinkoutside / iGo 4-row Stowaway, that uses the same protocol as the Palm UW keyboard, but has a different physical row/col keymap to the Palm UW.

http://www.thinkoutside.com/products/el ... oduct.html

What's the best way to add this to this driver? I don't want to duplicate code, and the protocol is well documented on the thinkoutside website - http://www.thinkoutside.com/developer/developer.html

in this ZIP:
http://www.thinkoutside.com/developer/devkit20.zip

NB, I also have a 5-row visor keyboard that uses the keymap documented in:
http://www.thinkoutside.com/developer/DK110.zip

I'd like to add a driver for this too, but does it belong in this or just in PiKey?

futaris · Post by **futaris** » Fri Mar 23, 2007 6:50 pm

I did a quick hack of tydopad to confirm keymaps. It's definitely right, but we may need to handle more Shift/Fn-keys, somehow. This keyboard has a Blue Fn key, a Green Fn-Key and the standard shift key. This is mainly because it has no number row. Look inside the above mentioned devkit20.zip to see what I mean.

http://files.futaris.org/psp/tydopad/

I'll do up a keymap for pspirkeyb once we figure out how to integrate it "nicely", especially for the extra Fn-modes, to handle the number row, etc.

Otherwise, does anyone have any objections to me "fixing" the current code for the Palm UW keyboard driver?

tyranos · Post by **tyranos** » Sat Mar 24, 2007 3:15 am

futaris i successfully build a driver for my keyboard thx to monsti s help ,
and to make the numbers work u just have to have the code for the fn funktion in the keymap ,everyting else should be done in the ini files of pspirkeyb , and if it works with pspirkeyb , it s likely gonna work with pikey but u d need to recompile it urself , all u habe to do is to read the README.ADDING.KEYBOARDS in libpspirkeyb , or pm me maybe i can help

futaris · Post by **futaris** » Sat Mar 24, 2007 7:25 am

I have no problem adding the keyboard driver. It's the Fn code stuff. Most keyboards are 5-row, with a number row. Most don't have F1-F12. These are done with Fn-Keys.

My Keyboard is 4-rows. It doesn't have a number row. If you want the symbol &, you must push Shift+Fn+U. Also there is a num-lock key, etc. My Logitech keyboard has a F mode key for the Function keys.

I can see the need for multiple Fn keymaps. But is this a keyboard-specific thing or something that should be written for all of them?

Also, what about extended keycodes, eg ZOOM_IN / ZOOM_OUT, NEXT SONG, PREV SONG, VOL UP, VOL DOWN, etc, etc. Some keyboards have these. Just look at any Linux keyboard driver.

Fanjita · Post by **Fanjita** » Sat Mar 24, 2007 9:25 am

futaris wrote: I'd like to add a driver for this too, but does it belong in this or just in PiKey?

Assuming your driver fits naturally in libpspirkeyb, I'd recommend putting it there, and then more people can benefit from it - since piKey just picks up the pspirkeyb lib and so can make use of any changes people add to the lib.

futaris · Post by **futaris** » Sat Mar 24, 2007 1:05 pm

Fanjita wrote: Assuming your driver fits naturally in libpspirkeyb, I'd recommend putting it there, and then more people can benefit from it - since piKey just picks up the pspirkeyb lib and so can make use of any changes people add to the lib.

Ok. I didn't mention this before, but the Visor Stowaway Keyboard is a RS232 keyboard that runs at LVTTL levels. i.e. you can wire it directly up to the headphone serial port cable, without any extra circuitry. Runs at 9600bps, and I think the 3.3V power pin on the headphone connector supplies enough current. I guess no-one has put a "plain" serial (non IR) keyboard into libpspirkeyb yet?

These are still around on eBay for US$5-$10 generally. Only three wires needed TX, GND and PWR.

Fanjita · Post by **Fanjita** » Sat Mar 24, 2007 10:56 pm

In that case I would suggest talking to monsti about the direction he feels his lib should be developing towards, but I would guess that a serial keyboard isn't a natural fit.

It certainly sounds like something we'd like a driver for in piKey, one way or the other.

Moquette31 · Post by **Moquette31** » Tue Apr 17, 2007 9:27 pm

Hi there, i am doing the driver for the Citipack IR-503, an IR keyboard (the only one I could found here in china).

It seems to work but I have some questions :
- in kbdkeyboards.h is IPAQ_BUTTON_CONTACTS redundant with KEY_UNKNOWN of pspirkeyb_rawkeys.h ? (the same for IPAQ_BUTTON_ITASK/KEY_INTL3)
- does these 4 defines souldn't be in pspirkeyb_rawkeys.h ?
- how can i give you my update (when i will finish debugging it;) ) ?

Moquette31 · Post by **Moquette31** » Tue Apr 17, 2007 11:01 pm

Hi, again me ;)

debugging my driver, I found a bug in keymap.c for capslock only alphas :

Code: Select all

if &#40;&#40;raw >= KEY_A&#41; && &#40;raw <= KEY_Z&#41;&#41;

should be replaced by :

Code: Select all

if &#40;&#40;&#40;raw >= KEY_Q&#41; && &#40;raw <= KEY_P&#41;&#41; || &#40;&#40;raw >= KEY_A&#41; && &#40;raw <= KEY_L&#41;&#41; || &#40;&#40;raw >= KEY_Z&#41; && &#40;raw <= KEY_M&#41;&#41;&#41;

because KEY_A to KEY_Z are not continu (cf pspirkeyb_rawkeys.h)

Fanjita · Post by **Fanjita** » Thu Apr 19, 2007 7:15 am

Well spotted, I just committed your capslock fix to SVN.

Happy to commit any other fixes for you if you need it.

Moquette31 · Post by **Moquette31** » Thu Apr 19, 2007 3:45 pm

great, happy to help ;)

and for this questions ?

Moquette31 wrote:Hi there, i am doing the driver for the Citipack IR-503, an IR keyboard (the only one I could found here in china).

It seems to work but I have some questions :
- in kbdkeyboards.h is IPAQ_BUTTON_CONTACTS redundant with KEY_UNKNOWN of pspirkeyb_rawkeys.h ? (the same for IPAQ_BUTTON_ITASK/KEY_INTL3)
- does these 4 defines souldn't be in pspirkeyb_rawkeys.h ?
- how can i give you my update (when i will finish debugging it;) ) ?

PS : I have finish my debug, so i can send to you my update ;)

J.F. · Post by **J.F.** » Tue May 01, 2007 8:23 pm

Has the issue with the prx been looked at yet? I was playing around with my Palm 3169WW, making improvements to the Palm UW keymap, and while the lib version works, the prx version hangs before even printing a line to the display.

J.F. · Post by **J.F.** » Sat May 05, 2007 2:26 pm

Okay... a few things I noticed while working on pspirkeyb.prx...

pspIrKeybReadinputPrx() is supposedly non-blocking, but on some keyboards, it is blocking. For example, on the Palm keyboard, the moment you call pspIrKeybReadinputPrx(), it blocks until you press a key. The palm function in pspirkeyb.c should look like this instead:

Code: Select all

static int palmuw&#40;unsigned char* buffer, int *length&#41;
&#123;
    unsigned char keycode=0;
    unsigned int  key_down=0;
    unsigned char buf1;
    int len;
    static int pi = 0;
    static unsigned char pbuf&#91;6&#93; = &#123;0,0,0,0,0,0&#125;;

loop&#58;
    len = sceIoRead&#40;g_irdafd, &buf1, 1&#41;;
    if &#40;len <= 0&#41;
        return -1;
    // must be 1... can't be anything else at this point
    if &#40;pi == 0&#41;
    &#123;
        // wait on 0xff
        if &#40;buf1 == 0xff&#41;
        &#123;
            pbuf&#91;0&#93; = 0xff;
            pi++;
        &#125;
        goto loop;
    &#125;

    pbuf&#91;pi&#93; = buf1;
    pi++;
    if &#40;pi < 6&#41;
        goto loop;

    pi = 0;

    /* resume display */
    scePowerTick&#40;0&#41;;

    //printf&#40; "0%c - %d\n", buf&#91;0&#93;, buf&#91;0&#93; &#41;;
    //printf&#40; "1%c - %d\n", buf&#91;1&#93;, buf&#91;1&#93; &#41;;
    //printf&#40; "5%c - %d\n", buf&#91;5&#93;, buf&#91;5&#93; &#41;;

    if&#40; pbuf&#91;0&#93; != 0xff || pbuf&#91;1&#93; != 0xc0 || pbuf&#91;5&#93; != 0xc1 &#41;
        return -1;

    //printf&#40; "2%c - %d\n", buf&#91;2&#93;, buf&#91;2&#93; &#41;;
    //printf&#40; "3%c - %d\n", buf&#91;3&#93;, buf&#91;3&#93; &#41;;

    if&#40; &#40; pbuf&#91;2&#93; + pbuf&#91;3&#93; &#41; != 0xff &#41;
        return -1;

    /* 3rd pos is the key we need */
    keycode = pbuf&#91;2&#93;;

    if&#40; keycode < 128 &#41;
        key_down = 1;
    else
        keycode -= 128;

    if &#40; key_down &#41; &#123;
        //if &#40;debug&#41;
            //fprintf&#40;stdout,"press %d\n", keycode&#41;;
        keymap_decode&#40; g_outputmode, palmuw_normal&#91;keycode&#93;, KEY_PRESSED, buffer, length &#41;;
    &#125; else &#123;
        //if &#40;debug&#41;
            //fprintf&#40;stderr,"release %d\n", keycode&#41;;
        keymap_decode&#40; g_outputmode, palmuw_normal&#91;keycode&#93;, KEY_RELEASED, buffer, length &#41;;
    &#125;

    return 0;
&#125;

As far as getting the prx test working, I changed the main.c like this:

Code: Select all

/*
    asciidemoprx&#58; PSP IR Keyboard Library ascii demo application
                    &#40;http&#58;//pspirkeyb.podzone.net&#41;
                  This is the same as the ascii demo but the driver get's loaded as PRX
    Copyright &#40;C&#41; 2007 Harald Fielker <harald.fielker@web.de>

    This program can be distributed under the terms of the GNU LGPL.
    See the file LICENSE.
*/

#include <pspsdk.h>
#include <pspkernel.h>
#include <pspctrl.h>
#include <pspdebug.h>
#include <psppower.h>
#include <stdio.h>
#include <string.h>

#include <pspirkeybprx.h>
#include <pspirkeyb_rawkeys.h>

#define printf pspDebugScreenPrintf

const char * g_prx_module = "ms0&#58;/seplugins/irkeyb.prx";

/* Define the module info section */
PSP_MODULE_INFO&#40;"asciidemo", PSP_MODULE_USER, 1, 1&#41;;
/* Define the main thread's attribute value &#40;optional&#41; */
PSP_MAIN_THREAD_ATTR&#40;THREAD_ATTR_USER&#41;;

/* Exit callback */
int exit_callback&#40;int arg1, int arg2, void *common&#41;
&#123;
    sceKernelExitGame&#40;&#41;;

    return 0;
&#125;

/* Callback thread */
int CallbackThread&#40;SceSize args, void *argp&#41;
&#123;
    int cbid;

    cbid = sceKernelCreateCallback&#40;"Exit Callback", exit_callback, NULL&#41;;
    sceKernelRegisterExitCallback&#40;cbid&#41;;
    sceKernelSleepThreadCB&#40;&#41;;

    return 0;
&#125;

/* Sets up the callback thread and returns its thread id */
int SetupCallbacks&#40;void&#41;
&#123;
    int thid = 0;

    thid = sceKernelCreateThread&#40;"update_thread", CallbackThread, 0x11, 0xFA0, THREAD_ATTR_USER, 0&#41;;
    if&#40;thid >= 0&#41;
    &#123;
        sceKernelStartThread&#40;thid, 0, 0&#41;;
    &#125;

    return thid;
&#125;

int main&#40;int argc, char *argv&#91;&#93;&#41;
&#123;
    SceCtrlData pad;
    u32 buttonsold = 0;
    int kernelmode = 0;       /* only 0 works for now - some keyboards need baud change */
    const char *config_file = NULL; /* this will force ms0&#58;/seplugins/pspirkeyb.ini */

    SetupCallbacks&#40;&#41;;

    pspDebugScreenInit&#40;&#41;;
    printf&#40;"PSP Irda Keyboard test - ASCii input &#40;PRX&#41; \n"&#41;;

    sceCtrlSetSamplingCycle&#40;0&#41;;
    sceCtrlSetSamplingMode&#40;PSP_CTRL_MODE_DIGITAL&#41;;

    /* Start irkeyb.prx */
    SceUID mod = pspSdkLoadStartModule&#40;g_prx_module, kernelmode ? \
        PSP_MEMORY_PARTITION_KERNEL &#58; PSP_MEMORY_PARTITION_USER&#41;;
    if&#40;mod < 0&#41;
    &#123;
        printf&#40; "loading of module %s failed\n", g_prx_module &#41;;
        goto endprg;
    &#125;

    if&#40;pspIrKeybInitPrx&#40; config_file, kernelmode &#41; != 0&#41;
    &#123;
        printf&#40; "error&#58; can't inialize the keyboard\n" &#41;;
        printf&#40; "       check keyboard type/map in ms0&#58;/seplugins/pspirkeyb.ini\n" &#41;;
    &#125;
    else
    &#123;
        unsigned char termchar = 'X';
        unsigned char buffer&#91;255&#93;;
        int i, length=0;

        printf&#40;"\npress %c on keyboard or any PSP button to exit\n", termchar &#41;;

        /* setup output method to ASCii */
        pspIrKeybOutputModePrx&#40; PSP_IRKBD_OUTPUT_MODE_ASCII &#41;;

        while&#40;1&#41; &#123;
            length = 0;
            /* non blocking read */
            if&#40; pspIrKeybReadinputPrx&#40;buffer, &length&#41; >= 0 &#41;
            &#123;
                for&#40; i=0; i < length; i++ &#41;
                    printf&#40; "%c", buffer&#91;i&#93; &#41;;
                if&#40; length == 1 && buffer&#91;0&#93; == termchar &#41;
                    break;
            &#125;
            else
            &#123;
                sceKernelDelayThread&#40;5*1000&#41;;
                sceCtrlReadBufferPositive&#40;&pad, 1&#41;;
                if &#40;pad.Buttons != buttonsold&#41;
                    break;
            &#125;
        &#125;

        /* bye keyboard */
        pspIrKeybFinishPrx&#40;&#41;;
    &#125;

endprg&#58;
    printf&#40; "\n bye... &#40;PRESS psp button to quit&#41;\n" &#41;;

    buttonsold = 0;
    while &#40;1&#41; &#123;
        sceCtrlReadBufferPositive&#40;&pad, 1&#41;;
        if &#40;pad.Buttons != buttonsold&#41; &#123;
            /* Exit */
            sceKernelExitGame&#40;&#41;;
        &#125;
        sceKernelDelayThread&#40;50*1000&#41;;
    &#125;

    return 0;
&#125;

The prx test then works (on 3.40 OE-A at least), and the Palm is unblocking.

I also made a few changes to the Palm raw codes, and made an ini for it. I'm not sure who to send it to. Who's maintaining this code? Some of the other keyboards need to be changed to be more like the Palm code above or they'll continue to block as well.

Fanjita · Post by **Fanjita** » Sat May 05, 2007 5:01 pm

You can send changes to me if you like, although Monsti is the official owner.

I think Monsti had more or less abandoned the PRX flavour, and my interest is much more in using piKey as a more generic library, than using the lib as a PRX, but I'm happy to help you keep it updated if you want to work with the PRX.

J.F. · Post by **J.F.** » Sun May 06, 2007 5:37 am

Fanjita wrote:You can send changes to me if you like, although Monsti is the official owner.

I think Monsti had more or less abandoned the PRX flavour, and my interest is much more in using piKey as a more generic library, than using the lib as a PRX, but I'm happy to help you keep it updated if you want to work with the PRX.

Sounds like a plan. Should I try to "unblock" some of the other keyboard drivers first? I just did the Palm one because that's what I have.

The PRX seems to be handy for times when you just need keyboard input that is independent of the build and doesn't require flashing. Just drop it and a couple ini files into seplugins and you're set. I'll probably use the PRX for keyboard support on some of the projects on my todo list.

EDIT: I noticed over at MaxConsole a couple reports that pikey doesn't work on 3.40 OE-A. I suppose you're looking into that...

Fanjita · Post by **Fanjita** » Mon May 07, 2007 2:30 am

J.F. wrote:Sounds like a plan. Should I try to "unblock" some of the other keyboard drivers first? I just did the Palm one because that's what I have.

I suspect the others are OK, your fix to the palm is the same I think as one that went into the non-PRX code - I hadn't expected it to be needed in both places, haven't really looked at the PRX code myself since it was supposed to be a bit broken already.

The PRX seems to be handy for times when you just need keyboard input that is independent of the build and doesn't require flashing. Just drop it and a couple ini files into seplugins and you're set. I'll probably use the PRX for keyboard support on some of the projects on my todo list.

The piKey lib works that way too, and (at the risk of self-promotion) I'd recommend it because it also gives you free support for e.g. SIO terminal input, etc. Check out the sample code in the piKey package for how to use it, it will autoload the PRX if it isn't already running.

EDIT: I noticed over at MaxConsole a couple reports that pikey doesn't work on 3.40 OE-A. I suppose you're looking into that...

Not actively, I have no time at the moment sadly, but it is top of the to-do list.

J.F. · Post by **J.F.** » Mon May 07, 2007 5:55 am

Fanjita wrote:
J.F. wrote:Sounds like a plan. Should I try to "unblock" some of the other keyboard drivers first? I just did the Palm one because that's what I have.
I suspect the others are OK, your fix to the palm is the same I think as one that went into the non-PRX code - I hadn't expected it to be needed in both places, haven't really looked at the PRX code myself since it was supposed to be a bit broken already.

The fix was in the main lib, not the prx code. When you called the function to read the keyboard buffer, it's supposed to exit if there's no keys, but the Palm driver (and hama driver) instead sit in a loop waiting for all the bytes of a key packet to come in before exiting, even if a packet hasn't started yet. Once you enter the function, you don't leave until a key comes.

Look at the first code in both (in libpspirkeyb/pspirkeyb.c):

Code: Select all

    while &#40;i < 6  || z < 6&#41; &#123;
...
    while &#40;i < 5  || z < 5&#41;
    &#123;

Neither one will exit until a) all 6/5 bytes come in, or b) an error occurs in reading the irda (note that reading the irda when no bytes have been received is not an error). So both of those keyboards block... well, the Palm doesn't with my code anymore. I think I should change the hama code before I send it. The others look okay, but I'm leary about some code in a few others:

Code: Select all

    if&#40; sceIoRead&#40;g_irdafd, buf, 2&#41; != 2 &#41;
        return &#40;-1&#41;;

That won't block, but suppose it just happens to get called when one byte has been received, but not the second in the packet... the first byte will be discarded by the read, then the second by the next read. If another packet has come in by the next call, it's first byte will wind up read as the second byte of the packet. So doing the code above has a race condition when you hit the keys: will it receive both bytes before you poll the lib? If not, it'll at least miss one key, possibly miss two keys, or return garbage and miss the next key. Given the low baud rate of these keyboards, it's probably a higher risk than people think.

The PRX seems to be handy for times when you just need keyboard input that is independent of the build and doesn't require flashing. Just drop it and a couple ini files into seplugins and you're set. I'll probably use the PRX for keyboard support on some of the projects on my todo list.
The piKey lib works that way too, and (at the risk of self-promotion) I'd recommend it because it also gives you free support for e.g. SIO terminal input, etc. Check out the sample code in the piKey package for how to use it, it will autoload the PRX if it isn't already running.

Does pikey work from the memstick alone? You don't have to flash it? That isn't clear in the docs. I guess I'll compile it with my code and copy it over and try it. If that's the case, I'll stick to pikey for my homebrew keyboard usage. :)

EDIT: I noticed over at MaxConsole a couple reports that pikey doesn't work on 3.40 OE-A. I suppose you're looking into that...
Not actively, I have no time at the moment sadly, but it is top of the to-do list.

Okay. Just wanted to be sure you knew of the reports. Since I have 3.40 OE on my PSP, it's made me a bit leary of flashing pikey. If I spot anything that might be related while going through the code, I'll let you know.

gringo · Post by **gringo** » Fri May 11, 2007 9:08 pm

Hi

I think it would be nice if there were some kind of wizard in which you press the keyboard buttons and then manually map it in the wizard on a specific key. Just an idea. I haven't read all the thread ... but ...ye

gringo

J.F. · Post by **J.F.** » Sat May 12, 2007 10:24 am

At the moment, there's an file that handles the mapping of ir keys -> PSP buttons. Just edit it with a text editor. It's the ms0:/seplugins/pikey/ctrlmap.txt file.

futaris · Post by **futaris** » Sun Jun 03, 2007 5:38 pm

Ok, rev 2211 has the new code for hama. How can I get read/write access to SVN to check in my changes for Stowaway XT?

J.F. · Post by **J.F.** » Mon Jun 04, 2007 6:39 am

futaris wrote:Ok, rev 2211 has the new code for hama. How can I get read/write access to SVN to check in my changes for Stowaway XT?

I sent my changes to fanjita (at his request) and he said he'd update the svn.