JCU (JPEG hardware) driver API. More...

Data Structures
struct	jcu_count_mode_param_t
	Buffer settings for separating decode or encode. More...
struct	jcu_buffer_t
	Buffer settings. More...
struct	jcu_buffer_param_t
	Buffer parameter for input and output. More...
struct	jcu_image_info_t
	Image information data store variable. More...
struct	jcu_decode_param_t
	Setting parameter for the Decoding. More...
struct	jcu_encode_param_t
	Setting parameter for the Encoding. More...
Typedefs
typedef bit_flags_fast32_t	jcu_interrupt_lines_t
	Bit flags of <jcu_interrupt_line_t>
typedef bit_flags_fast32_t	jcu_int_detail_errors_t
	Bit flags of detail error.
Enumerations
enum	jcu_status_information_t
	Status. More...
enum	jcu_codec_t
	The type of codec. More...
enum	jcu_continue_type_t
	Type of continue buffer. More...
enum	jcu_sub_sampling_t
	Sub sampling settings for decoding. More...
enum	jcu_decode_format_t
	Kind of pixel format can process the decoding. More...
enum	jcu_cbcr_offset_t
	Cb/Cr offset. More...
enum	jcu_jpeg_format_t
	Kind of pixel format for the jpeg file format when decoding. More...
enum	jcu_table_no_t
	The index of the table. More...
enum	jcu_huff_t
	Kind of Huffman table. More...
enum	jcu_color_element_t
	Kind of color data for using the encoder parameter. More...
enum	jcu_codec_status_t
	Codec type. More...
Functions
jcu_errorcode_t	R_JCU_Initialize (void *const NullConfig)
	Initialize the driver.
jcu_errorcode_t	R_JCU_Terminate (void)
	Terminate the driver function.
jcu_errorcode_t	R_JCU_TerminateAsync (r_ospl_async_t *const async)
	Terminate the driver function.
jcu_errorcode_t	R_JCU_SelectCodec (const jcu_codec_t codec)
	Select Codec Type.
jcu_errorcode_t	R_JCU_Start (void)
	Start decoding or encoding.
jcu_errorcode_t	R_JCU_StartAsync (r_ospl_async_t *const async)
	Start decoding or encoding.
jcu_errorcode_t	R_JCU_SetCountMode (const jcu_count_mode_param_t *const buffer)
	Set the count mode (separate operating) parameter.
jcu_errorcode_t	R_JCU_Continue (const jcu_continue_type_t type)
	Restart the processing caused by count mode.
jcu_errorcode_t	R_JCU_ContinueAsync (const jcu_continue_type_t type, r_ospl_async_t *const async)
	Restart the processing caused by count mode.
void	R_JCU_GetAsyncStatus (const jcu_async_status_t **const out_Status)
	R_JCU_GetAsyncStatus.
jcu_errorcode_t	R_JCU_SetDecodeParam (const jcu_decode_param_t const decode, const jcu_buffer_param_t const buffer)
	Set parameter for decode.
jcu_errorcode_t	R_JCU_SetPauseForImageInfo (const bool_t is_pause)
	Whether stop or not stop for R_JCU_GetImageInfo()
jcu_errorcode_t	R_JCU_GetImageInfo (jcu_image_info_t *const buffer)
	GetImageInfo.
jcu_errorcode_t	R_JCU_SetErrorFilter (jcu_int_detail_errors_t filter)
	SetErrorFilter.
jcu_errorcode_t	R_JCU_SetQuantizationTable (const jcu_table_no_t tableNo, const uint8_t *const table)
	SetQuantizationTable.
jcu_errorcode_t	R_JCU_SetHuffmanTable (const jcu_table_no_t tableNo, const jcu_huff_t type, const uint8_t *const table)
	Set the Huffman table.
jcu_errorcode_t	R_JCU_SetEncodeParam (const jcu_encode_param_t const encode, const jcu_buffer_param_t const buffer)
	Set the parameter fo encoding.
jcu_errorcode_t	R_JCU_GetEncodedSize (size_t *const out_Size)
	GetEncodedSize.
jcu_errorcode_t	R_JCU_Set2ndCacheAttribute (r_ospl_axi_cache_attribute_t const read_cache_attribute, r_ospl_axi_cache_attribute_t const write_cache_attribute)
	Set AXI bus A*CACHE bits for 2nd cache to JCU.
void	R_JCU_PrintRegisters (void)
	Function Name: [R_JCU_PrintRegisters].
errnum_t	R_JCU_OnInterrupting (const r_ospl_interrupt_t *const InterruptSource)
	Function Name: [R_JCU_OnInterrupting].
errnum_t	R_JCU_OnInterrupted (void)
	Function Name: [R_JCU_OnInterrupted].

Detailed Description

JCU (JPEG hardware) driver API.

Main Header.

Module:: JCU

PublicVersion:: 1.00

(=JCU_VERSION)

Rev:: 38

Date:: 2014-03-18 16:14:45 +0900#

Definition in file r_jcu_api.h.

Typedef Documentation

jcu_int_detail_errors_t

