Renesas » Code » Sound_Generator

Sound Generator Library

Fork of Sound_Generator by GR-PEACH_producer_meeting

Information

Japanese version is available in lower part of this page.
このページの後半に日本語版が用意されています．

Sound Generator

What is this?

Driver library for Sound Generator that is function of RZ/A1H.

API

Driver Wrapper API

You can use music playback function to call following APIs.

void piano4int_start( const int8_t *scores[SDG_CH_TOTAL], PIANO4INT_CB callback )

description	starts music playback
arguments	scores : music data of each chanel. The number of channels is specified by SDG_CH_TOTAL. callback : call back function by playing synchonized marker
return value	-
explanation	Starts music playback. For channels not to play, set NULL to the corresponding element of scores[]. Playback is controlled by interrupt handler. So, this function returns after initialization. "Callback" function will be called from interrupt handler when synchronized marker is played.

void piano4int_stop( bool force )

description	stops music playback
arguments	force : When this value is 1, force stop will be executed (not implemented).
return value	-
explanation	Stop misic playback. This function returns after finishing music playback of all channels. This function stops interrupts, but does not release objects.

bool piano4int_status( void )

description	Gets the plaback status
arguments	-
return value	The plaback status
explanation	Gets the plaback status. If any of the channel plays music, this function returns true.

typedef void (*PIANO4INT_CB)( uint32_t channel, uint32_t value )

description	call back function by playing synchonized marker
arguments	channel : Channel number value : Synchronized marker ID
return value	-
explanation	This is a user function call back by playing synchronized marker.. The argument "value" is set to the number that is described after synchronized marker. This function is called in interrupt hander, so please shorten the processing of this function.

Driver API

int32_t R_SDG_Open( uint32_t channel, R_SDG_CLOCK clock )

description	opens driver
arguments	channel : Channel number (0～3) clock : clock
return value	success : DEVDRV_SUCCESS error : DEVDRV_ERROR, etc.
explanation	This function initializes sound generator specified by argument "channel". "clock" to set the clock to be used in the internal sound generator from either from P0φ/2 to P0φ/16. Sample code accepts channel 1 and channel 3 only. If channel 0 or 2 is specified, this function returns an error.

int32_t R_SDG_Close( uint32_t channel )

description	Closes driver
arguments	channel : Channel number (0～3)
return value	success : DEVDRV_SUCCESS error : DEVDRV_ERROR,etc.
explanation	This function terminates sound generator specified by argument "channel". In Sample code, once this function is called, clock supply is stopped, this driver will not work until calling R_SDG_Open(). If target channel has not initialized by R_SDG_Open(), this function returns error code.

int32_t R_SDG_Tone( uint32_t channel, NOTE *note )

description	Generates single tone.
arguments	channel : Channel number (0～3) note : Tone parameters
return value	success : DEVDRV_SUCCESS error ： DEVDRV_ERROR,etc.
explanation	This function generates single tone. Tone is specified by argument "note". Pitch is determined by the following equation. Reference frequency = "clock" / [note->sfs] Pitch = [Reference frequency] / ( 2 × [note->tone] ) Loudness is determined by note->loud. note->loud specifies the duty of the square wave to be syncthesized sound to be output. Period square wave is high will be calculated in [note->loud / 256]. Attenuation rate is specified by note->attenuation. Attenuation is achieved by make the note->loud to 31/32 with the given period by note->attenuation. If target channel has not initialized by R_SDG_Open(), this function returns error code.

User Definition Functions

int32_t Userdef_SDG0_Open( void )

int32_t Userdef_SDG1_Open( void )

int32_t Userdef_SDG2_Open( void )

int32_t Userdef_SDG3_Open( void )

description	Open driver
argument	-
return value	success : DEVDRV_SUCCESS error : the other
explanation	User of this driver must create this function. This function is called from R_SDG_Open(), so user must create this function for each 4 channels. In this function, user must operate following operation. ・Supplies clock to the sound generator. ・Sets pin-mux for the sound generator. In the case this function is succeed, please set the return value of this function to DEVDRV_SUCCESS. The other value indicate an error and copy to the return value of R_SDG_Open() function. In the sample code, initializing routine is described for channel 1 and 3, and an error routine is described for channel 0 and 2.

