3  * SPI NOR Software Write Protection logic.
9 #include <linux/mtd/spi-nor.h>
13 static u8 spi_nor_get_sr_bp_mask(struct spi_nor *nor)  in spi_nor_get_sr_bp_mask()  argument
17 	if (nor->flags & SNOR_F_HAS_SR_BP3_BIT6)  in spi_nor_get_sr_bp_mask()
20 	if (nor->flags & SNOR_F_HAS_4BIT_BP)  in spi_nor_get_sr_bp_mask()
26 static u8 spi_nor_get_sr_tb_mask(struct spi_nor *nor)  in spi_nor_get_sr_tb_mask()  argument
28 	if (nor->flags & SNOR_F_HAS_SR_TB_BIT6)  in spi_nor_get_sr_tb_mask()
34 static u64 spi_nor_get_min_prot_length_sr(struct spi_nor *nor)  in spi_nor_get_min_prot_length_sr()  argument
37 	u8 mask = spi_nor_get_sr_bp_mask(nor);  in spi_nor_get_min_prot_length_sr()
41 	bp_slots_needed = ilog2(nor->info->n_sectors);  in spi_nor_get_min_prot_length_sr()
44 		return nor->info->sector_size <<  in spi_nor_get_min_prot_length_sr()
47 		return nor->info->sector_size;  in spi_nor_get_min_prot_length_sr()
50 static void spi_nor_get_locked_range_sr(struct spi_nor *nor, u8 sr, loff_t *ofs,  in spi_nor_get_locked_range_sr()  argument
53 	struct mtd_info *mtd = &nor->mtd;  in spi_nor_get_locked_range_sr()
55 	u8 mask = spi_nor_get_sr_bp_mask(nor);  in spi_nor_get_locked_range_sr()
56 	u8 tb_mask = spi_nor_get_sr_tb_mask(nor);  in spi_nor_get_locked_range_sr()
59 	if (nor->flags & SNOR_F_HAS_SR_BP3_BIT6 && val & SR_BP3_BIT6)  in spi_nor_get_locked_range_sr()
71 	min_prot_len = spi_nor_get_min_prot_length_sr(nor);  in spi_nor_get_locked_range_sr()
77 	if (nor->flags & SNOR_F_HAS_SR_TB && sr & tb_mask)  in spi_nor_get_locked_range_sr()
87 static bool spi_nor_check_lock_status_sr(struct spi_nor *nor, loff_t ofs,  in spi_nor_check_lock_status_sr()  argument
96 	spi_nor_get_locked_range_sr(nor, sr, &lock_offs, &lock_len);  in spi_nor_check_lock_status_sr()
109 static bool spi_nor_is_locked_sr(struct spi_nor *nor, loff_t ofs, uint64_t len,  in spi_nor_is_locked_sr()  argument
112 	return spi_nor_check_lock_status_sr(nor, ofs, len, sr, true);  in spi_nor_is_locked_sr()
115 static bool spi_nor_is_unlocked_sr(struct spi_nor *nor, loff_t ofs,  in spi_nor_is_unlocked_sr()  argument
118 	return spi_nor_check_lock_status_sr(nor, ofs, len, sr, false);  in spi_nor_is_unlocked_sr()
154 static int spi_nor_sr_lock(struct spi_nor *nor, loff_t ofs, uint64_t len)  in spi_nor_sr_lock()  argument
156 	struct mtd_info *mtd = &nor->mtd;  in spi_nor_sr_lock()
159 	u8 mask = spi_nor_get_sr_bp_mask(nor);  in spi_nor_sr_lock()
160 	u8 tb_mask = spi_nor_get_sr_tb_mask(nor);  in spi_nor_sr_lock()
163 	bool can_be_top = true, can_be_bottom = nor->flags & SNOR_F_HAS_SR_TB;  in spi_nor_sr_lock()
166 	ret = spi_nor_read_sr(nor, nor->bouncebuf);  in spi_nor_sr_lock()
170 	status_old = nor->bouncebuf[0];  in spi_nor_sr_lock()
173 	if (spi_nor_is_locked_sr(nor, ofs, len, status_old))  in spi_nor_sr_lock()
177 	if (!spi_nor_is_locked_sr(nor, 0, ofs, status_old))  in spi_nor_sr_lock()
181 	if (!spi_nor_is_locked_sr(nor, ofs + len, mtd->size - (ofs + len),  in spi_nor_sr_lock()
200 		min_prot_len = spi_nor_get_min_prot_length_sr(nor);  in spi_nor_sr_lock()
204 		if (nor->flags & SNOR_F_HAS_SR_BP3_BIT6 && val & SR_BP3)  in spi_nor_sr_lock()
231 	return spi_nor_write_sr_and_check(nor, status_new);  in spi_nor_sr_lock()
239 static int spi_nor_sr_unlock(struct spi_nor *nor, loff_t ofs, uint64_t len)  in spi_nor_sr_unlock()  argument
241 	struct mtd_info *mtd = &nor->mtd;  in spi_nor_sr_unlock()
244 	u8 mask = spi_nor_get_sr_bp_mask(nor);  in spi_nor_sr_unlock()
245 	u8 tb_mask = spi_nor_get_sr_tb_mask(nor);  in spi_nor_sr_unlock()
248 	bool can_be_top = true, can_be_bottom = nor->flags & SNOR_F_HAS_SR_TB;  in spi_nor_sr_unlock()
251 	ret = spi_nor_read_sr(nor, nor->bouncebuf);  in spi_nor_sr_unlock()
255 	status_old = nor->bouncebuf[0];  in spi_nor_sr_unlock()
258 	if (spi_nor_is_unlocked_sr(nor, ofs, len, status_old))  in spi_nor_sr_unlock()
262 	if (!spi_nor_is_unlocked_sr(nor, 0, ofs, status_old))  in spi_nor_sr_unlock()
266 	if (!spi_nor_is_unlocked_sr(nor, ofs + len, mtd->size - (ofs + len),  in spi_nor_sr_unlock()
285 		min_prot_len = spi_nor_get_min_prot_length_sr(nor);  in spi_nor_sr_unlock()
289 		if (nor->flags & SNOR_F_HAS_SR_BP3_BIT6 && val & SR_BP3)  in spi_nor_sr_unlock()
314 	return spi_nor_write_sr_and_check(nor, status_new);  in spi_nor_sr_unlock()
324 static int spi_nor_sr_is_locked(struct spi_nor *nor, loff_t ofs, uint64_t len)  in spi_nor_sr_is_locked()  argument
328 	ret = spi_nor_read_sr(nor, nor->bouncebuf);  in spi_nor_sr_is_locked()
332 	return spi_nor_is_locked_sr(nor, ofs, len, nor->bouncebuf[0]);  in spi_nor_sr_is_locked()
341 void spi_nor_init_default_locking_ops(struct spi_nor *nor)  in spi_nor_init_default_locking_ops()  argument
343 	nor->params->locking_ops = &spi_nor_sr_locking_ops;  in spi_nor_init_default_locking_ops()
348 	struct spi_nor *nor = mtd_to_spi_nor(mtd);  in spi_nor_lock()  local
351 	ret = spi_nor_lock_and_prep(nor);  in spi_nor_lock()
355 	ret = nor->params->locking_ops->lock(nor, ofs, len);  in spi_nor_lock()
357 	spi_nor_unlock_and_unprep(nor);  in spi_nor_lock()
363 	struct spi_nor *nor = mtd_to_spi_nor(mtd);  in spi_nor_unlock()  local
366 	ret = spi_nor_lock_and_prep(nor);  in spi_nor_unlock()
370 	ret = nor->params->locking_ops->unlock(nor, ofs, len);  in spi_nor_unlock()
372 	spi_nor_unlock_and_unprep(nor);  in spi_nor_unlock()
378 	struct spi_nor *nor = mtd_to_spi_nor(mtd);  in spi_nor_is_locked()  local
381 	ret = spi_nor_lock_and_prep(nor);  in spi_nor_is_locked()
385 	ret = nor->params->locking_ops->is_locked(nor, ofs, len);  in spi_nor_is_locked()
387 	spi_nor_unlock_and_unprep(nor);  in spi_nor_is_locked()
393  * @nor:	pointer to a 'struct spi_nor'.
395  * Some SPI NOR flashes are write protected by default after a power-on reset
403 void spi_nor_try_unlock_all(struct spi_nor *nor)  in spi_nor_try_unlock_all()  argument
407 	if (!(nor->flags & SNOR_F_HAS_LOCK))  in spi_nor_try_unlock_all()
410 	dev_dbg(nor->dev, "Unprotecting entire flash array\n");  in spi_nor_try_unlock_all()
412 	ret = spi_nor_unlock(&nor->mtd, 0, nor->params->size);  in spi_nor_try_unlock_all()
414 		dev_dbg(nor->dev, "Failed to unlock the entire flash memory array\n");  in spi_nor_try_unlock_all()
417 void spi_nor_set_mtd_locking_ops(struct spi_nor *nor)  in spi_nor_set_mtd_locking_ops()  argument
419 	struct mtd_info *mtd = &nor->mtd;  in spi_nor_set_mtd_locking_ops()
421 	if (!nor->params->locking_ops)  in spi_nor_set_mtd_locking_ops()