Atmel Tiny88 - software I2C master

-

 Software I2C (master)

Microchip Tiny-88 只有一組 TWI master/slave 功能，在系統設計中，Tiny-88 一般做為電源管理，系統開關機，還有和系統主晶片組溝通。Tiny-88 和主晶片組溝通的介面會採用 TWI slave，當還需要再讀取系統溫度，系統電流，系統生產資料或者系統電池時，還需要一組 I2C master 去讀取系統的資料，只能使用 GPIO 來模擬 software I2C. 　 


Software I2C header

宣告程式碼中，需要用到的變數和子函式，使用宣告的好處是日後若要更換成其他組的 GPIO 容易更換，也不容易有遺漏。
  • 宣告 GPIO PORT 和接腳位置去模擬 software I2C
  • 宣告 I2C 寛度的時間設定值
  • 宣告 GPIO High / Low / Input 子函式
/* Constant Variable Define */
#define SW_I2C_DDR			DDRD
#define SW_I2C_DIN			PIND
#define SW_I2C_DOUT			PORTD

#define SW_I2C_SDA			6
#define SW_I2C_SCL			7

/** Bit to or with address for read start and read restart */
#define I2C_READ			1

/** Bit to or with address for write start and write restart */
#define I2C_WRITE			0

/** Delay used for software I2C */
#define I2C_DELAY_USEC		10
#define I2C_DELAY_CLKH		6	/* I2C Clock High Width         */
/* I2C Clock Low Width (by instruction run time)        */
#define I2C_DELAY_CLKL		0
/* I2C Clock Low Width for finial bit   */
#define I2C_DELAY_CLKFL		4
#define I2C_DELAY_DATBR		3	/* I2C Data Delay to before read */
#define I2C_DELAY_DATAR		2	/* I2C Data Delay to after read */

/* Declare Function */
#define SET_I2C_SCL_HI()	(SW_I2C_DOUT |= (1 &lt< SW_I2C_SCL))
#define SET_I2C_SCL_LO()	(SW_I2C_DOUT &= ~(1 &lt< SW_I2C_SCL))
#define SET_I2C_SDA_HI()	(SW_I2C_DOUT |= (1 &lt< SW_I2C_SDA))
#define SET_I2C_SDA_LO()	(SW_I2C_DOUT &= ~(1 &lt< SW_I2C_SDA))
#define SET_I2C_SDA_OUT()	(SW_I2C_DDR |= (1 &lt< SW_I2C_SDA))
#define SET_I2C_SDA_IN()	(SW_I2C_DDR &= ~(1 &lt< SW_I2C_SDA))
#define GET_I2C_SDA_IN()	(SW_I2C_DIN & (1 &lt< SW_I2C_SDA))

Software I2C code
I2C protocol 分為 start-bit，stop-bit，repeat start-bit，I2C-read，I2C-write 的子函式來組合成主函式。因此，在編寫程式碼前，建議先使用流程圖規劃一下，再開始編寫程式碼，先完成子函式，再組成主函式。
  • SW_I2C_start(address)： 
子函式主要是用在一開始傳送 start-bit 和 slave address，也用於 read protocol 時的 repeat start-bit 只是傳遞的 8-bit 位址的 bit 0 要改為 read．
/* ! \brief  SW I2C issue a start condition
 *		This function use to send start condition of SW I2C
 * \note
 *		(input) slave device address
 * \return
 *		1 : the address has ACK
 *		0 : the address without ACK
 */
uint8_t SW_I2C_start(uint8_t addressRW)
{
	uint8_t result;

	SET_I2C_SDA_LO();	/* set data to low */
	_delay_us(I2C_DELAY_USEC);
	SET_I2C_SCL_LO();	/* set clock to low */
	_delay_us(I2C_DELAY_CLKFL);
	result = SW_I2C_write(addressRW);
	return result;
}
  • SW_I2C_restart(address) ： 
子函式用於 read protocol 的 repeat start bit ，需記得更改 slave address 為 read。  
/* ! \brief  SW I2C issue a re-start condition
 *		This function use to send re-start condition of SW I2C
 * \note
 *		(input) slave device address
 * \return
 *		1 : the address has ACK
 *		0 : the address without ACK
 */
