MIKAI
Library to modify content of a Mykey
Typedefs | Functions
srix.h File Reference
#include <stdint.h>
#include <stdlib.h>
#include <mikai/mikai.h>
#include <mikai-error.h>
#include "srix-flag.h"

Go to the source code of this file.

Typedefs

typedef struct Srix Srix
 

Functions

SrixSrixNew ()
 Create a new Srix and set its default values. More...
 
void SrixDelete (Srix *target)
 Delete a Srix and free its memory. More...
 
size_t NfcGetReadersCount (Srix *target)
 Function that search for available NFC readers and return their number. More...
 
char * NfcGetDescription (Srix *target, int reader)
 Function that return specified nfc reader description (connection string). More...
 
MikaiError SrixNfcInit (Srix *target, int reader)
 Initialize the Srix using Nfc. More...
 
void SrixMemoryInit (Srix *target, uint32_t eeprom[const static SRIX4K_BLOCKS], uint64_t uid)
 Initialize the Srix using values in memory. More...
 
uint64_t SrixGetUid (Srix *target)
 Return UID of an initialized srix. More...
 
uint32_t * SrixGetBlock (Srix *target, uint8_t blockNum)
 Get pointer to a specified block. More...
 
void SrixModifyBlock (Srix *target, uint32_t block, uint8_t blockNum)
 Modify manually a Srix block and add flag automatically. More...
 
MikaiError SrixWriteBlocks (Srix *target)
 Write all modified blocks of target to physical SRIX4K. More...
 

Typedef Documentation

◆ Srix

typedef struct Srix Srix

Definition at line 30 of file srix.h.

Function Documentation

◆ NfcGetDescription()

char* NfcGetDescription ( Srix target,
int  reader 
)

Function that return specified nfc reader description (connection string).

Parameters
targetpointer to Srix struct
readerindex of reader (0 = first, 1 = second, ecc.)
Returns
connstring of reader at specified index

Definition at line 144 of file srix.c.

◆ NfcGetReadersCount()

size_t NfcGetReadersCount ( Srix target)

Function that search for available NFC readers and return their number.

Parameters
targetpointer to Srix struct
Returns
number of readers found

◆ SrixDelete()

void SrixDelete ( Srix target)

Delete a Srix and free its memory.

Parameters
targetSrix instance to delete

◆ SrixGetBlock()

uint32_t* SrixGetBlock ( Srix target,
uint8_t  blockNum 
)

Get pointer to a specified block.

Parameters
targetpointer to Srix struct
blockNumnumber of block to get
Returns
pointer to blockNum block

◆ SrixGetUid()

uint64_t SrixGetUid ( Srix target)

Return UID of an initialized srix.

Parameters
targetpointer to Srix struct
Returns
uid uint64 value

◆ SrixMemoryInit()

void SrixMemoryInit ( Srix target,
uint32_t  eeprom[const static SRIX4K_BLOCKS],
uint64_t  uid 
)

Initialize the Srix using values in memory.

Parameters
targetpointer to Srix struct
eeprompointer to EEPROM array to import
uidUID to import

◆ SrixModifyBlock()

void SrixModifyBlock ( Srix target,
uint32_t  block,
uint8_t  blockNum 
)

Modify manually a Srix block and add flag automatically.

Parameters
targetpointer to Srix struct
blockvalue to write to blockNum
blockNumindex of block to write

◆ SrixNew()

Srix* SrixNew ( )

Create a new Srix and set its default values.

Returns
null if there is an error, else a Srix struct pointer

Definition at line 123 of file srix.c.

◆ SrixNfcInit()

MikaiError SrixNfcInit ( Srix target,
int  reader 
)

Initialize the Srix using Nfc.

Parameters
targetpointer to Srix struct
readerindex of nfc reader to use
Returns
MikaiError

◆ SrixWriteBlocks()

MikaiError SrixWriteBlocks ( Srix target)

Write all modified blocks of target to physical SRIX4K.

Parameters
targetpointer to Srix struct
Returns
MikaiError