int32_t Userdef_SDG0_Close( void )

int32_t Userdef_SDG1_Close( void )

int32_t Userdef_SDG2_Close( void )

int32_t Userdef_SDG3_Close( void )

description	Close driver
argument	-
return value	success : DEVDRV_SUCCESS error : the other
explanation	User of this driver must create this function. This function is called from R_SDG_Close(), so user must create this function for each 4 channels. In this function, user must operate following operation. ・Sets pin-mux for GPIO. ・Stops the clock supply to the sound generator In the case this function is succeed, please set the return value of this function to DEVDRV_SUCCESS. The other value indicate an error and copy to the return value of R_SDG_Close() function. In the sample code, uninitializing routine is described for channel 1 and 3, and an error routine is described for channel 0 and 2.

structures

typedef struct {
    UINT8_T TONE;		/* TONE VALUE ( 0 < TONE <= 127 )	*/
    UINT8_T SFS;		/* SFS VALUE ( 0 < SFS <= 255 )		*/
    UINT8_T LOUD;		/* LD VALUE ( 0 <= LD <= 255 )		*/
    UINT8_T ATTENUATION;	/* ATTENUATION VALUE			*/
} NOTE;

This structure specifies single tone.This structure is used in argument of R_SDG_Tone().

member	meaning	hardware register
tone	specifies single tone	TONE[6:0]
sfs	referrence frequency	SFS[7:0]
loud	stores the duty data for pulse output.	LD[7:0]
attenuation	Turns the attenuator function on and off, and select the attenuation cycle	DPF[2:0]

enumerate

typedef enum {
    R_SDG_CLOCK_2  = 0,
    R_SDG_CLOCK_4  = 1,
    R_SDG_CLOCK_8  = 2,
    R_SDG_CLOCK_16 = 3,
} R_SDG_CLOCK;

Selects the operating clock.

enumereate	meaning
R_SDG_CLOCK_2	P0φ/2
R_SDG_CLOCK_4	P0φ/4
R_SDG_CLOCK_8	P0φ/8
R_SDG_CLOCK_16	P0φ/16

typedef enum {
    R_SDG_ATT_OFF = 0,
    R_SDG_ATT_1	  = 1,
    R_SDG_ATT_2	  = 2,
    R_SDG_ATT_4	  = 3,
    R_SDG_ATT_8	  = 4,
    R_SDG_ATT_16  = 5,
    R_SDG_ATT_32  = 6,
} R_SDG_ATTENUATION;

Turns the attenuator function on and off, and select the attenuation cycle.

enumerate	meaning
R_SDG_ATT_OFF	Attenuator function is off.
R_SDG_ATT_1	Attenuates at the TONE frequency
R_SDG_ATT_2	Attenuates at the TONE frequency/2
R_SDG_ATT_4	Attenuates at the TONE frequency/4
R_SDG_ATT_8	Attenuates at the TONE frequency/8
R_SDG_ATT_16	Attenuates at the TONE frequency/16
R_SDG_ATT_32	Attenuates at the TONE frequency/32

サウンドジェネレータ

概要

RZ/A1Hに搭載されているサウンドジェネレータを使用するためのライブラリです。

API

Driver Wrapper API

下記に示すAPIはDriver APIをコールすることで楽曲再生機能を実現します。

void piano4int_start( const int8_t *scores[SDG_CH_TOTAL], PIANO4INT_CB callback )

概要	楽曲再生開始関数
引数	scores ： SDG_CH_TOTALで指定されるチャネル数分の楽譜 callback ：同期指示関数
戻り値	なし
解説	楽曲の再生を開始します。再生しないチャネルは、scores[ ]の該当する要素にNULLを設定します。再生は、内部でもっているTickerオブジェクトに従って、すべて割り込みで行われます。従って、この関数は初期化を終えると戻ってきます。同期指示関数callbackは、楽曲データに埋め込まれた同期マーカを再生したとき、割り込みから呼び出されます。

void piano4int_stop( bool force )

概要	楽曲再生停止関数
引数	force ：強制停止フラグ(未実装)
戻り値	なし
解説	楽曲の再生を停止します。この関数を呼び出すと、すべての楽曲を再生し終えた後、戻ってきます。割り込みは使用しなくなりますが、オブジェクトの解放はしません。