uint8_t SW_I2C_restart(uint8_t addressRW)
{
	SET_I2C_SDA_HI();
	SET_I2C_SCL_HI();
	_delay_us(I2C_DELAY_USEC);
	return SW_I2C_start(addressRW);
}
  • SW_I2C_stop(void)： 
子函式 stop-bit 結束 I2C packet
/* ! \brief  SW I2C issue a stop condition
 *		This function use to send stop condition of SW I2C
 * \note
 *		(input) slave device address
 * \return
 *		1 : the address has ACK
 *		0 : the address without ACK
 */
void SW_I2C_stop(void)
{
	SET_I2C_SDA_LO();	/* set data to low */
	_delay_us(I2C_DELAY_USEC);
	SET_I2C_SCL_HI();
	_delay_us(I2C_DELAY_USEC);
	SET_I2C_SDA_HI();
	_delay_us(I2C_DELAY_USEC);
}
  • SW_I2C_read(last)： 
子函式讀取一個 byte 和回應 ack /nack 給 host
/* ! \brief  SW_I2C_read
 *		This function use to read a byte and send ack/nack to device
 * \note
 *		decide the terminate bit is ACK or NACK.
 * \return
 *		data byte of I2C read
 */
uint8_t SW_I2C_read(uint8_t last)
{
	uint8_t b = 0;
	/* make sure pull-up enabled  */
	SET_I2C_SDA_HI();
	SET_I2C_SDA_IN();	/* change to input mode */
	/* read byte */
	for (uint8_t i = 0; i < 8; i++) {
		/* do not change this loop unless you verify the change with a
		 * scope   */
		_delay_us(I2C_DELAY_CLKFL);
		b &lt<= 1;
		SET_I2C_SCL_HI();	/* set clock to high */
		_delay_us(I2C_DELAY_DATBR);
		if (GET_I2C_SDA_IN())
			b |= 1;	/* read bit data */
		_delay_us(I2C_DELAY_DATAR);
		SET_I2C_SCL_LO();	/* set clock to low */
	}
	/* send Ack or Nak */
	SET_I2C_SDA_OUT();
	if (last)
		SET_I2C_SDA_HI();
	else
		SET_I2C_SDA_LO();

	SET_I2C_SCL_HI();	/* set clock to high */
	_delay_us(I2C_DELAY_CLKH);
	SET_I2C_SCL_LO();	/* set clock to low */
	SET_I2C_SDA_LO();

	return b;
}
  • SW_I2C_write(data)： 
子函式寫入一個 byte 並讀回 slave 的 ack/nack 
/* ! \brief  SW_I2C_write
 *		This function use to write a byte to device
 * \note
 *		(input) data byte
 * \return
 *		1 : slave return ACK
 *		0 : slave return NACK
 */
uint8_t SW_I2C_write(uint8_t data)
{
	uint8_t rtn;

	/* write byte */
	for (uint8_t m = 0x80; m != 0; m >>= 1) {
		/* don't change this loop unless you verify the change with a
		 * scope */
		if (m & data)
			SET_I2C_SDA_HI();
		else
			SET_I2C_SDA_LO();

		SET_I2C_SCL_HI();	/* set clock to high */
		_delay_us(I2C_DELAY_CLKH);
		SET_I2C_SCL_LO();	/* set clock to low */
		_delay_us(I2C_DELAY_CLKL);
	}
	_delay_us(I2C_DELAY_CLKFL);
	SET_I2C_SCL_HI();
	_delay_us(I2C_DELAY_DATBR);
	/* get Ack or Nak */
	SET_I2C_SDA_IN();	/* change to input mode */
	rtn = GET_I2C_SDA_IN();
	_delay_us(I2C_DELAY_DATAR);
	SET_I2C_SCL_LO();	/* set clock to low */
	_delay_us(I2C_DELAY_CLKFL);
	SET_I2C_SDA_OUT();
	SET_I2C_SDA_LO();	/* set data to low */
	return rtn == 0;
}
  • SW_I2C_buffer_read：
主函式完成 I2C read byte 功能，包含 start-bit，I2C-slave address，I2C-command，repeat start-bit，address，I2C-data buffer，stop-bit 完整的 I2C read protocol． 
/* ! \brief  SW I2C read protocol
 *		This function use to SW I2C read protocol
 * \note
 *		(input) address-slave device address
 *		(input) cmd-read command
 *		(input) buf-read protocol buffer
 *		(input) count-read protocol byte count
 * \return
 *		1 : success of read protocol
 *		0 : fail of read protocol
 */
uint8_t SW_I2C_buffer_read(uint8_t address, uint8_t cmd, uint8_t *buf,
			   uint8_t count)
{
	cli();
	/* issue a start condition, send device address and write direction
	 * bit */
	if (!SW_I2C_start(address | I2C_WRITE)) {
		SW_I2C_stop();
		sei();
		return FALSE;
	}
	/* send the DS1307 address */
	if (!SW_I2C_write(cmd)) {
		SW_I2C_stop();
		sei();
		return FALSE;
	}
	/* issue a repeated start condition, send device address and read
	 * direction bit */
	if (!SW_I2C_restart(address | I2C_READ)) {
		SW_I2C_stop();
		sei();
		return FALSE;
	}
	/* read data from the DS1307 */
	for (uint8_t i = 0; i < count; i++) {
		/* send Ack until last byte then send Ack */
		buf[i] = SW_I2C_read(i == (count - 1));
	}

	/* issue a stop condition */
	SW_I2C_stop();
	sei();
	return TRUE;
}
  • SW_I2C_buffer_write：
主函式完成 I2C read write 功能，包含 start-bit，I2C-slave address，I2C-command，I2C-data buffer，stop-bit 完整的 I2C write protocol．
/* ! \brief  SW I2C write protocol
 *		This function use to SW I2C write protocol
 * \note
 *		(input) address-slave device address
 *		(input) cmd-write command
 *		(input) buf-write protocol buffer
 *		(input) count-write protocol byte count
 * \return
 *		1 : success of write protocol
 *		0 : fail of write protocol
 */
uint8_t SW_I2C_buffer_write(uint8_t address, uint8_t cmd, uint8_t *buf,
			    uint8_t count)
{
	cli();
	/* issue a start condition, send device address and write direction
	 * bit */
	if (!SW_I2C_start(address | I2C_WRITE)) {
		SW_I2C_stop();
		sei();
		return FALSE;
	}
	/* send the DS1307 address */
	if (!SW_I2C_write(cmd)) {
		SW_I2C_stop();
		sei();
		return FALSE;
	}
	/* send data to the DS1307 */
	for (uint8_t i = 0; i < count; i++) {
		if (!SW_I2C_write(buf[i])) {
			SW_I2C_stop();
			sei();
			return FALSE;
		}
	}

	/* issue a stop condition */
	SW_I2C_stop();
	sei();
	return TRUE;
}

留言

張貼留言

這個網誌中的熱門文章

EC 所需知識 - SMBUS

-
圖片
EC 所需知識 軟體工程師的第一步，先把相關的規範(Specification)了解清楚，就像開發一套軟體之前要先了解需求，才能做出一套符合需求的體。相同的EC工程師就是需要把 LPC / SMBUS / PS2 / Smart Battery 的相關知識，清楚明瞭再進下一步。 SMBUS SMBus [System Management Bus] 是由Intel所制訂的，主要由兩條線組成，其一為CLOCK線，另一條為DATA線。其作用是讓系統監控者透過SMBus來蒐集系統上裝置的資訊如電池的容量、CPU的溫度等，讓系統監控者可以依照所得的資訊通知作業系統做電源管理的處理。在筆記型電腦系統中的ACPI-EC為SMBus的主控者 [Host] 來蒐集SMBus上的裝置資訊回報給作業系統，讓作業系統依使用者的設定做系統電源的管理。 SMBus相關的規格包含SMBus、Smart Selector、Smart Charger及Smart Battery都是ACPI-EC工程師需要瞭解的規格，以下的章節將會詳盡的介紹各個規格的資訊。 SMBUS Specification Hardware Define SMBUS 的硬體線路 –SMBUS由二條線所組成，所有的SMBUS的裝置都並聯在SMBUS上，因此，SMBUS上的所有裝置都需要使用Open collection 或者 Open drain才允許跨接在SMBUS上面，因此線路上必須加上提升電阻來確認SMBUS上的訊號可以正確無誤的傳遞。 如同上圖，有時侯  SMBUS  上會有不同 VDD 的裝置，所以一般在輸入接腳會加稽納二極體保護裝置。不過大部分的作法，會使用電壓緩衝IC來處理不同電壓的 I2C 裝置。  SMBUS電氣上的要求 名稱 說明 值域 單位 下限 上限 VIL 輸入低電位 0.8 V VIH 輸入高電位 2.1 VDD V VOL 輸出為低電位 0.4 V IPULLUP 提升電流值 100 350 uA VDD 工作電壓 2.7 5.5 V SMBUS的時脈要求 名稱 說明 值域 單位
閱讀完整內容