Bit flags of detail error.

Definition at line 328 of file r_jcu_api.h.

jcu_interrupt_lines_t

Bit flags of <jcu_interrupt_line_t>

Definition at line 126 of file r_jcu_api.h.

Enumeration Type Documentation

enum jcu_cbcr_offset_t

Cb/Cr offset.

JCU_CBCR_OFFSET_0 - 0 = No offset
JCU_CBCR_OFFSET_128 - 1 = +128 offset

Definition at line 410 of file r_jcu_api.h.

enum jcu_codec_status_t

Codec type.

JCU_CODEC_NOT_SELECTED - -1
JCU_STATUS_ENCODE - 0
JCU_STATUS_DECODE - 1

Definition at line 527 of file r_jcu_api.h.

enum jcu_codec_t

The type of codec.

JCU_ENCODE - 0
JCU_DECODE - 1

Definition at line 247 of file r_jcu_api.h.

enum jcu_color_element_t

Kind of color data for using the encoder parameter.

JCU_ELEMENT_Y - 0
JCU_ELEMENT_Cb - 1
JCU_ELEMENT_Cr - 2

Definition at line 483 of file r_jcu_api.h.

enum jcu_continue_type_t

Type of continue buffer.

JCU_INPUT_BUFFER - 0
JCU_OUTPUT_BUFFER - 1
JCU_IMAGE_INFO - 2

Definition at line 299 of file r_jcu_api.h.

enum jcu_decode_format_t

Kind of pixel format can process the decoding.

JCU_OUTPUT_YCbCr422 - 0x00
JCU_OUTPUT_ARGB8888 - 0x01
JCU_OUTPUT_RGB565 - 0x02

Definition at line 396 of file r_jcu_api.h.

enum jcu_huff_t

Kind of Huffman table.

JCU_HUFFMAN_AC - 0
JCU_HUFFMAN_DC - 1

Definition at line 469 of file r_jcu_api.h.

enum jcu_jpeg_format_t

Kind of pixel format for the jpeg file format when decoding.

JCU_JPEG_YCbCr444 - 0
JCU_JPEG_YCbCr422 - 1
JCU_JPEG_YCbCr420 - 2
JCU_JPEG_YCbCr411 - 6

Definition at line 425 of file r_jcu_api.h.

enum jcu_status_information_t

Status.

JCU_STATUS_UNDEF - 0x00, Undefined
JCU_STATUS_INIT - 0x01, Initialized
JCU_STATUS_SELECTED - 0x02, Codec is selected
JCU_STATUS_READY - 0x08, Ready
JCU_STATUS_RUN - 0x10, Run
JCU_STATUS_INTERRUPTING - 0x40, Interrupting
JCU_STATUS_INTERRUPTED - 0x80, Interrupted

Definition at line 62 of file r_jcu_api.h.

enum jcu_sub_sampling_t

Sub sampling settings for decoding.

JCU_SUB_SAMPLING_1_1 - 0x00 = 1/1
JCU_SUB_SAMPLING_1_2 - 0x01 = 1/2
JCU_SUB_SAMPLING_1_4 - 0x02 = 1/4
JCU_SUB_SAMPLING_1_8 - 0x03 = 1/8

Definition at line 380 of file r_jcu_api.h.

enum jcu_table_no_t

The index of the table.

JCU_TABLE_NO_0 - 0
JCU_TABLE_NO_1 - 1
JCU_TABLE_NO_2 - 2
JCU_TABLE_NO_3 - 3

Definition at line 454 of file r_jcu_api.h.

Function Documentation

jcu_errorcode_t R_JCU_Continue ( const jcu_continue_type_t type )

Restart the processing caused by count mode.

Synchronized.

Parameters:

type	The target to continue

Returns:: <jcu_errorcode_t> type.

Definition at line 532 of file jcu_api.c.

jcu_errorcode_t R_JCU_ContinueAsync	(	const jcu_continue_type_t	type,
		r_ospl_async_t *const	async
	)

Restart the processing caused by count mode.

Asynchronized.

Parameters:

type	The target to continue

Returns:: <jcu_errorcode_t> type.

Definition at line 573 of file jcu_api.c.

void R_JCU_GetAsyncStatus ( const jcu_async_status_t **const out_Status )

R_JCU_GetAsyncStatus.

Parameters: None

Returns:: None

Definition at line 680 of file jcu_api.c.

jcu_errorcode_t R_JCU_GetEncodedSize ( size_t *const out_Size )

GetEncodedSize.

Parameters:

out_Size EncodedSize

Returns:: <jcu_errorcode_t> type.

Definition at line 1051 of file jcu_api.c.

jcu_errorcode_t R_JCU_GetImageInfo ( jcu_image_info_t *const buffer )

GetImageInfo.

Parameters:

buffer Image information. <jcu_image_info_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 799 of file jcu_api.c.

jcu_errorcode_t R_JCU_Initialize ( void *const NullConfig )

Initialize the driver.

Parameters:

NullConfig (in) NULL

Returns:: <jcu_errorcode_t> type.