bool piano4int_status( void )

概要	楽曲再生状態取得関数
引数	なし
戻り値	再生状態
解説	現在の再生の状況を取得します。与えられた楽曲の一つでも再生中ならば、trueを返します。

typedef void (*PIANO4INT_CB)( uint32_t channel, uint32_t value )

概要	同期提示関数
引数	channel ：チャネル番号 value ：同期マーカID
戻り値	なし
解説	楽曲データに組み込んだ同期マーカ付音符を再生するときに呼び出されるユーザ関数です。 valueは、同期マーカの次に書かれている1～2桁の数字を整数型にしたものです。割り込みの中から呼ばれますので、処理は軽めにしてください。あまり長いと音がずれます。

Driver API

int32_t R_SDG_Open( uint32_t channel, R_SDG_CLOCK clock )

概要	サウンドジェネレータ初期化関数
引数	channel ：チャネル番号 (0～3) clock ：動作クロック
戻り値	正常終了： DEVDRV_SUCCESS エラー終了： DEVDRV_ERRORなど
解説	チャネル番号で指定したサウンドジェネレータを初期化します。動作クロックは、P0φ／2～P0φ／16から、今後使用するTONEやLOUDNESSに合わせて選択します。サンプルコードでは、チャネル1及びチャネル3だけが使用できます。チャネル0及びチャネル2を指定した場合はエラー終了します。

int32_t R_SDG_Close( uint32_t channel )

概要	サウンドジェネレータ終了関数
引数	channel ：チャネル番号 (0～3)
戻り値	正常終了： DEVDRV_SUCCESS エラー終了： DEVDRV_ERRORなど
解説	指定したチャネルのサウンドジェネレータの使用を終了します。サンプルコードでは、クロックの供給も停止しますので、再びR_SDG_Open( )で初期化するまで使用できなくなります。 R_SDG_Open( )を呼び出していないチャネルを指定した場合はエラー終了します。

int32_t R_SDG_Tone( uint32_t channel, NOTE *note )

概要	単音作成関数
引数	channel ：チャネル番号 (0～3) note ：トーン設定パラメータ
戻り値	正常終了： DEVDRV_SUCCESS エラー終了： DEVDRV_ERRORなど
解説	単音を出力します。音はnoteで指定します。 note->tone、note->sfs、R_SDG_Open( )で指定した動作クロックから、次の式で音の高さを決めます。基準周波数＝動作クロック／sfs TONE周波数＝基準周波数／( 2 × tone ) note->loudで音の大きさを指定します。loudは出力する音に合成する方形波のデューティ比で、 loud ／256が方形波のHighの区間になります。 note->attenuationで減衰率を指定します。指定した周期ごとに、loudを31／32にすることで減衰します。 R_SDG_Open( )を呼び出していないチャネルを指定した場合はエラー終了します。

ユーザ定義関数

int32_t Userdef_SDG0_Open( void )

int32_t Userdef_SDG1_Open( void )

int32_t Userdef_SDG2_Open( void )

int32_t Userdef_SDG3_Open( void )

概要	サウンドジェネレータ初期化ユーザ定義関数
引数	なし
戻り値	正常終了： DEVDRV_SUCCESS エラー終了：その他
解説	このドライバの利用者が作成する関数です。 R_SDG_Open( )から呼び出される関数で、4チャネル分の関数が必要です。使用するサウンドジェネレータのサウンドジェネレータ初期化ユーザ定義関数では、最低限、次のことを実施してください。・サウンドジェネレータにクロックを供給します。・サウンドジェネレータが使う出力ピンの設定をします。また、正常に終了したとき、DEVDRV_SUCCESSを返してください。この値以外はエラーとみなし、 R_SDG_Open( )の戻り値になります。サンプルコードでは、チャネル1及びチャネル3は初期化処理を行い、チャネル0及びチャネル2はエラーになります。

int32_t Userdef_SDG0_Close( void )

int32_t Userdef_SDG1_Close( void )

int32_t Userdef_SDG2_Close( void )

int32_t Userdef_SDG3_Close( void )

概要	サウンドジェネレータ終了ユーザ定義関数
引数	なし
戻り値	正常終了： DEVDRV_SUCCESS エラー終了：その他
解説	このドライバの利用者が作成する関数です。 R_SDG_Close( )から呼び出される関数で、4チャネル分の関数が必要です。これらの関数では、次のことを実施してください。・サウンドジェネレータが使う出力ピンをGPIOに変更します。・サウンドジェネレータへのクロックの供給を停止します。また、正常に終了したとき、DEVDRV_SUCCESSを返してください。この値以外はエラーとみなし、R_SDG_Close( )の戻り値になります。サンプルコードでは、チャネル1及びチャネル3は終了処理を行い、チャネル0及びチャネル2はエラーになります。

構造体

typedef struct {
    UINT8_T TONE;		/* TONE VALUE ( 0 < TONE <= 127 )	*/
    UINT8_T SFS;		/* SFS VALUE ( 0 < SFS <= 255 )		*/
    UINT8_T LOUD;		/* LD VALUE ( 0 <= LD <= 255 )		*/
    UINT8_T ATTENUATION;	/* ATTENUATION VALUE			*/
} NOTE;

単音を表す構造体です。R_SDG_Tone( )の引数で使用します。意味と設定するビットを次に示します。

要素	意味	ビット名
tone	音色を決める値です	TONE[6:0]
sfs	基準周波数を決める値です	SFS[7:0]
loud	出力パルスのデューティ比を決める値です	LD[7:0]
attenuation	出力の減衰率を決める値です	DPF[2:0]

列挙型

typedef enum {
    R_SDG_CLOCK_2  = 0,
    R_SDG_CLOCK_4  = 1,
    R_SDG_CLOCK_8  = 2,
    R_SDG_CLOCK_16 = 3,
} R_SDG_CLOCK;

動作クロックを表す列挙型です。それぞれ、次の意味をもちます。

要素	意味
R_SDG_CLOCK_2	P0φ／2
R_SDG_CLOCK_4	P0φ／4
R_SDG_CLOCK_8	P0φ／8
R_SDG_CLOCK_16	P0φ／16

typedef enum {
    R_SDG_ATT_OFF = 0,
    R_SDG_ATT_1	  = 1,
    R_SDG_ATT_2	  = 2,
    R_SDG_ATT_4	  = 3,
    R_SDG_ATT_8	  = 4,
    R_SDG_ATT_16  = 5,
    R_SDG_ATT_32  = 6,
} R_SDG_ATTENUATION;

減衰率を表す列挙型です。それぞれ、次の意味をもちます。

要素	意味
R_SDG_ATT_OFF	減衰しません
R_SDG_ATT_1	TONE周波数で減衰します
R_SDG_ATT_2	TONE周波数の1／2で減衰します
R_SDG_ATT_4	TONE周波数の1／4で減衰します
R_SDG_ATT_8	TONE周波数の1／8で減衰します
R_SDG_ATT_16	TONE周波数の1／16で減衰します
R_SDG_ATT_32	TONE周波数の1／32で減衰します

sdg_driver/sdg.c@1:cd3d332d4499, 2017-04-24 (annotated)

Committer:: Osamu Nakamura
Date:: Mon Apr 24 18:32:45 2017 +0900
Revision:: 1:cd3d332d4499
Parent:: 0:a3a1d4768307

Revised piano4int.cpp so that it can be compiled with GCC ARM Embedded

Who changed what in which revision?