EC 所需知識 - KBC

-
EC 所需知識 軟體工程師的第一步，先把相關的規範(Specification)了解清楚，就像開發一套軟體之前要先了解需求，才能做出一套符合需求的體。相同的EC工程師就是需要把 LPC / SMBUS / PS2 / KBC 等相關知識，清楚明瞭再進下一步。 Keyboard Controller 最早的鍵盤控制器是Intel 8042，主要包含四個暫存器和三個I/O控制埠，四個暫存器分別為一個BYTE的輸入緩衝暫存器、一個BYTE的輸出緩衝器、一個狀態暫存器及一個控制暫存器。 三個I/O控制埠的定義如下表： PORT #1 Port 1 [ Input Port ] Pin Name Function 0 P10 Keyboard Data [PS/2] 1 P11 Mouse Data [PS/2] 2 P12 3 P13 4 P14 External ROM 1:Enable  0:Disable 5 P15 Manufacturing Setting 1:Enable 0:Disable 6 P16 Display Type Switch 1:Color 0:Monochrome 7 P17 Keyboard Inhibit Switch 1:Enable 0:Disable PORT #2 Port 2 [ Output Port ] Pin Name Function 0 P20 System Reset 1:Nornal 0:Reset  1 P21 Gate A20 2 P22 Mouse Data [PS/2] 1:Pull Data low 0:High –Z 3 P23 Mouse Clock [PS/2] 1:Pull Data low 0:High –Z 4 P24 Input Buffer Full / Keyboard IBF interrupt [PS/2] 1:Assert IRQ 1 0:De-assert IRQ1 5 P25 Output Buffer Empty / Mouse IBF interrupt [PS/2] 1:Assert IRQ 12 0:De-assert IRQ12 6 P26 Keyboard Clock 1:Pull Clock low 0:High Z 7 P27 Keyboar
閱讀完整內容

EC 所需知識 - LPC

-
圖片
EC 所需知識 軟體工程師的第一步，先把相關的規範(Specification)了解清楚，就像開發一套軟體之前要先了解需求，才能做出一套符合需求的體。相同的EC工程師就是需要把 LPC / SMBUS / PS2 / Smart Battery 的相關知識，清楚明瞭再進下一步。 LPC Specification 本章節介紹以LPC Interface為主，讓讀者可以從中瞭解LPC Interface 的動作原理及腳位作用。當LPC Interface發生問題時，才能籍著對LPC Interface的瞭解來可以找到問題的解決方法。 LPC的特性 相容於舊系統的 X-BUS 介面 可以定址到 4GB，並且BIOS不受1MB的限制，記憶裝置也不受16MB的限制。 在作業系統上不需要特別安裝驅動程式即可正確運作。 在I/O或MEMORY指令會花費較長的時間，可以要考LPC加入等待狀態 LPC支援的裝置 SUPER I/O – 軟碟控制介面、IR、KBC Audio – AC97 記憶裝置 – BIOS Flash 系統管理控制器 [System Manager Controller ] LPC的方塊圖 系統的指令由CPU傳給HOST-Bridge [ 北橋晶片 ] 經 PCI Bus 傳給 PCI-Bridge [ 南橋晶片 ] 也是上圖的HOST，HOST再將PCI的指令指轉為LPC的指令傳到LPC的裝置，完成指令的傳遞。 LPC的硬體腳位 Signal Direction Description Peripheral Host LAD[3:0] I/O I/O 多功能腳位。可為指令、位址及資料 LFRAME# I O 表示LPC指令的開始傳遞及結束 LRESET# I I PCI介面的RESET信號 LCLK I I LPC介面的信號來源 [ 33MHz ] LDRQ# O I 支援DMA及要取得PCI Bus的控制權才會使用 SERIRQ I/O I/O LPC裝置的中斷信號，假如使用IRQ12的裝置要發出中斷信號在第12的CLCOK時，拉LOW即為IRQ12 CLKRUN# OD I/O
閱讀完整內容