Definition at line 97 of file jcu_api.c.

errnum_t R_JCU_OnInterrupted ( void )

Function Name: [R_JCU_OnInterrupted].

Bottom half operations on interrupting

Return values:

Error code, 0=No error

Definition at line 692 of file jcu_reg.c.

errnum_t R_JCU_OnInterrupting ( const r_ospl_interrupt_t *const InterruptSource )

Function Name: [R_JCU_OnInterrupting].

Operations on interrupting

Return values:

Error code, 0=No error

Definition at line 647 of file jcu_reg.c.

void R_JCU_PrintRegisters ( void )

Function Name: [R_JCU_PrintRegisters].

Return values:

None

Definition at line 69 of file jcu_user.c.

jcu_errorcode_t R_JCU_SelectCodec ( const jcu_codec_t codec )

Select Codec Type.

Parameters:

codec <jcu_codec_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 301 of file jcu_api.c.

jcu_errorcode_t R_JCU_Set2ndCacheAttribute	(	r_ospl_axi_cache_attribute_t const	read_cache_attribute,
		r_ospl_axi_cache_attribute_t const	write_cache_attribute
	)

Set AXI bus A*CACHE bits for 2nd cache to JCU.

Parameters:

read_cache_attribute	<r_ospl_axi_cache_attribute_t>
write_cache_attribute	<r_ospl_axi_cache_attribute_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 1067 of file jcu_api.c.

jcu_errorcode_t R_JCU_SetCountMode ( const jcu_count_mode_param_t *const buffer )

Set the count mode (separate operating) parameter.

Parameters:

buffer <jcu_count_mode_param_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 478 of file jcu_api.c.

jcu_errorcode_t R_JCU_SetDecodeParam	(	const jcu_decode_param_t *const	decode,
		const jcu_buffer_param_t *const	buffer
	)

Set parameter for decode.

Parameters:

decode	Select the encode parameter for decoding. <jcu_decode_param_t>
buffer	Buffer settings for decode. <jcu_buffer_param_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 703 of file jcu_api.c.

jcu_errorcode_t R_JCU_SetEncodeParam	(	const jcu_encode_param_t *const	encode,
		const jcu_buffer_param_t *const	buffer
	)

Set the parameter fo encoding.

Parameters:

encode	Select the encode parameter for encoding. <jcu_encode_param_t>
buffer	Select the buffer settings for encoding. <jcu_buffer_param_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 995 of file jcu_api.c.

jcu_errorcode_t R_JCU_SetErrorFilter ( jcu_int_detail_errors_t filter )

SetErrorFilter.

Parameters:

filter enable bit of error. <jcu_int_detail_errors_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 849 of file jcu_api.c.

jcu_errorcode_t R_JCU_SetHuffmanTable	(	const jcu_table_no_t	tableNo,
		const jcu_huff_t	type,
		const uint8_t *const	table
	)

Set the Huffman table.

Parameters:

tableNo	The table number to set the value. <jcu_table_no_t>
type	The type of Huffman table type (AC or DC). <jcu_huff_t>
table	The body of the table to set

Returns:: <jcu_errorcode_t> type.

Definition at line 940 of file jcu_api.c.

jcu_errorcode_t R_JCU_SetPauseForImageInfo ( const bool_t is_pause )

Whether stop or not stop for R_JCU_GetImageInfo()

Parameters:

is_pause Whether stop or not stop

Returns:: <jcu_errorcode_t> type.

Definition at line 759 of file jcu_api.c.

jcu_errorcode_t R_JCU_SetQuantizationTable	(	const jcu_table_no_t	tableNo,
		const uint8_t *const	table
	)

SetQuantizationTable.

Parameters:

tableNo	The table number to set the value. <jcu_table_no_t>
table	The body of the table to set.

Returns:: <jcu_errorcode_t> type.

Definition at line 885 of file jcu_api.c.

jcu_errorcode_t R_JCU_Start ( void )

Start decoding or encoding.

Synchronized.

Parameters: None

Returns:: <jcu_errorcode_t> type.

Definition at line 365 of file jcu_api.c.

jcu_errorcode_t R_JCU_StartAsync ( r_ospl_async_t *const async )

Start decoding or encoding.

Asynchronized.

Parameters: None

Returns:: <jcu_errorcode_t> type.

Definition at line 407 of file jcu_api.c.

jcu_errorcode_t R_JCU_Terminate ( void )

Terminate the driver function.

Parameters: None

Returns:: <jcu_errorcode_t> type.

Definition at line 173 of file jcu_api.c.

jcu_errorcode_t R_JCU_TerminateAsync ( r_ospl_async_t *const async )

Terminate the driver function.

Parameters:

async <r_ospl_async_t>

Returns:: <jcu_errorcode_t> type.

Definition at line 213 of file jcu_api.c.

Type:	Library
Created:	19 Aug 2015
Imports:	64
Forks:	0
Commits:	14
Dependents:	21
Dependencies:	0
Followers:	61

r_jcu_api.h File Reference

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

r_jcu_api.h File Reference

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning