MARMEX-VB : "Mary Camera module" library
Dependents: MARMEX_VB_test MARMEX_VB_Hello
MARMEX-VB (MARY-VB) camera module library for mbed. (This module may be available in Japan only.)
Kown problem / 既知の問題
The read data may have contouring. In this case, it may require reset or changing order of data reading. The order change API is available as "read_order_change()" function.
カメラから読み出したデータに擬似輪郭が発生することがあります.この問題にはシステム全体のリセットを行うか,または読み出し順の変更を行うことで対処して下さい.読み出し順の変更はAPIの"read_order_change()"関数を使うことができます.
Revision 0:c4d14dd5d479, committed 2014-06-06
- Comitter:
- nxpfan
- Date:
- Fri Jun 06 03:36:58 2014 +0000
- Child:
- 1:b2324313d4da
- Commit message:
- version 0.1
Changed in this revision
MARMEX_VB.cpp | Show annotated file Show diff for this revision Revisions of this file |
MARMEX_VB.h | Show annotated file Show diff for this revision Revisions of this file |
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/MARMEX_VB.cpp Fri Jun 06 03:36:58 2014 +0000 @@ -0,0 +1,356 @@ +/** MARMEX_VB Camera control library + * + * @class MARMEX_VB + * @version 0.1 + * @date 10-Jun-2014 + * + * Released under the Apache License, Version 2.0 : http://mbed.org/handbook/Apache-Licence + * + * MARMEX_VB Camera control library for mbed + */ + +#include "mbed.h" +#include "MARMEX_VB.h" + +#define SPI_FREQUENCY (12 * 1000 * 1000) + +MARMEX_VB::MARMEX_VB( + PinName SPI_mosi, + PinName SPI_miso, + PinName SPI_sck, + PinName SPI_cs, + PinName cam_reset, + PinName I2C_sda, + PinName I2C_scl +) : + _spi( SPI_mosi, SPI_miso, SPI_sck ), + _cs( SPI_cs ), + _reset( cam_reset ), + _i2c( I2C_sda, I2C_scl ) +{ +#ifdef IGNORE_INITIALIZATION_ERROR + init(); +#else + if ( 0 != init() ) + error( "camera initialization failed." ); +#endif +} + + +#define CAM_I2C_ADDR 0x42 + +#define COMMAND_WRITE 0x00 +#define COMMAND_READ 0x80 +#define COMMAND_ADDR_INCREMENT 0x20 + +#define MEMORY_ADDR_LOW__REGISTER 0x0 +#define MEMORY_ADDR_MID__REGISTER 0x1 +#define MEMORY_ADDR_HIGH_REGISTER 0x2 +#define CAMERA_DATA_REGISTER 0x8 +#define CONTROL_DATA_REGISTER 0x3 +#define STATUS_REGISTER 0x4 + +#define CONTROL__PAUSE_BUFFER_UPDATE 0x01 +#define CONTROL__RESUME_BUFFER_UPDATE 0x00 + + +int MARMEX_VB::init( CameraResolution res ) +{ +#define PARAM_NUM 99 +#define RES_CHANGE_PARAM_NUM 12 +#define RESET_PULSE_WIDTH 100 // mili-seconds +#define RESET_RECOVERY_TIME 100 // mili-seconds +#define COMMAND_INTERVAL 20 // mili-seconds + + char camera_register_setting[ PARAM_NUM ][ 2 ] = { + { 0x01, 0x40 }, { 0x02, 0x60 }, { 0x03, 0x02 }, { 0x0C, 0x0C }, + { 0x0E, 0x61 }, { 0x0F, 0x4B }, { 0x11, 0x80 }, { 0x12, 0x04 }, + { 0x15, 0x00 }, { 0x16, 0x02 }, { 0x17, 0x39 }, { 0x18, 0x03 }, + { 0x19, 0x03 }, { 0x1A, 0x7B }, { 0x1E, 0x37 }, { 0x21, 0x02 }, + { 0x22, 0x91 }, { 0x29, 0x07 }, { 0x32, 0x80 }, { 0x33, 0x0B }, + { 0x34, 0x11 }, { 0x35, 0x0B }, { 0x37, 0x1D }, { 0x38, 0x71 }, + { 0x39, 0x2A }, { 0x3B, 0x12 }, { 0x3C, 0x78 }, { 0x3D, 0xC3 }, + { 0x3E, 0x11 }, { 0x3F, 0x00 }, { 0x40, 0xD0 }, { 0x41, 0x08 }, + { 0x41, 0x38 }, { 0x43, 0x0A }, { 0x44, 0xF0 }, { 0x45, 0x34 }, + { 0x46, 0x58 }, { 0x47, 0x28 }, { 0x48, 0x3A }, { 0x4B, 0x09 }, + { 0x4C, 0x00 }, { 0x4D, 0x40 }, { 0x4E, 0x20 }, { 0x4F, 0x80 }, + { 0x50, 0x80 }, { 0x51, 0x00 }, { 0x52, 0x22 }, { 0x53, 0x5E }, + { 0x54, 0x80 }, { 0x56, 0x40 }, { 0x58, 0x9E }, { 0x59, 0x88 }, + { 0x5A, 0x88 }, { 0x5B, 0x44 }, { 0x5C, 0x67 }, { 0x5D, 0x49 }, + { 0x5E, 0x0E }, { 0x69, 0x00 }, { 0x6A, 0x40 }, { 0x6B, 0x0A }, + { 0x6C, 0x0A }, { 0x6D, 0x55 }, { 0x6E, 0x11 }, { 0x6F, 0x9F }, + { 0x70, 0x3A }, { 0x71, 0x35 }, { 0x72, 0x11 }, { 0x73, 0xF1 }, + { 0x74, 0x10 }, { 0x75, 0x05 }, { 0x76, 0xE1 }, { 0x77, 0x01 }, + { 0x78, 0x04 }, { 0x79, 0x01 }, { 0x8D, 0x4F }, { 0x8E, 0x00 }, + { 0x8F, 0x00 }, { 0x90, 0x00 }, { 0x91, 0x00 }, { 0x96, 0x00 }, + { 0x96, 0x00 }, { 0x97, 0x30 }, { 0x98, 0x20 }, { 0x99, 0x30 }, + { 0x9A, 0x00 }, { 0x9A, 0x84 }, { 0x9B, 0x29 }, { 0x9C, 0x03 }, + { 0x9D, 0x4C }, { 0x9E, 0x3F }, { 0xA2, 0x52 }, { 0xA4, 0x88 }, + { 0xB0, 0x84 }, { 0xB1, 0x0C }, { 0xB2, 0x0E }, { 0xB3, 0x82 }, + { 0xB8, 0x0A }, { 0xC8, 0xF0 }, { 0xC9, 0x60 }, + }; + const char res_change_param[ 5 ][ RES_CHANGE_PARAM_NUM ] = { + { 0x17, 0x18, 0x32, 0x19, 0x1a, 0x03, 0x0c, 0x3e, 0x71, 0x72, 0x73, 0xa2 }, // register addr + { 0x39, 0x03, 0x80, 0x03, 0x7b, 0x02, 0x0c, 0x11, 0x35, 0x11, 0xf1, 0x52 }, // QSIF + { 0x13, 0x01, 0xb6, 0x02, 0x7a, 0x0a, 0x00, 0x00, 0x35, 0x11, 0xf0, 0x02 }, // VGA + { 0x16, 0x04, 0x80, 0x02, 0x7a, 0x0a, 0x04, 0x19, 0x35, 0x11, 0xf1, 0x02 }, // QVGA + { 0x16, 0x04, 0xa4, 0x02, 0x7a, 0x0a, 0x04, 0x1a, 0x35, 0x22, 0xf2, 0x02 }, // QQVGA + }; + const char camera_reset_command[] = { 0x12, 0x80 }; + + _read_order_change = 0; + + // SPI settings + + _cs = 1; // set ChipSelect signal HIGH + _spi.format( 8 ); // camera SPI : 8bits/transfer + _spi.frequency( SPI_FREQUENCY ); // SPI frequency setting + _i2c.frequency( 400 * 1000 ); + + // reset + + _reset = 0; + wait_ms( RESET_PULSE_WIDTH ); // assert RESET signal + _reset = 1; + wait_ms( RESET_RECOVERY_TIME ); // deassert RESET signal + + if ( 0 != (_error_state = _i2c.write( CAM_I2C_ADDR, camera_reset_command, 2 )) ) + return _error_state; // return non-zero if I2C access failed + + wait_ms( 100 ); // reset (via I2C) recovery time + + _horizontal_size = QCIF_PIXEL_PER_LINE; + _vertical_size = QCIF_LINE_PER_FRAME; + +#ifdef UNIFIED_RESOLUTION_CHANGE + if ( QCIF != res ) { + for ( int i = 0; i < RES_CHANGE_PARAM_NUM; i++ ) { + for ( int j = 0; j < PARAM_NUM; j++ ) { + if ( camera_register_setting[ j ][ 0 ] == res_change_param[ 0 ][ i ] ) { + camera_register_setting[ j ][ 1 ] = res_change_param[ res ][ i ]; + } + } + } + } + + switch ( res ) { + case QCIF: + _horizontal_size = QCIF_PIXEL_PER_LINE; + _vertical_size = QCIF_LINE_PER_FRAME; + break; + case VGA: + _horizontal_size = VGA_PIXEL_PER_LINE; + _vertical_size = VGA_LINE_PER_FRAME; + break; + case QVGA: + _horizontal_size = VGA_PIXEL_PER_LINE / 2; + _vertical_size = VGA_LINE_PER_FRAME / 2; + break; + case QQVGA: + _horizontal_size = VGA_PIXEL_PER_LINE / 4; + _vertical_size = VGA_LINE_PER_FRAME / 4; + break; + } +#endif + + + for ( int i = 0; i < PARAM_NUM; i++ ) { + if ( 0 != (_error_state = _i2c.write( CAM_I2C_ADDR, camera_register_setting[ i ], 2 )) ) + break; + + wait_ms( COMMAND_INTERVAL ); // camera register writing requires this interval + } + +#ifndef UNIFIED_RESOLUTION_CHANGE + if ( QCIF != res ) { + char d[ 2 ]; + for ( int i = 0; i < RES_CHANGE_PARAM_NUM; i++ ) { + d[ 0 ] = res_change_param[ 0 ][ i ]; + d[ 1 ] = res_change_param[ res ][ i ]; + + if ( 0 != (_error_state = _i2c.write( CAM_I2C_ADDR, d, 2 )) ) + break; + + wait_ms( COMMAND_INTERVAL ); // camera register writing requires this interval + } + } + + switch ( res ) { + case QCIF: + _horizontal_size = QCIF_PIXEL_PER_LINE; + _vertical_size = QCIF_LINE_PER_FRAME; + break; + case VGA: + _horizontal_size = VGA_PIXEL_PER_LINE; + _vertical_size = VGA_LINE_PER_FRAME; + break; + case QVGA: + _horizontal_size = VGA_PIXEL_PER_LINE / 2; + _vertical_size = VGA_LINE_PER_FRAME / 2; + break; + case QQVGA: + _horizontal_size = VGA_PIXEL_PER_LINE / 4; + _vertical_size = VGA_LINE_PER_FRAME / 4; + break; + } + +printf( "resolution : h,v = %d,%d\r\n", _horizontal_size, _vertical_size ); +#endif + + return _error_state; // return non-zero if I2C access failed +} + +void MARMEX_VB::colorbar( SwitchState sw ) +{ + char s[ 2 ]; + + s[ 0 ] = 0x12; + s[ 1 ] = sw ? 0x06 : 0x04; + + _error_state = _i2c.write( CAM_I2C_ADDR, s, 2 ); +} + +int MARMEX_VB::get_horizontal_size( void ) +{ + return _horizontal_size; // return last state of I2C access +} + +int MARMEX_VB::get_vertical_size( void ) +{ + return _vertical_size; // return last state of I2C access +} + +int MARMEX_VB::ready( void ) +{ + return _error_state; // return last state of I2C access +} + +extern int read_order_change; + +void MARMEX_VB::read_a_line( short *p, int line_number, int x_offset, int n_of_pixels ) +{ +#if 0 + + char tmp; + + if ( line_number < 0 ) + return; + + // set camera module's buffer address + set_address( line_number * get_horizontal_size() * BYTE_PER_PIXEL + x_offset * BYTE_PER_PIXEL ); + + // put a read command, first return byte should be ignored + read_register( CAMERA_DATA_REGISTER ); + + for( int x = 0; x < n_of_pixels; x++ ) { + // perform 2 bytes read. a pixel data is in RGB565 format (16bits) + tmp = read_register( CAMERA_DATA_REGISTER ); // read lower byte + *p++ = (read_register( CAMERA_DATA_REGISTER ) << 8) | tmp; // read upper byte + } + +#else + + + short tmp; + + if ( line_number < 0 ) + return; + + // set camera module's buffer address + set_address( line_number * get_horizontal_size() * BYTE_PER_PIXEL + x_offset * BYTE_PER_PIXEL ); + + // put a read command, first return byte should be ignored + read_register( CAMERA_DATA_REGISTER ); + + + if ( _read_order_change ) { + + read_register( CAMERA_DATA_REGISTER ); + + for( int x = 0; x < n_of_pixels; x++ ) { + // perform 2 bytes read. a pixel data is in RGB565 format (16bits) + tmp = read_register( CAMERA_DATA_REGISTER ) << 8; // read lower byte + *p++ = (read_register( CAMERA_DATA_REGISTER ) << 0) | tmp; // read upper byte + } + + } else { + + for( int x = 0; x < n_of_pixels; x++ ) { + // perform 2 bytes read. a pixel data is in RGB565 format (16bits) + tmp = read_register( CAMERA_DATA_REGISTER ); // read lower byte + *p++ = (read_register( CAMERA_DATA_REGISTER ) << 8) | tmp; // read upper byte + } + + } + +#endif +} + +void MARMEX_VB::open_transfer( void ) +{ + // send command to pause the camera buffer update + write_register( CONTROL_DATA_REGISTER, CONTROL__PAUSE_BUFFER_UPDATE ); + + // read status register (first return byte should be ignored) + read_register( STATUS_REGISTER ); + + // wait until the status register become 0x51(ready to transfer data) + while ( 0x51 != read_register( STATUS_REGISTER ) ) + ; +} + +void MARMEX_VB::close_transfer( void ) +{ + // send command to resume the camera buffer update + write_register( CONTROL_DATA_REGISTER, CONTROL__RESUME_BUFFER_UPDATE ); + + // read status register (first return byte should be ignored) + read_register( STATUS_REGISTER ); + + // wait until the status register become 0x50(camera updating the buffer) + while ( 0x50 != read_register( STATUS_REGISTER ) ) + ; +} + +int MARMEX_VB::read_order_change( void ) +{ + return ( _read_order_change = !_read_order_change ); +} + +void MARMEX_VB::set_address( int address ) +{ + // set memory address (3 bytes) + + write_register( MEMORY_ADDR_LOW__REGISTER, (address >> 0) & 0xFF ); + write_register( MEMORY_ADDR_MID__REGISTER, (address >> 8) & 0xFF ); + write_register( MEMORY_ADDR_HIGH_REGISTER, (address >> 16) & 0xFF ); +} + +void MARMEX_VB::write_register( char reg, char value ) +{ + // camera register write + + send_spi( COMMAND_WRITE | reg ); // send command and register number + send_spi( value ); // send register value +} + +int MARMEX_VB::read_register( char reg ) +{ + // camera register read + // returning current data in SPI buffer (data returned by previous command) + + return ( send_spi( COMMAND_READ | reg | ((reg == CAMERA_DATA_REGISTER) ? COMMAND_ADDR_INCREMENT : 0x00) ) ); +} + +int MARMEX_VB::send_spi( char data ) +{ + int tmp; + + // SPI access + + _cs = 0; + tmp = _spi.write( data ); + _cs = 1; + + return ( tmp ); +}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/MARMEX_VB.h Fri Jun 06 03:36:58 2014 +0000 @@ -0,0 +1,212 @@ +/** MARMEX_VB Camera control library + * + * @class MARMEX_VB + * @version 0.1 + * @date 10-Jun-2014 + * + * Released under the Apache License, Version 2.0 : http://mbed.org/handbook/Apache-Licence + * + * MARMEX_VB Camera control library for mbed + */ + +#ifndef MBED_MARMEX_VB +#define MBED_MARMEX_VB + +/** MARMEX_VB class + * + * MARMEX_VB camera control library + * This driver provide controls and data transfer interface for MARMEX_VB + * + * Example: + * @code + * + * #include "mbed.h" + * #include "MARMEX_OB_oled.h" + * #include "MARMEX_VB.h" + * + * MARMEX_OB_oled oled1( p5, p7, p20, p16, p15 ); // mosi, sclk, cs, rst, power_control -- maple-mini-type-b-board-slot1 + * MARMEX_VB camera( p5, p6, p7, p22, p26, p28, p27 ); // mosi, miso, sclk, cs, reset, I2C_SDA, I2C_SCL -- maple-mini-type-b-board-slot2 + * BusOut led( LED3, LED4 ); + * + * #define X_OFFSET ((MARMEX_VB::PIXEL_PER_LINE - MARMEX_OB_oled::WIDTH ) / 2) + * #define Y_OFFSET ((MARMEX_VB::LINE_PER_FRAME - MARMEX_OB_oled::HEIGHT) / 2) + * + * int main() + * { + * led = 0x3; + * + * oled1.cls(); + * + * short buf[ MARMEX_OB_oled::WIDTH ]; + * + * while ( 1 ) { + * + * led = 0x1; + * camera.open_transfer(); + * + * for ( int line = 0; line < 128; line++ ) { + * camera.read_a_line( buf, line + Y_OFFSET, X_OFFSET, 128 ); + * oled1.blit565( 0, line, 128, 1, buf ); + * } + * + * camera.close_transfer(); + * led = 0x2; + * } + * } + * @endcode + */ + +#define DEFAULT_PICTURE_SIZE QCIF +//#define DEFAULT_PICTURE_SIZE VGA +//#define DEFAULT_PICTURE_SIZE QVGA +//#define DEFAULT_PICTURE_SIZE QQVGA + +class MARMEX_VB +{ +public: + typedef enum { + QCIF = 1, /**< QCIF */ + VGA, /**< VGA */ + QVGA, /**< QVGA */ + QQVGA, /**< QQVGA */ + } CameraResolution; + + typedef enum { + OFF = 0, /**< ON */ + ON, /**< OFF */ + } SwitchState; + + /** General parameters for MARMEX_VB */ + enum { + BYTE_PER_PIXEL = 2, /**< bytes per pixel */ + + QCIF_PIXEL_PER_LINE = 176, /**< pixels in a line (QCIF horizontal size) */ + QCIF_LINE_PER_FRAME = 144, /**< lines in a frame (QCIF vertical size) */ + VGA_PIXEL_PER_LINE = 640, /**< pixels in a line (VGA horizontal size) */ + VGA_LINE_PER_FRAME = 480, /**< lines in a frame (VGA vertical size) */ + }; + + /** General parameters for MARMEX_OB_oled */ + enum { + NO_ERROR = 0 /**< zero */ + }; + + /** Create a MARMEX_VB instance connected to specified SPI, DigitalOut and I2C pins + * + * @param SPI_mosi SPI-bus MOSI pin + * @param SPI_miso SPI-bus MISO pin + * @param SPI_sclk SPI-bus SCLK pin + * @param SPI_cs SPI-bus Chip Select pin + * @param cam_reset Camera reset pin + * @param I2C_sda I2C-bus SDA pin + * @param I2C_scl I2C-bus SCL pin + */ + + MARMEX_VB( + PinName SPI_mosi, + PinName SPI_miso, + PinName SPI_sck, + PinName SPI_cs, + PinName cam_reset, + PinName I2C_sda, + PinName I2C_scl + ); + + /** Initialization + * + * Performs MARMEX_VB reset and initializations + * This function is called from MARMEX_VB constoructor. So user don't have to call in the user code. + * + * This function takes about 2 seconds because there is 99 times I2C access with 20ms interval. + * + * @param res select camera resolution : QCIF(default), VGA, QVGA or QQVGA + */ + int init( CameraResolution res = QCIF ); + + /** Color bar ON/OFF + * + * Set colorbar ON/OFF + * + * @param sw turn-ON or -OFF colorbar : ON or OFF + */ + void colorbar( SwitchState sw ); + + /** Get holizontal size + * + * Returns horizontal image size (pixels) + * + * @return holizontal size + */ + int get_horizontal_size( void ); + + /** Get vertical size + * + * Returns vertical image size (pixels) + * + * @return vertical size + */ + int get_vertical_size( void ); + + /** Check camera availability + * + * Returns last I2C access result + * This returns non-zero value if the camera initialization failed + * + * @return error code in init function (I2C API return value) + */ + int ready( void ); + + /** Open transfer + * + * Let the MARMEX_VB get ready to transfer the data. + * When this function is called, the camera will stop updating buffer (on camera board) at end of frame. + * + * @return error code in init function (I2C API return value) + */ + void open_transfer( void ); + + /** Close transfer + * + * Letting the MARMEX_VB to know the data transfer done. + * This function should be called when the data transfer done to resume the buffer update by camera + */ + void close_transfer( void ); + + /** Read one line data + * + * Reads 1 line data from MARMEX_VB + * This function should be called when the data transfer done to resume the buffer update by camera + * + * @param *p pointer to array of short + * @param line_number to select which line want to read + * @param x_offset holizontal offset (from left) to start the read + * @param n_of_pixels pixels to be read + */ + void read_a_line( short *p, int line_number, int x_offset, int n_of_pixels ); + + /** Read order change + * + * Toggles flag for read order of 2 byte data. + * + * @return new status of the read order flag (false = normal / true = swapped) + */ + int read_order_change( void ); + +private: + int send_spi( char data ); + void write_register( char reg, char value ); + int read_register( char reg ); + void set_address( int address ); + + SPI _spi; + DigitalOut _cs; + DigitalOut _reset; + I2C _i2c; + int _error_state; + int _horizontal_size; + int _vertical_size; + int _read_order_change; + +}; + +#endif // MBED_MARMEX_VB \ No newline at end of file