User	Revision	Line number	New contents of line
MasaoHamanaka	0:a3a1d4768307	1	/*******************************************************************************
MasaoHamanaka	0:a3a1d4768307	2	* DISCLAIMER
MasaoHamanaka	0:a3a1d4768307	3	* This software is supplied by Renesas Electronics Corporation and is only
MasaoHamanaka	0:a3a1d4768307	4	* intended for use with Renesas products. No other uses are authorized. This
MasaoHamanaka	0:a3a1d4768307	5	* software is owned by Renesas Electronics Corporation and is protected under
MasaoHamanaka	0:a3a1d4768307	6	* all applicable laws, including copyright laws.
MasaoHamanaka	0:a3a1d4768307	7	* THIS SOFTWARE IS PROVIDED "AS IS" AND RENESAS MAKES NO WARRANTIES REGARDING
MasaoHamanaka	0:a3a1d4768307	8	* THIS SOFTWARE, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
MasaoHamanaka	0:a3a1d4768307	9	* LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
MasaoHamanaka	0:a3a1d4768307	10	* AND NON-INFRINGEMENT. ALL SUCH WARRANTIES ARE EXPRESSLY DISCLAIMED.
MasaoHamanaka	0:a3a1d4768307	11	* TO THE MAXIMUM EXTENT PERMITTED NOT PROHIBITED BY LAW, NEITHER RENESAS
MasaoHamanaka	0:a3a1d4768307	12	* ELECTRONICS CORPORATION NOR ANY OF ITS AFFILIATED COMPANIES SHALL BE LIABLE
MasaoHamanaka	0:a3a1d4768307	13	* FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES FOR
MasaoHamanaka	0:a3a1d4768307	14	* ANY REASON RELATED TO THIS SOFTWARE, EVEN IF RENESAS OR ITS AFFILIATES HAVE
MasaoHamanaka	0:a3a1d4768307	15	* BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
MasaoHamanaka	0:a3a1d4768307	16	* Renesas reserves the right, without notice, to make changes to this software
MasaoHamanaka	0:a3a1d4768307	17	* and to discontinue the availability of this software. By using this software,
MasaoHamanaka	0:a3a1d4768307	18	* you agree to the additional terms and conditions found by accessing the
MasaoHamanaka	0:a3a1d4768307	19	* following link:
MasaoHamanaka	0:a3a1d4768307	20	* http://www.renesas.com/disclaimer
MasaoHamanaka	0:a3a1d4768307	21	* Copyright (C) 2012 - 2015 Renesas Electronics Corporation. All rights reserved.
MasaoHamanaka	0:a3a1d4768307	22	*******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	23
MasaoHamanaka	0:a3a1d4768307	24	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	25	Includes <System Includes> , "Project Includes"
MasaoHamanaka	0:a3a1d4768307	26	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	27	#include <stdint.h>
MasaoHamanaka	0:a3a1d4768307	28	#include "dev_drv.h" /* Device Driver common header */
MasaoHamanaka	0:a3a1d4768307	29	#include "devdrv_sdg.h" /* SDG Driver header */
MasaoHamanaka	0:a3a1d4768307	30	#include "iodefine.h"
MasaoHamanaka	0:a3a1d4768307	31	#include "gpio_iobitmask.h"
MasaoHamanaka	0:a3a1d4768307	32	#include "sdg_iobitmask.h"
MasaoHamanaka	0:a3a1d4768307	33	#include "rza_io_regrw.h"
MasaoHamanaka	0:a3a1d4768307	34
MasaoHamanaka	0:a3a1d4768307	35	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	36	Typedef definitions
MasaoHamanaka	0:a3a1d4768307	37	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	38	typedef int32_t (*Userdef_Open)(void);
MasaoHamanaka	0:a3a1d4768307	39	typedef int32_t (*Userdef_Close)(void);
MasaoHamanaka	0:a3a1d4768307	40
MasaoHamanaka	0:a3a1d4768307	41	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	42	Macro definitions
MasaoHamanaka	0:a3a1d4768307	43	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	44	#define REGW8(CH, REG, BIT, VAL) RZA_IO_RegWrite_8(&CH->REG, VAL, SDGn_##REG##_##BIT##_SHIFT, SDGn_##REG##_##BIT)
MasaoHamanaka	0:a3a1d4768307	45
MasaoHamanaka	0:a3a1d4768307	46	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	47	Imported global variables and functions (from other files)
MasaoHamanaka	0:a3a1d4768307	48	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	49
MasaoHamanaka	0:a3a1d4768307	50
MasaoHamanaka	0:a3a1d4768307	51	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	52	Exported global variables and functions (to be accessed by other files)
MasaoHamanaka	0:a3a1d4768307	53	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	54
MasaoHamanaka	0:a3a1d4768307	55
MasaoHamanaka	0:a3a1d4768307	56	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	57	Private global variables and functions
MasaoHamanaka	0:a3a1d4768307	58	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	59	static struct st_sdg * const stSDG[SDG_CH_TOTAL] = {
MasaoHamanaka	0:a3a1d4768307	60	&SDG0,
MasaoHamanaka	0:a3a1d4768307	61	&SDG1,
MasaoHamanaka	0:a3a1d4768307	62	&SDG2,
MasaoHamanaka	0:a3a1d4768307	63	&SDG3,
MasaoHamanaka	0:a3a1d4768307	64	};
MasaoHamanaka	0:a3a1d4768307	65
MasaoHamanaka	0:a3a1d4768307	66
MasaoHamanaka	0:a3a1d4768307	67	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	68	* Function Name: R_SDG_Open
MasaoHamanaka	0:a3a1d4768307	69	* Description : Start the SDG specified by the argument channel.
MasaoHamanaka	0:a3a1d4768307	70	* Arguments : uint32_t channel : SDG channel (0, 1, 2, or 3)
MasaoHamanaka	0:a3a1d4768307	71	* : R_SDG_CLOCK clock : SGCLK
MasaoHamanaka	0:a3a1d4768307	72	* Return Value : DEVDRV_SUCCESS : Success to start counting SDG
MasaoHamanaka	0:a3a1d4768307	73	* : DEVDRV_ERROR : Failure
MasaoHamanaka	0:a3a1d4768307	74	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	75	int32_t R_SDG_Open(uint32_t channel, R_SDG_CLOCK clock)
MasaoHamanaka	0:a3a1d4768307	76	{
MasaoHamanaka	0:a3a1d4768307	77	static const Userdef_Open userdef_open[SDG_CH_TOTAL] = {
MasaoHamanaka	0:a3a1d4768307	78	&Userdef_SDG0_Open,
MasaoHamanaka	0:a3a1d4768307	79	&Userdef_SDG1_Open,
MasaoHamanaka	0:a3a1d4768307	80	&Userdef_SDG2_Open,
MasaoHamanaka	0:a3a1d4768307	81	&Userdef_SDG3_Open,
MasaoHamanaka	0:a3a1d4768307	82	};
MasaoHamanaka	0:a3a1d4768307	83	int32_t ret = DEVDRV_SUCCESS;
MasaoHamanaka	0:a3a1d4768307	84
MasaoHamanaka	0:a3a1d4768307	85
MasaoHamanaka	0:a3a1d4768307	86	/* check argument */
MasaoHamanaka	0:a3a1d4768307	87	if (channel >= SDG_CH_TOTAL) {
MasaoHamanaka	0:a3a1d4768307	88	return DEVDRV_ERROR; /* argument error */
MasaoHamanaka	0:a3a1d4768307	89	}
MasaoHamanaka	0:a3a1d4768307	90
MasaoHamanaka	0:a3a1d4768307	91	/* ==== SDG initialization ==== */
MasaoHamanaka	0:a3a1d4768307	92	ret = userdef_open[channel]();
MasaoHamanaka	0:a3a1d4768307	93	if (DEVDRV_SUCCESS == ret) {
MasaoHamanaka	0:a3a1d4768307	94	/* ==== Start SDG ==== */
MasaoHamanaka	0:a3a1d4768307	95	REGW8(stSDG[channel], SGCR1, STPM, 1); /* set SDG deactivate method: none */
MasaoHamanaka	0:a3a1d4768307	96	REGW8(stSDG[channel], SGCR1, SGCK, (uint8_t)clock); /* clock */
MasaoHamanaka	0:a3a1d4768307	97	REGW8(stSDG[channel], SGCSR, SGIE, 0); /* interrupt: disabled */
MasaoHamanaka	0:a3a1d4768307	98	}
MasaoHamanaka	0:a3a1d4768307	99
MasaoHamanaka	0:a3a1d4768307	100	return ret;
MasaoHamanaka	0:a3a1d4768307	101	}
MasaoHamanaka	0:a3a1d4768307	102
MasaoHamanaka	0:a3a1d4768307	103	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	104	* Function Name: R_SDG_Close
MasaoHamanaka	0:a3a1d4768307	105	* Description : Stop the SDG specified by the argument channel.
MasaoHamanaka	0:a3a1d4768307	106	* Arguments : uint32_t channel : SDG channel (0, 1, 2 or 3)
MasaoHamanaka	0:a3a1d4768307	107	* Return Value : DEVDRV_SUCCESS : Success to stop counting SDG
MasaoHamanaka	0:a3a1d4768307	108	* : DEVDRV_ERROR : Failure
MasaoHamanaka	0:a3a1d4768307	109	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	110	int32_t R_SDG_Close(uint32_t channel)
MasaoHamanaka	0:a3a1d4768307	111	{
MasaoHamanaka	0:a3a1d4768307	112	static const Userdef_Close userdef_close[SDG_CH_TOTAL] = {
MasaoHamanaka	0:a3a1d4768307	113	&Userdef_SDG0_Close,
MasaoHamanaka	0:a3a1d4768307	114	&Userdef_SDG1_Close,
MasaoHamanaka	0:a3a1d4768307	115	&Userdef_SDG2_Close,
MasaoHamanaka	0:a3a1d4768307	116	&Userdef_SDG3_Close,
MasaoHamanaka	0:a3a1d4768307	117	};
MasaoHamanaka	0:a3a1d4768307	118	int32_t ret = DEVDRV_SUCCESS;
MasaoHamanaka	0:a3a1d4768307	119
MasaoHamanaka	0:a3a1d4768307	120	/* check argument */
MasaoHamanaka	0:a3a1d4768307	121	if (channel >= SDG_CH_TOTAL) {
MasaoHamanaka	0:a3a1d4768307	122	return DEVDRV_ERROR; /* Argument error */
MasaoHamanaka	0:a3a1d4768307	123	}
MasaoHamanaka	0:a3a1d4768307	124
MasaoHamanaka	0:a3a1d4768307	125	/* ==== SDG finalization ==== */
MasaoHamanaka	0:a3a1d4768307	126	ret = userdef_close[channel]();
MasaoHamanaka	0:a3a1d4768307	127
MasaoHamanaka	0:a3a1d4768307	128	return ret;
MasaoHamanaka	0:a3a1d4768307	129	}
MasaoHamanaka	0:a3a1d4768307	130
MasaoHamanaka	0:a3a1d4768307	131
MasaoHamanaka	0:a3a1d4768307	132	/******************************************************************************
MasaoHamanaka	0:a3a1d4768307	133	* Function Name: R_SDG_Tone
MasaoHamanaka	0:a3a1d4768307	134	* Description : Set freqency registers
MasaoHamanaka	0:a3a1d4768307	135	* Arguments : uint32_t channel : SDG channel (0, 1, 2 or 3)
MasaoHamanaka	0:a3a1d4768307	136	* : NOTE *note : a note parameters
MasaoHamanaka	0:a3a1d4768307	137	* Return Value : DEVDRV_SUCCESS : Success to play a note
MasaoHamanaka	0:a3a1d4768307	138	* : DEVDRV_ERROR : Failure
MasaoHamanaka	0:a3a1d4768307	139	******************************************************************************/
MasaoHamanaka	0:a3a1d4768307	140	int32_t R_SDG_Tone(uint32_t channel, NOTE *note)
MasaoHamanaka	0:a3a1d4768307	141	{
MasaoHamanaka	0:a3a1d4768307	142	uint16_t tone;
MasaoHamanaka	0:a3a1d4768307	143	uint16_t sfs;
MasaoHamanaka	0:a3a1d4768307	144	uint16_t loud;
MasaoHamanaka	0:a3a1d4768307	145	uint16_t att;
MasaoHamanaka	0:a3a1d4768307	146	int32_t ret = DEVDRV_SUCCESS;
MasaoHamanaka	0:a3a1d4768307	147
MasaoHamanaka	0:a3a1d4768307	148
MasaoHamanaka	0:a3a1d4768307	149	/* check parameter */
MasaoHamanaka	0:a3a1d4768307	150	if ((channel >= SDG_CH_TOTAL) \|\| (note->tone > SDG_TONE_MAX)) {
MasaoHamanaka	0:a3a1d4768307	151	return DEVDRV_ERROR; /* Argument error */
MasaoHamanaka	0:a3a1d4768307	152	}
MasaoHamanaka	0:a3a1d4768307	153
MasaoHamanaka	0:a3a1d4768307	154	tone = (0 == note->tone) ? (1): (note->tone);
MasaoHamanaka	0:a3a1d4768307	155	sfs = (0 == note->sfs ) ? (1): (note->sfs);
MasaoHamanaka	0:a3a1d4768307	156	loud = note->loud;
MasaoHamanaka	0:a3a1d4768307	157	att = note->attenuation;
MasaoHamanaka	0:a3a1d4768307	158
MasaoHamanaka	0:a3a1d4768307	159	/* ==== Set frequency registers ==== */
MasaoHamanaka	0:a3a1d4768307	160	/* start sgd */
MasaoHamanaka	0:a3a1d4768307	161	REGW8(stSDG[channel], SGCR1, SGST, 1); /* start sgd */
MasaoHamanaka	0:a3a1d4768307	162	REGW8(stSDG[channel], SGCR2, SGEND, 0); /* stop bit : continue */
MasaoHamanaka	0:a3a1d4768307	163	/* enable SGTFR / SGSFR register to write */
MasaoHamanaka	0:a3a1d4768307	164	REGW8(stSDG[channel], SGCR2, TCHG, 1); /* change : enable */
MasaoHamanaka	0:a3a1d4768307	165	/* set each parameter */
MasaoHamanaka	0:a3a1d4768307	166	REGW8(stSDG[channel], SGTFR, TONE, tone); /* tone */
MasaoHamanaka	0:a3a1d4768307	167	REGW8(stSDG[channel], SGSFR, SFS, sfs); /* sfs */
MasaoHamanaka	0:a3a1d4768307	168	REGW8(stSDG[channel], SGLR, LD, loud); /* loud */
MasaoHamanaka	0:a3a1d4768307	169	REGW8(stSDG[channel], SGCR1, DPF, att); /* attenuation */
MasaoHamanaka	0:a3a1d4768307	170	if (note->attenuation != 0) {
MasaoHamanaka	0:a3a1d4768307	171	REGW8(stSDG[channel], SGCR1, SGST, 0); /* stop sgd */
MasaoHamanaka	0:a3a1d4768307	172	}
MasaoHamanaka	0:a3a1d4768307	173
MasaoHamanaka	0:a3a1d4768307	174	return ret;
MasaoHamanaka	0:a3a1d4768307	175	}
MasaoHamanaka	0:a3a1d4768307	176
MasaoHamanaka	0:a3a1d4768307	177	/* End of File */

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	07 Apr 2015
Imports:	5
Forks:	0
Commits:	2
Dependents:	0
Dependencies:	0
Followers:	57

