osd  2.0.0.0
osd.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef OSD_H
36 #define OSD_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 
44 // -------------------------------------------------------------- PUBLIC MACROS
55 #define OSD_MAP_MIKROBUS( cfg, mikrobus ) \
56  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
57  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
58  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
59  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
60  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
61  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
62  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
63  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
64 
70 #define OSD_RETVAL uint8_t
71 
72 #define OSD_OK 0x00
73 #define OSD_INIT_ERROR 0xFF
74 
80 #define OSD_VM0_REG 0x00
81 #define OSD_VM1_REG 0x01
82 #define OSD_HOS_REG 0x02
83 #define OSD_VOS_REG 0x03
84 #define OSD_DMM_REG 0x04
85 #define OSD_DMAH_REG 0x05
86 #define OSD_DMAL_REG 0x06
87 #define OSD_DMDI_REG 0x07
88 #define OSD_CMM_REG 0x08
89 #define OSD_CMAH_REG 0x09
90 #define OSD_RB0_REG 0x10
91 #define OSD_CMAL_REG 0x0A
92 #define OSD_CMDI_REG 0x0B
93 #define OSD_OSDM_REG 0x0C
94 #define OSD_OSDBL_REG 0x6C
95 #define OSD_STAT_REG 0xA0
96 #define OSD_DMDO_REG 0xB0
97 #define OSD_CMDO_REG 0xC0
98 
104 #define OSD_WRITE_CMD 0x7F
105 #define OSD_READ_CMD 0x80
106 
107 #define OSD_CLEAR_DISPLAY 0x04
108 #define OSD_CLEAR_DISPLAY_VERT 0x06
109 #define OSD_END_STRING 0xFF
110 #define OSD_WRITE_NVR 0xA0
111 
112 #define OSD_WHITE_LEVEL_80 0x03
113 #define OSD_WHITE_LEVEL_90 0x02
114 #define OSD_WHITE_LEVEL_100 0x01
115 #define OSD_WHITE_LEVEL_120 0x00
116 
117 #define OSD_MAX_FONT_ROM 0xFF
118 #define OSD_STATUS_REG_NVR_BUSY 0x20
119 #define OSD_NVM_RAM_SIZE 0x36
120  // End group macro
124 // --------------------------------------------------------------- PUBLIC TYPES
133 typedef struct
134 {
135  // Output pins
136 
137  digital_out_t rst;
138  digital_out_t cs;
139 
140  // Input pins
141 
142  digital_in_t an;
143  digital_in_t pwm;
144  digital_in_t int_pin;
145 
146  // Modules
147 
148  spi_master_t spi;
149  pin_name_t chip_select;
150 
151 } osd_t;
152 
156 typedef struct
157 {
158  // Communication gpio pins
159 
160  pin_name_t miso;
161  pin_name_t mosi;
162  pin_name_t sck;
163  pin_name_t cs;
164 
165  // Additional gpio pins
166 
167  pin_name_t an;
168  pin_name_t rst;
169  pin_name_t pwm;
170  pin_name_t int_pin;
171 
172  // static variable
173 
174  uint32_t spi_speed;
175  uint8_t spi_mode;
176  spi_master_chip_select_polarity_t cs_polarity;
177 
178 } osd_cfg_t;
179 
183 typedef struct
184 {
185 
186 uint8_t n_byte; // number of bytes
187 uint8_t flags; // flags: 1 <==> blink; 2 <==> invert
188 uint8_t line_pos; // line position value
189 uint8_t row_pos; // row position value
190 
192  // End types group
194 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
195 
200 #ifdef __cplusplus
201 extern "C"{
202 #endif
203 
212 void osd_cfg_setup ( osd_cfg_t *cfg );
213 
221 OSD_RETVAL osd_init ( osd_t *ctx, osd_cfg_t *cfg );
222 
230 void osd_default_cfg ( osd_t *ctx );
231 
244 (
245  osd_t *ctx,
246  uint8_t *wr_buf,
247  uint16_t wr_len,
248  uint8_t *rd_buf,
249  uint16_t rd_len
250 );
251 
264 void osd_write_byte ( osd_t *ctx, uint8_t reg_address, uint8_t write_data );
265 
277 uint8_t osd_read_byte ( osd_t *ctx, uint8_t reg_address );
278 
293 void osd_hw_reset ( osd_t *ctx );
294 
305 void osd_enable ( osd_t *ctx );
306 
315 void osd_disable ( osd_t *ctx );
316 
329 void osd_write_character ( osd_t *ctx, uint8_t line_pos, uint8_t row_pos, uint8_t symbol );
330 
342 void osd_insert_custom_char ( osd_t *ctx, uint8_t chr_address, uint8_t custom_char );
343 
357 void osd_clears_char_places ( osd_t *ctx, uint8_t start_x, uint8_t start_y, uint8_t end_x,
358  uint8_t end_y );
359 
370 void osd_set_ntsc ( osd_t *ctx );
371 
382 void osd_set_pal ( osd_t *ctx );
383 
384 
403 void osd_set_video_sync_mode ( osd_t *ctx, uint8_t sync_mode );
404 
415 void osd_enable_display_image ( osd_t *ctx );
416 
427 void osd_disable_display_image ( osd_t *ctx );
428 
447 void osd_vertical_sync_screen ( osd_t *ctx, uint8_t vsync );
448 
465 void osd_soft_reset ( osd_t *ctx );
466 
477 void osd_enable_video_buffer ( osd_t *ctx );
478 
489 void osd_disable_video_buffer ( osd_t *ctx );
490 
507 void osd_set_background_mode ( osd_t *ctx, uint8_t b_mode );
508 
529 void osd_set_background_brightness ( osd_t *ctx, uint8_t brightness );
530 
548 void osd_set_blinking_time ( osd_t *ctx, uint8_t blinking_time );
549 
569 void osd_set_blinking_duty_cycle ( osd_t *ctx, uint8_t blink_duty_cycle );
570 
593 void osd_set_horizontal_offset ( osd_t *ctx, uint8_t h_offset );
594 
617 void osd_set_vertical_offset ( osd_t *ctx, uint8_t v_offset );
618 
636 void osd_set_operation_mode ( osd_t *ctx, uint8_t op_mode );
637 
653 void osd_set_local_background_control ( osd_t *ctx, uint8_t lb_mode );
654 
664 void osd_blinking_on ( osd_t *ctx );
665 
676 void osd_blinking_off ( osd_t *ctx );
677 
685 void osd_invert_pixels_display ( osd_t *ctx );
686 
694 void osd_normal_pixels_display ( osd_t *ctx );
695 
713 void osd_clear_display_memory ( osd_t *ctx );
714 
733 void osd_write_chars ( osd_t *ctx, uint8_t *symbol_buff, osd_write_chars_t *write_ctx );
734 
746 void osd_write_nvm_character ( osd_t *ctx, uint8_t v_chars, uint16_t v_index );
747 
756 
765 
776 void osd_character_blinking_on ( osd_t *ctx );
777 
785 void osd_character_blinking_off ( osd_t *ctx );
786 
794 void osd_invert_pixels_character ( osd_t *ctx );
795 
803 void osd_normal_pixels_character ( osd_t *ctx );
804 
827 void osd_set_sharpness ( osd_t *ctx, uint8_t s_data );
828 
836 void osd_enable_auto_black ( osd_t *ctx );
837 
848 void osd_disable_auto_black ( osd_t *ctx );
849 
887 uint8_t osd_get_status ( osd_t *ctx );
888 
916 uint8_t osd_get_display_data_out ( osd_t *ctx );
917 
938 uint8_t osd_get_character_data_out ( osd_t *ctx );
939 
957 uint8_t osd_get_los ( osd_t *ctx );
958 
976 uint8_t osd_get_vsync ( osd_t *ctx );
977 
995 uint8_t osd_get_hsync ( osd_t *ctx );
996 
997 
998 #ifdef __cplusplus
999 }
1000 #endif
1001 #endif // _OSD_H_
1002  // End public_function group
1005 
1006 // ------------------------------------------------------------------------- END
osd_disable_display_image
void osd_disable_display_image(osd_t *ctx)
Disable display of OSD image function.
osd_set_blinking_time
void osd_set_blinking_time(osd_t *ctx, uint8_t blinking_time)
Set blinking time.
osd_soft_reset
void osd_soft_reset(osd_t *ctx)
Software reset function.
OSD_RETVAL
#define OSD_RETVAL
Definition: osd.h:70
osd_set_video_sync_mode
void osd_set_video_sync_mode(osd_t *ctx, uint8_t sync_mode)
Set video sync mode function.
osd_cfg_t::pwm
pin_name_t pwm
Definition: osd.h:169
osd_write_byte
void osd_write_byte(osd_t *ctx, uint8_t reg_address, uint8_t write_data)
Write the byte of data.
osd_character_blinking_off
void osd_character_blinking_off(osd_t *ctx)
Set blinking OFF function.
osd_cfg_t::miso
pin_name_t miso
Definition: osd.h:160
osd_get_vsync
uint8_t osd_get_vsync(osd_t *ctx)
Get vertical sync status function.
osd_write_chars_t::line_pos
uint8_t line_pos
Definition: osd.h:188
osd_cfg_setup
void osd_cfg_setup(osd_cfg_t *cfg)
Config Object Initialization function.
osd_hw_reset
void osd_hw_reset(osd_t *ctx)
Hardware reset function.
osd_blinking_off
void osd_blinking_off(osd_t *ctx)
Set blinking OFF function.
osd_write_chars_t::flags
uint8_t flags
Definition: osd.h:187
osd_set_pal
void osd_set_pal(osd_t *ctx)
Set PAL video standard function.
osd_cfg_t::sck
pin_name_t sck
Definition: osd.h:162
osd_t::int_pin
digital_in_t int_pin
Definition: osd.h:144
osd_set_horizontal_offset
void osd_set_horizontal_offset(osd_t *ctx, uint8_t h_offset)
Set horizontal offset function.
osd_t::chip_select
pin_name_t chip_select
Definition: osd.h:149
osd_get_hsync
uint8_t osd_get_hsync(osd_t *ctx)
Get horizontal sync status function.
osd_t::spi
spi_master_t spi
Definition: osd.h:148
osd_set_background_mode
void osd_set_background_mode(osd_t *ctx, uint8_t b_mode)
Set background mode.
osd_blinking_on
void osd_blinking_on(osd_t *ctx)
Set blinking ON function.
osd_clear_display_memory
void osd_clear_display_memory(osd_t *ctx)
Clear display memory.
osd_t::rst
digital_out_t rst
Definition: osd.h:137
osd_enable_video_buffer
void osd_enable_video_buffer(osd_t *ctx)
Enable video buffer.
osd_read_byte
uint8_t osd_read_byte(osd_t *ctx, uint8_t reg_address)
Read the byte of data function.
osd_init
OSD_RETVAL osd_init(osd_t *ctx, osd_cfg_t *cfg)
Initialization function.
osd_clears_char_places
void osd_clears_char_places(osd_t *ctx, uint8_t start_x, uint8_t start_y, uint8_t end_x, uint8_t end_y)
Clears the character places function.
osd_t::pwm
digital_in_t pwm
Definition: osd.h:143
osd_cfg_t::mosi
pin_name_t mosi
Definition: osd.h:161
osd_get_character_data_out
uint8_t osd_get_character_data_out(osd_t *ctx)
Get character memory data out function.
osd_write_chars_t
Structure for osd_write_chars() call.
Definition: osd.h:183
osd_write_nvm_character
void osd_write_nvm_character(osd_t *ctx, uint8_t v_chars, uint16_t v_index)
Write NVM character function.
osd_generic_transfer
void osd_generic_transfer(osd_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
osd_cfg_t::int_pin
pin_name_t int_pin
Definition: osd.h:170
osd_insert_custom_char
void osd_insert_custom_char(osd_t *ctx, uint8_t chr_address, uint8_t custom_char)
Write custom character function.
osd_enable_display_image
void osd_enable_display_image(osd_t *ctx)
Enable display of OSD image function.
osd_cfg_t::rst
pin_name_t rst
Definition: osd.h:168
osd_disable_video_buffer
void osd_disable_video_buffer(osd_t *ctx)
Disable video buffer.
osd_write_chars_t::n_byte
uint8_t n_byte
Definition: osd.h:186
osd_normal_pixels_display
void osd_normal_pixels_display(osd_t *ctx)
Normal color of pixels on display function.
osd_invert_pixels_character
void osd_invert_pixels_character(osd_t *ctx)
Invert color of character pixels on display.
osd_write_character
void osd_write_character(osd_t *ctx, uint8_t line_pos, uint8_t row_pos, uint8_t symbol)
Write character by position function.
osd_t::cs
digital_out_t cs
Definition: osd.h:138
osd_set_character_color_black
void osd_set_character_color_black(osd_t *ctx)
Set the black background of the character function.
osd_character_blinking_on
void osd_character_blinking_on(osd_t *ctx)
Set blinking ON function.
osd_t
Click ctx object definition.
Definition: osd.h:133
osd_cfg_t
Click configuration structure definition.
Definition: osd.h:156
osd_get_display_data_out
uint8_t osd_get_display_data_out(osd_t *ctx)
Get display memory data out function.
osd_set_blinking_duty_cycle
void osd_set_blinking_duty_cycle(osd_t *ctx, uint8_t blink_duty_cycle)
Set blinking duty cycle function.
osd_write_chars_t::row_pos
uint8_t row_pos
Definition: osd.h:189
osd_set_background_brightness
void osd_set_background_brightness(osd_t *ctx, uint8_t brightness)
Set background brightness function.
osd_set_local_background_control
void osd_set_local_background_control(osd_t *ctx, uint8_t lb_mode)
Set local background control function.
osd_disable_auto_black
void osd_disable_auto_black(osd_t *ctx)
Disable automatic OSD black function.
osd_cfg_t::spi_mode
uint8_t spi_mode
Definition: osd.h:175
osd_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: osd.h:176
osd_get_los
uint8_t osd_get_los(osd_t *ctx)
Get loss of sync status function.
osd_get_status
uint8_t osd_get_status(osd_t *ctx)
Get status data function.
osd_cfg_t::spi_speed
uint32_t spi_speed
Definition: osd.h:174
osd_set_operation_mode
void osd_set_operation_mode(osd_t *ctx, uint8_t op_mode)
Set operation mode function.
osd_set_character_color_white
void osd_set_character_color_white(osd_t *ctx)
Set the white background of the character function.
osd_invert_pixels_display
void osd_invert_pixels_display(osd_t *ctx)
Invert color of pixels on display function.
osd_cfg_t::cs
pin_name_t cs
Definition: osd.h:163
osd_disable
void osd_disable(osd_t *ctx)
Disable OSD function.
osd_vertical_sync_screen
void osd_vertical_sync_screen(osd_t *ctx, uint8_t vsync)
Enable vertical synchronization of on-screen data function.
osd_default_cfg
void osd_default_cfg(osd_t *ctx)
Click Default Configuration function.
osd_enable
void osd_enable(osd_t *ctx)
Enable OSD function.
osd_write_chars
void osd_write_chars(osd_t *ctx, uint8_t *symbol_buff, osd_write_chars_t *write_ctx)
Write character function.
osd_cfg_t::an
pin_name_t an
Definition: osd.h:167
osd_t::an
digital_in_t an
Definition: osd.h:142
osd_set_ntsc
void osd_set_ntsc(osd_t *ctx)
Set NTSC video standard function.
osd_enable_auto_black
void osd_enable_auto_black(osd_t *ctx)
Enable automatic OSD black function.
osd_set_vertical_offset
void osd_set_vertical_offset(osd_t *ctx, uint8_t v_offset)
Set vertical offset function.
osd_set_sharpness
void osd_set_sharpness(osd_t *ctx, uint8_t s_data)
Set sharpness function.
osd_normal_pixels_character
void osd_normal_pixels_character(osd_t *ctx)
Normal color of character pixels on display.