Information

Sound Generator

What is this?

API

Driver Wrapper API

void piano4int_start( const int8_t *scores[SDG_CH_TOTAL], PIANO4INT_CB callback )

void piano4int_stop( bool force )

bool piano4int_status( void )

typedef void (*PIANO4INT_CB)( uint32_t channel, uint32_t value )

Driver API

int32_t R_SDG_Open( uint32_t channel, R_SDG_CLOCK clock )

int32_t R_SDG_Close( uint32_t channel )

int32_t R_SDG_Tone( uint32_t channel, NOTE *note )

User Definition Functions

int32_t Userdef_SDG0_Open( void )

int32_t Userdef_SDG1_Open( void )

int32_t Userdef_SDG2_Open( void )

int32_t Userdef_SDG3_Open( void )

int32_t Userdef_SDG0_Close( void )

int32_t Userdef_SDG1_Close( void )

int32_t Userdef_SDG2_Close( void )

int32_t Userdef_SDG3_Close( void )

structures

enumerate

サウンドジェネレータ

概要

API

Driver Wrapper API

void piano4int_start( const int8_t *scores[SDG_CH_TOTAL], PIANO4INT_CB callback )

void piano4int_stop( bool force )

bool piano4int_status( void )

typedef void (*PIANO4INT_CB)( uint32_t channel, uint32_t value )

Driver API

int32_t R_SDG_Open( uint32_t channel, R_SDG_CLOCK clock )

int32_t R_SDG_Close( uint32_t channel )

int32_t R_SDG_Tone( uint32_t channel, NOTE *note )

ユーザ定義関数

int32_t Userdef_SDG0_Open( void )

int32_t Userdef_SDG1_Open( void )

int32_t Userdef_SDG2_Open( void )

int32_t Userdef_SDG3_Open( void )

int32_t Userdef_SDG0_Close( void )

int32_t Userdef_SDG1_Close( void )

int32_t Userdef_SDG2_Close( void )

int32_t Userdef_SDG3_Close( void )

構造体

列挙型

sdg_driver/sdg.c@1:cd3d332d4499, 2017-04-24 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning